Skip to content
Vantiq Community
Academy
Courses • Training • Webinars
Documentation
Support
Discussions
Vantiq
Vantiq.com • Platform
Register / Log In
Vantiq Platform Community
Vantiq Community
Academy
Documentation
Support
Discussions
Search Log In
Courses Training Webinars
Welcome to Vantiq Docs

Getting Started

  • Welcome to Vantiq!

  • Introductory Tutorials

    • GenAI Quickstart Tutorial
    • Hello World Tutorial
    • How To Take Vantiq On-Demand Training
    • Introductory Tutorial

  • Feature Tutorials

    • Advanced Collaborations
    • Analytics
    • App Components
    • Assemblies
    • Catalogs Tutorial
    • Client Builder
    • Client Components
    • Deployment Tutorial
    • Floor Plan
    • Introduction to Collaboration
    • Natural Language Tutorial
    • Sources
    • Stateful Services
    • System Modeler
    • Testing the Debugging Tutorial
    • Testing the Introductory Tutorial
    • Testing the Source Tutorial
    • User and Namespace Administration

Product Documentation

  • Reference Guides

    • Vantiq Modelo

    • Client Builder

      • Client Builder Reference Guide
      • Client Builder User’s Guide
        • Accessing Documents
        • Automatic Document Caching
        • Client Resources
        • Client Startup
        • Control Widgets in the "Views" Portion of Client Builder
        • Controllers
        • Creating A Client
        • Data Objects
        • Data Stream Widgets in the “Views” Portion of Client Builder
        • Data Streams
        • Debugging
        • Field Validation
        • Introduction
        • Launching Clients from a browser
        • Layout Widgets in the “Views” Portion of Client Builder
        • Localizing Clients
        • Navigation Between Pages
        • Offline Operation
        • On Start Events
        • Public Clients
        • Server Requests
        • Terminating The Client
        • The Client Builder Concepts
        • The Client Builder's Canvas Section
        • The Client Builder's Control Dock
        • The Client Builder's Palette Area
        • The Client Builder's Slideout Section
        • Uploading data to the Server
      • Layout Management User’s Guide
        • Cells
        • Example - Responsive Design Layout using a Grid Container
        • Example - Simple Form Layout
        • Gravity
        • isVisible
        • Layout Containers
        • Layout Management User’s Guide Background
        • Margins
        • Natural Size
        • Page Layout Type
        • Responsive Design
        • Size Policies
        • Weight
        • Widgets
      • Client Styling User’s Guide
        • Client Navigation Bar Styling
        • Client Styling User’s Guide - Introduction
        • Client Themes
        • Widget CSS Styling
        • Widget Styling
      • Client Components User’s Guide
        • Client Components
        • Consuming a Component
        • Creating a Component
        • Editing a Component
        • Special handling of names within Client Components
      • Client Builder Reference Guide
        • abort()
        • cancelSpeaking()
        • clearInterval()
        • clearTimeout()
        • clone()
        • closePopup()
        • confirmCustom()
        • confirmCustomEx()
        • createClientEventDataStream()
        • createDataChangedDataStream()
        • createOutboundServiceEventDataStream()
        • createPagedQueryDataStream()
        • createPublishEventDataStream()
        • createResourceEventDataStream()
        • createSourceEventDataStream()

    • Operations & Management

      • Administrators Reference Guide
        • Accessing Namespaces in the Organization
        • Active Resource Control Center
        • Adding a New User to an Organization
        • Adding a New User to the Application Namespace
        • Administrators' Concepts and Terminology
        • Authorizing Users to Access the Application
        • Creating a Developer Namespace for the Organization Administrator
        • Creating a New Application Namespace
        • Creating Resources for New Namespaces
        • Custom User Invites
        • Deploying the GenAI Flow Service Connector
        • Developer Tasks
        • Handling Administrators Leaving
        • Related Configuration
        • Removing Namespace Administrators
        • Self-Administration Tasks
        • System Administration Tasks
        • Viewing Lists of Users
      • Deployment Reference Guide
        • Building networks
        • Configuration and Deployment
        • Connecting systems using Nodes
        • Tagging systems with properties
      • Deployment Tool User's Guide
        • Deploy Results Tab
        • Deploying the same application to different environments
        • Deployment
        • Deployment Tool - Introduction
        • Environment
        • Environment Tab
        • Node
        • Project Partitions
        • Redeploy On A Failed Node
        • Reliable Deployment
        • Settings Tab
        • The Graph View
        • The Tree View
        • Undeploy
        • Update Partitions
        • Verify Application After Deployment
      • CLI Reference Guide
        • CheckedInsert/CheckedUpsert Command
        • Command Line Options
        • Delete Command
        • Execute Command
        • Export Command
        • Find Command
        • Help Command
        • Import Command
        • Insert Command
        • Installation - Prerequisites
        • Installation - Profile
        • List Command
        • Load Command
        • Recommend Command
        • Run Command
        • Select Command
        • Stop Command
        • The Vantiq Command Line Interface (CLI) - Overview
        • Upsert Command
      • Monitoring with Grafana
        • App Execution Dashboard
        • App With Split Dashboard
        • Dashboard Navigation Bar
        • Deprecated Dashboards
        • Event Processing Dashboard
        • General Dashboard Behavior
        • Getting Started with Grafana
        • Grafana Usage
        • Monitoring Namespaces with Grafana
        • Most Commonly Used Dashboards
        • Namespace Monitoring Dashboards
        • Organization Level Behavior
        • Procedure and Rule Execution Dashboards
        • Profiling Dashboards
        • Reliable Event Dashboard
        • Resource Usage Dashboard
        • Service Execution Dashboard
        • Service Handler Dashboard
        • Source Activity Dashboard
        • Storage Manager Dashboard
        • Tensorflow Model Dashboard
        • Type Storage Dashboard
      • Reliable Messaging Guide
        • Acknowledging Events
        • Chaining Reliability
        • Enabling Reliability
        • Ingesting Reliable Events
        • Performance Concerns
        • Reliability in Third Party Applications
        • Reliable Messaging in Vantiq
      • External Lifecycle Management Guide
        • Access to a Kubernetes Cluster
        • Creating a K8s Cluster
        • Delayed Processing
        • Deploying K8s Installations to a Kubernetes Cluster
        • Deploying the K8s Worker
        • External Lifecycle Management Guide - Overview
        • K8s Worker
        • Kubernetes Components of a K8s Installation
        • Kubernetes Namespaces
        • Loading Images into a Kubernetes Cluster
        • Managing K8s Installations
        • Other Configuration Options
        • System View
        • Use of the self Cluster
        • Using a Kubernetes Cluster
        • Using Templates to Deploy the K8s Worker
        • Vantiq Namespaces
        • Verify Installation
      • Vantiq Edge Reference Guide
        • Changing the System Password
        • Creating a GenAIFlowService Service Connector
        • Creating a New Organization and Namespace
        • Deployment Methods
        • Docker Deployment
        • Edge Installation Management
        • Edge Vision Server
        • Executable JAR Deployment
        • MongoDB
        • Requirements
        • Running the Vantiq Executable
        • Setting the default LLMs API key
        • Setting Up Vantiq Edge
        • Vantiq Edge Reference Guide - Overview
        • Vantiq Edge Self Node
        • Windows bat file
      • Workload Management
        • Additional Buffer Semantics
        • Applicability
        • auditFrequency Quota
        • Background
        • Default Quotas
        • Detailed Credit Quotas
        • errorBreaker Quota
        • errorReportingFrequency Quota
        • Execution Credit Quota
        • Execution Credit Quota - Diagnostics
        • Execution Credit Quota - Mitigation
        • Execution Rate Quota
        • Execution Rate Quota - Diagnostics
        • Execution Rate Quota - Mitigations
        • executionTime Quota
        • k8sResources Quota
        • Quota Interactions
        • receiveMessage Quota
        • receiveMessage Quota - Diagnostics
        • receiveMessage Quota - Mitigation
        • reservedGroups Quota
        • stackDepth Quota
        • Stream Quota
        • Terminology
        • Workload Management
        • Workload Management Conceptual Model

    • Design Modeler

      • Design Modeler Reference Guide
        • Bridge Services
        • Converting Placeholder Services and Clients
        • Creating a New Design Model
        • Creating New Connections
        • Design Modeler Tutorials
        • System Model Requirements
        • Understanding the Design Model Pane

    • Service Builder

      • Service Builder Reference Guide
        • Global State
        • Implementation of Services
        • Integration Tests
        • Partitioned State
        • Scheduled Procedures
        • Service Event Types
        • Service Guide
        • Service Procedure Signatures
        • Service Replication
        • State Initialization
        • Stateful Services
        • Stateless Procedures
        • Stateless Services
        • The Service Interface
        • Unit Tests

    • Branding

      • Branding the Vantiq Android Mobile App
      • Branding the Vantiq iOS Mobile App
      • White-Labeling Vantiq
        • brandedProperties
        • loadGoogleComponents
        • navbarDefaults
        • White-Labeling Vantiq

    • App Builder

      • App Builder Reference Guide
        • Accumulate State
        • Analytics
        • Answer Question
        • App Activity Tasks
        • App Builder Guide - Introduction
        • App Builder Overview
        • Assign
        • Build and Predict Path
        • Cached Enrich
        • Chat
        • Close Collaboration
        • Collaborations in Apps
        • Compute Statistics
        • Convert Coordinates
        • Creating an App
        • DBScan
        • Delay
        • Dependency Management
        • Dwell
        • Enrich
        • Error Handling
        • Escalate
        • EscalateState
        • Establish Collaboration
        • Event Redelivery
        • Event Stream
        • Filter
        • GenAI Flow
        • Get Collaboration
        • Interpret Conversational Language
        • Join
        • K-Means Cluster
        • Limit
        • Linear Regression
        • Log Stream
        • Loop While
        • Merge
        • Notify
        • Optional Imports
        • Polynomial Fitter
        • Predict Paths By Age
        • Procedure
        • Process Intent
        • PublishToService
        • PublishToSource
        • PublishToTopic
        • Rate
        • Recommend
        • RecordEvent
        • Reliable Apps
        • Run TensorFlow Model On Document
        • Run TensorFlow Model On Image
        • Run TensorFlow Model On Tensors
        • Sample
        • SaveToType
        • Split By Group
        • Submit Prompt
        • Threshold
        • Time Difference
        • Track
        • Track Motion
        • Tracking Progress
        • Transformation
        • Unwind
        • VAIL
        • VisionScript
        • Window
        • Within Tracking Region
        • YOLO From Images
      • App Components Reference Guide
        • App Components Guide
        • Authoring Components
        • Component Downstreams
        • Component Implementations
        • Component Interfaces
        • Component Representation
        • Configuration Property Types
        • Custom Generator Procedures
        • Expanding Components
        • Exploding Components
        • Importing and Updating Components
        • Using Components
      • Natural Language Processing Reference Guide
        • Interpreter Source
        • Language Design
        • Natural Language Processing
        • Natural language processing in Apps
        • Natural Language via Rules
        • NLP Overview
        • Processing the Natural Language
        • VAIL Services and Procedures Reference
        • Vantiq System Natural Language Subset
        • Working with Natural Language in Vantiq

    • Assemblies

      • Assemblies Reference Guide
        • Assembly
        • Assembly Integration Tests
        • Assembly Interface
        • Authoring an Assembly
        • Configuration Properties
        • Configuring the Assembly
        • Consuming Assemblies
        • Integrating and Composing Assemblies
        • Manually Testing the Assembly
        • Using Configuration Properties to Customize Resources
        • Visible Resources

    • Catalog

      • Vantiq Catalog Reference Guide
        • Configuring the Vantiq Catalog
        • Connecting To A Catalog
        • Event Catalog
        • Provisioning Catalogs
        • Service Catalog
        • Terminology
        • Vantiq Catalog Reference Guide - Overview
      • Vantiq Catalog API Reference Guide
        • Broker Service
        • Catalog Operations
        • Catalog Procedures
        • Connect to Catalog
        • Create Entry
        • Create Entry
        • Custom Operations
        • Disconnect from Catalog
        • Host Catalog
        • Integrating Applications With the Catalog
        • Managing Catalog
        • Managing Event Types
        • Publisher Service
        • Register
        • Remove Entry
        • Repair Catalog
        • Resolve
        • Subscriber Service
        • Unhost Catalog
        • Unregister
        • Utilities
      • Vantiq Catalog Security Guide
        • Catalog Access
        • Catalog Connections Overview
        • Using The Event Ledger
        • Vantiq Catalog Security Guide

    • Image Processing

      • Image Processing Reference Guide
        • “Plain” TensorFlow Models
        • Application Design
        • Concepts
        • Image Acquisition
        • Image Analysis
        • Image Manipulation
        • Image Processing
        • Motion of Objects
        • Motion Tracking
        • Using Vision Script
        • Vision Script
        • YOLO-based TensorFlow Models

    • External Sources

      • Email Source Integration
      • External Source Reference Guide
      • MQTT Source Integration
      • Push Notification Source Integration
      • Remote Source Integration
      • SMS Source Integration
      • SMS Reference Guide
        • Create SMS Source
        • Define an SMS Source
        • Delete SMS Source
        • Publish Notifications via an SMS Service
        • SMS Source Integration
      • CHATBOT Reference Guide
        • Chatbot Source Integration
        • Creating a Chatbot Source
        • How to Integrate Chatbot
        • Integrating with the Chatbot Services
        • Publishing Arbitrary Chat Messages
      • Push Notification Reference Guide
        • Define a PUSH_NOTIF Source
        • Push Notification Source Integration
        • Sending Push Notifications
      • KAFKA Reference Guide
        • Azure Event Hubs Configuration examples
        • Consume Messages
        • Content Type
        • Create a Kafka Source
        • Delete a Kafka Source
        • Kafka Source Integration
        • Kafka Source Representation
        • Produce Messages on a Kafka Topic
        • QoS
        • Serialization and contentType
        • SSL Setup
      • Google Cloud Pub/Sub Reference Guide
        • Consuming Messages from GCPS Subscriptions
        • Create a GCPS Source
        • Delete a GCPS Source
        • GCPS Source Representation
        • Google Cloud Pub/Sub Source Integration
        • Produce Messages on a GCPS Topic
      • Enterprise Connectors Reference Guide
        • Communicating with an Enterprise Connector
        • Enterprise Connector Details
        • Introduction to Enterprise Connectors
        • Managing the Connector
        • Sending Document, Image, or Video via JSON
        • Size Limits When Operating on Documents, Images, or Videos

    • Storage Containers

      • Storage Managers Reference Guide
        • Advanced Use Cases
        • Data Manipulation
        • Defining Types
        • Discovery from External Data Store
        • Error Handling
        • Installation and Use
        • Native Language Implementation
        • Restricting Capabilities
        • Service Connectors
        • Storage Manager Assembly Contents
        • Storage Manager Service API
        • Storage Manager Transactions
        • Storage Managers - Introduction
        • Transaction Support

    • Testing

      • Testing Reference Guide
        • App Pane
        • Autopsies
        • Defining a Run Policy
        • Defining a Test Suite - Properties
        • Defining an Input
        • Defining an Output
        • Error Pane
        • Integration Tests
        • Populate Testing Namespace With Data
        • Procedure Pane
        • Rule Pane
        • Running a Test in the IDE
        • Running a Test through the REST Interface
        • Source Mocking For Tests
        • Unit Tests
        • Vantiq Testing Reference Guide - Introduction
      • Event Generators
        • Defining an Event Descriptor
        • Defining an Event Generator
        • Defining Generator Rules
        • Event Generators - Introduction
        • Running an Event Generator
        • Status of an Event Generator
        • Stopping an Event Generator
      • Captures
        • Captures - Introduction
        • Defining a Capture
        • Export Capture to a Test
        • Export Capture to an Event Generator
        • Exporting a Capture
        • Global Capture
        • Start a Capture
        • Stop Capture
        • Targeted Capture

    • AI

      • GenAI Builder Guide
        • Assign
        • Branch
        • Categorize
        • CodeBlock
        • Consensus
        • Content Ingestion Flows
        • Conversation
        • GenAI Builder Guide Introduction
        • GenAI Builder Layout
        • GenAI Components
        • GenAI Flow Properties
        • GenAI Flow Tracing and Auditing
        • Launching the GenAI Builder
        • LLM
        • Memory and Conversations
        • Merging Task Outputs
        • NativeLCEL
        • Optional
        • PromptFromTemplate
        • RAG
        • Repeat
        • Runtime Configuration
        • Semantic Index
        • Sub-Flows
        • Supported VAIL Language Features
        • Using GenAI Components
        • Vantiq Provided GenAI Components
      • LLM Reference Guide
        • AWS
        • Azure OpenAI
        • Bedrock
        • Configuration
        • Function Authorizer
        • Gemini
        • LLM Playground
        • Main Chatting Area
        • Navigation Panel
        • NVIDIA NIM
        • OpenAI
        • SageMaker
        • Settings Panel
        • Testing Semantic Index
        • Tool Authorizer
        • Tools
      • Semantic Search Guide
        • Creating a Semantic Index
        • Efficiently storing and searching embeddings
        • External Semantic Indexes
        • Leveraging Generative AI models
        • Performing Semantic Search
        • Semantic Search
        • Semantic Search Architecture
        • Semantic Search Guide Introduction
        • Semantic Search in Vantiq
        • Vectors and Embeddings

  • Core Platform

    • Resource Reference Guide

      • Assembly Configs
      • Audits
      • Catalog Members
      • Catalogs
      • Debug Configs
      • Delegated Requests
      • Documents
      • Event Generators
      • Groups
      • Images
      • K8s Clusters
      • K8s Installations
      • K8s Workitems
      • LLMs
      • Logs
      • Namespaces
      • Nodes
      • Organizations
      • Procedures
      • Profiles
      • Projects
      • Resource Definition
      • Resource Events
      • Resource Relationship Model
      • Resource Security Model
      • Rules
      • Scheduled Events
      • Secrets
      • Semantic Indexes
      • Service Connectors
      • Services
      • Sources
      • StorageManagers
      • TensorFlowModels
      • Test Reports
      • Test Suites
      • Tests
      • Tokens
      • Topics
      • TrackingRegions
      • Types
      • Users
      • Vantiq Resources
      • Videos

    • IDE User’s Guide

      • Development App
      • IDE Docks
      • IDE Layout Styles
      • IDE Shortcut Keys
      • Integration with Version Control Systems
      • Operations App
      • Panes
      • Project Views
      • Safe Mode
      • The Navigation Bar
      • Vantiq IDE User’s Guide Overview

    • API Reference Guide

      • Accessing the API
      • API Bindings
      • API Operations
      • API Reference Guide Overview
      • API Resource Types
      • API Responses

    • VAIL Reference Guide

      • Before Rules
      • Built-In Services
      • Data Manipulation
      • Data Model Declarations
      • Declaring Packages
      • Defining Remote Connections
      • Distributed Processing
      • Error Handling
      • Event Sending
      • External State
      • Flow Control
      • General Use Procedures
      • In-Memory State Management
      • Iteration
      • Logging
      • Operators
      • Package Scoping and Name Resolution
      • Packages
      • Packages
      • Persistent State
      • Procedure Execution
      • Procedures
      • PROCESSED BY Clause
      • Resource Definition
      • RETURN
      • Rules
      • Services
      • Syntax
      • Type Specific Procedures
      • VAIL Declarations
      • VAIL Types
      • Variables

  • Release Notes

    • Release Notes

Articles

  • Architecture

    • Domain and Multi-Domain Integration with Vantiq
    • Event Driven Integration
    • Event Driven Thinking

  • Best Practices

    • How To Video Shorts: Client Layouts
    • How To Video Shorts: AI Functions
    • How To Video Shorts: Analytics and ComputeStatistics
    • How To Video Shorts: Calling Procedures by Properties
    • How To Video Shorts: Client CSS
    • How To Video Shorts: Invite Other Users to Your Namespace
    • How To Video Shorts: SplitByGroup
    • How To Video Shorts: The Vantiq API
    • How To Video Shorts: The Vantiq IDE
    • How To Video Shorts: The Vantiq Version Control System
    • How To Video Shorts: Using Generative AI in Applications
    • How-To Video Shorts: Managing AI Conversations
    • How-To Videos: AI Design Model Assistant
    • How-To Videos: AI Documentation Search
    • Production Applications Best Practices

  • Performance

    • Diagnosing Faults and Scalability Issues In Vantiq Applications
Academy Documentation Support Discussions Help
© Vantiq 2024 All rights reserved  •  Vantiq Corporation’s Privacy Policy and Cookie Policy