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 are Flows?
  • Key Components
  • Creating and Managing Flows
  • Conclusion

Was this helpful?

  1. Components & Data

Flows

PreviousRecord ImportNextNodes

Last updated 10 months ago

Was this helpful?

What are Flows?

Flows in Contextual are sequences of , connected together to perform a task or set of tasks. Each flow represents a series of steps that a goes through, starting from an input, passing through various processing nodes, and ending at an output.

Key Components

Nodes

  • Input Nodes: These nodes receive data from outside of the flow.

    • Event Start - a custom Contextual node that allows ingress of data that is sent to the flow by one or more

    • HTTP In - allows ingress of data that is sent to the flow by one or more

    • MQTT - The MQTT node is used for integrating with MQTT (Message Queuing Telemetry Transport) brokers. MQTT is a lightweight messaging protocol often used for IoT (Internet of Things) applications due to its low bandwidth requirements.

    • UDP - The UDP node is used for sending and receiving messages over the User Datagram Protocol (UDP), enabling communication with other devices and services that use UDP for data transmission.

    • TCP - The TCP node is used for sending and receiving messages over the Transmission Control Protocol (TCP), facilitating reliable communication between Node-RED and other devices or services that use TCP.

  • Output Nodes: These nodes send data and receive responses with other components within your Contextual system, as well as with external systems, like databases or APIs.

    • HTTP Response - Sends HTTP response codes (e.g. 200, 400) to end an HTTP flow.

    • Event End - Provides the termination for an Event flow.

    • Event Error - Is similar to an Event End but can be used to terminate an error catch.

  • Processing Nodes: These nodes manipulate, transform, and process data as it moves through the flow. Examples include function nodes for custom JavaScript code, switch nodes for conditional routing, and template nodes for data formatting.

Wires

Wires connect nodes together, defining the path that data takes through the flow. Data travels from the output of one node to the input of the next.

Creating and Managing Flows

Building Flows

  1. Drag and Drop: Nodes are dragged from the palette onto the workspace.

  2. Connect Nodes: Nodes are connected by dragging wires between them.

  3. Configure Nodes: Each node can be configured by double-clicking on it to set properties and parameters.

Deploying Flows

Organizing Flows

Flows can be organized into tabs within the editor, allowing for better management and separation of different tasks or projects.

Conclusion

Flows in provide a powerful and intuitive way to connect and orchestrate functionality within your Contextual solution. By leveraging the drag-and-drop interface and the extensive library of nodes that are certified to work in the unique Contextual environment, you can quickly build and deploy complex workflows with minimal coding.

Once a flow is designed and configured, it needs to be deployed to test it locally in the Contextual Flow Editor, and to stage it for operational release within your system which is achieved by associated with the Flow.

Nodes
Message Object
Event to Flow Agents
HTTP to Flow Agents
restarting the Agent