LogoLogo
Visit Contextual.ioSign Up
  • Getting Started
    • Welcome
    • Tour: Hello, AI World!
  • TRAINING
    • Basic Developer Training Course
      • Lesson 1: HTTP Agent Introduction
      • Lesson 2: Logging and Error Handling Basics
      • Lesson 3: Event Processing Agent Introduction
  • Services Catalog
    • What's in the Catalog?
      • Intro Patterns
      • Object Type Bundles
    • Browse by Platform
    • All Intro Patterns
      • Anthropic Claude Image Analysis
      • Mistral AI Prompt and Response
      • xAI Grok Prompt and Response
      • DeepSeek Chat Prompt and Response
      • Qwen Chat Prompt and Response
      • Perplexity AI Search and Response
      • Firecrawl Website Scraper
      • Groq Prompt and Response
      • Nyckel Dog Breed Classification
      • RapidAPI ClassifyAI Text Classification
      • RapidAPI YouTube AI Video Summary
      • UnifyAI Model Comparison
      • WebPilot URL Analysis and Summarization
      • OpenAI Assistants Prompt and Response
      • OpenAI Sync
    • All Prebuilt Solutions
      • Invoice AI
      • Lead Generation Form
    • All Object Type Bundles
      • Work Order Management System ITIL Object Type Bundle
        • Work Order
        • User
        • Role
        • Permission
        • Asset
        • Task
        • Action
        • Attachment
        • Comment
        • Notification
        • Audit Log
        • Service Level Agreement
        • Custom Fields
        • Work Order Template
        • Work Order Transition
        • Escalation Policy
        • Tag
  • Components & Data
    • Object Types
      • Data in Contextual
        • Secrets
        • Validation
        • Versioning
      • Examples
      • Creating an Object Type
      • Object Type Details
        • Definition
        • Data Schema
          • Automatic Record Metadata
          • Generated Values
            • Dates and Times
            • UUIDs
          • Frequently Used Validation
          • Disallowing Null Property Values
          • Disallowing Undefined Properties
          • Secrets
          • AI Assistant
          • ID and PrimaryKey Permanence
        • UI Schemas
        • Features
        • Triggers
        • Actions
        • Audit Trail
        • Versions
        • Templates
        • Records
      • Using Object Types in Flows
      • Records
        • Records and Your Tenant API
        • Record Import
    • Flows
      • Nodes
      • Wires
      • Message Object
      • Flow Editor
        • Basics
        • Saving Changes
        • In-Flow Testing with Debugger
        • Restart Agents to Make Changes Active
        • Config
      • Node Reference
        • Common
          • Log Tap
          • Inject
          • Debug
          • Complete
          • Catch
          • Status
          • Link In
          • Link Call
          • Link Out
          • Comment
        • Event
          • Prepare Event
          • Event Start
          • Event End
          • Event Error
        • Object
          • Search Object
          • Get Object
          • Create Object
          • Patch Object
          • Put Object
          • Delete Object
          • Run Action
        • Request
          • Send to Agent
          • HTTP GET
          • HTTP PATCH
          • HTTP PUT
          • HTTP DELETE
          • HTTP POST
          • GQL
          • Produce Message
        • Function
          • Function
          • Switch
          • Change
          • Range
          • Template
          • Delay
          • Trigger
          • Exec
          • Filter
          • Loop
        • Models
          • ML Predict
        • Network
          • MQTT In
          • MQTT Out
          • HTTP In
          • HTTP Response
          • HTTP Request
          • WebSocket In
          • WebSocket Out
          • TCP In
          • TCP Out
          • TCP Request
          • UDP In
          • UDP Out
        • Sequence
          • Split
          • Join
          • Sort
          • Batch
        • Parser
          • csv
          • html
          • json
          • xml
          • yaml
    • Agents
      • Creating an Agent
      • Types of Agents
        • Event to Flow
        • HTTP to Flow
          • Custom Domains
      • How Agents Work
        • Flow Execution
        • HTTP Load Balancing
        • Event Routing
      • Scale and Performance
        • Flow execution
        • Parallel Instances
        • Event Lag Scaling
        • Compute Threshold Scaling
        • Instance Compute Sizing
      • Agent Details
        • Definition
        • Operations
        • Logs
          • Session Log
          • Message Log
        • Audit Trail
        • Versions
      • Using Agents in Flows
    • Connections
      • Creating a Connection
      • Types of Connections
        • Basic
        • Bearer
        • Client Grant
        • Kafka
        • Password Grant
        • Public
        • Pulsar
      • Using Connections in Flows
    • JWKS Profiles
      • Using JWKS Profiles in Your Solution
  • PATTERNS
    • Solution Architecture
      • Events, Messages, Queues
    • Working with Data
      • Search Object Node & Pagination
      • Message Payload Content - Triggers and Actions
    • Industry Cookbooks
      • Field Services
  • Tenants
    • Tenant Workspace
    • Tenant Logs
      • Contextual Log Query Language (CLQL)
        • String Searches
        • Keyword Searches
        • Advanced Operators
    • Tenant API
      • API Keys
        • API Key Settings
        • API Key Permissions
      • Documentation
  • Release Notes
    • 2024
      • 2024.12.09
Powered by GitBook
On this page
  • What's in an Object Type Bundle?
  • Best Practices for Working with Data in Contextual.io

Was this helpful?

  1. Services Catalog
  2. What's in the Catalog?

Object Type Bundles

Object Types in Contextual.io provide a powerful way to manage and organize data within your projects. Object Type bundles in the Service Catalog range from small collections of essential Object Types to comprehensive collections designed for complex scenarios and solution development.

Each Object Type Bundle is carefully curated to offer cohesive, well-defined data models that integrate seamlessly with the Contextual.io platform. Whether you're building a simple workflow or a sophisticated IT service management system, Object Type Bundles give you a strong foundation to work from.

What's in an Object Type Bundle?

Object Types, of course! Each Object Type Bundle will contain 2 or more Object Types that will be immediately installed and available for use in your Contextual tenant, including:

  • Names: Descriptive names that clearly indicate the purpose of each Object Type, making it easy to understand their role within the broader data model.

  • IDs: Unique identifiers that allow for consistent referencing of Object Types across Flows, Schemas, and other Contextual components and functionality.

  • Descriptions: Detailed descriptions that explain what each Object Type represents and how it should be used, providing essential context for developers and users alike.

  • JSON Data Schemas: The core of each Object Type, defining the structure of the data, including fields, data types, validation rules, and relationships. These schemas are optimized for flexibility and performance, making the most of Contextual.io's capabilities.

  • UI Schemas: User Interface Schemas provide intuitive views for creating, updating, reading, and listing records in the Contextual Dashboard, ensuring a smooth user experience when interacting with data through the Contextual.io platform.

Best Practices for Working with Data in Contextual.io

Contextual.io offers a variety of powerful features and best practices for managing and interacting with data. Using Object Type bundles is a great way to see fully-formed data modeling in practice in the Contextual platform.

Structure & Validation

  • Self-Describing Data Schemas: Schemas are self-describing, making them easy to understand and use.

  • JSON Data Schema Rules: Robust rule enforcement, including nested data structures and property-level validation.

  • Conditional Validation Logic: Enables advanced validation scenarios, ensuring data integrity.

  • Property Relationships: Support for defining relationships between properties within and across Object Types.

Metadata

  • Auto-Generated Metadata: Includes versioning, timestamps, record hashes, and more, providing a rich context for each record.

  • Integrated AI: Leverage AI for schema authoring and other tasks.

Actions & Triggers

  • Action Execution: Supports multiple actions by data type, manual or API-based execution, and guaranteed message-based execution.

  • Triggers: Set up triggers for post-insert, post-update, post-delete, and more, with detailed control over execution.

Workflow Integration & Audit Trail

  • Embedded in Workflow Editor: Object Types can be fully integrated into workflows, enabling seamless data management.

  • Audit Trail: Comprehensive tracking of operations, actions, and triggers, ensuring accountability and traceability.

Versions & Consistency

  • Schema Versioning: Supports versioning and rollback for data definitions and records, ensuring consistency over time.

  • Auto-Generated Record Hash: Ensures data integrity with hash checks.

User Interface & Permissions

  • Role & Permission-Controlled UX: Customizable web interfaces based on user roles and permissions.

  • Pre-Submit Validation: The Contextual Dashboard interface helps to ensure data integrity before submission with pre-submit form validation.

Generative Properties & API Integration

  • Generative Properties: Auto-generate properties like UUIDs and timestamps, streamlining data creation.

  • Auto-Generated API: Fully secured, fully permission-managed Tenant API with auto-generated documentation and advanced querying capabilities.

PreviousIntro PatternsNextBrowse by Platform

Last updated 8 months ago

Was this helpful?