Welcome to TCUP User’s Guide

Contents:

• Device Management(DM)
  • Introduction
  • Purpose of the Document
  • Reference Document
  • DM Service Using Portal
    • Accessing the Portal
    • Generating Pre Shared Key
    • Running Device Agent, Register and Communication with Device
    • Update Resource Value of Device Using Command
  • DM Agent
    • Device Management Agent : C based implementation
    • Device Management Agent : Java Agent Documentation
• Bootstrap and Over the Air Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • OTA Service Using Portal
    • Accessing Portal
    • Install Bootstrap Agent in Device
    • Install and Start OTA Agent in Device
    • Checking Device Status from Portal
    • Pre-register Device in TCUP
    • Create OTA Package
    • Upload OTA Package and Run
• Asset Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Working with Asset Service Portal
    • Accessing Asset Service Portal
    • Manage Asset Domains
    • Manage Projects
    • Manage Asset Type
    • Manage Asset
    • Manage Event
    • Asset Query
    • Asset Compare
    • Permission
    • User’s Activity
• Sensor Observation Service (SOS)
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Working with SOS
    • Feature Creation
    • Sensor Creation
    • Posting Sensor Observation
• Sensor Data Explorer
  • Introduction
  • Purpose of the Document
  • Working with Sensor Data Explorer
    • Accessing Sensor Data Explorer
    • SDE Dashboard
• Data Lake Explorer
  • Introduction
  • Features
  • Screens:
    • Dashboard/Home
    • Catalog
    • Upload
  • Link
  • Share
  • Failed Uploads
  • Trash
• Task Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Working on Task Service Using Portal
    • Project
    • Task
    • Delayed Task
    • Recurrent Task
• Workflow Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Workflow Service Using Portal
  • Workflow Service Using Swagger
    • Create Schedule and Process Definition
    • Create Permission
    • Search Process Definition
    • Details for Process Definition
    • Run
    • Get Status
    • History
    • List
    • Pause
    • Resume
    • Abort
    • Pre-Init
    • Get Mapping
    • Init
    • Search Process Instance
    • Recovery Mode
    • Recover Process
• Notebook
  • Notebook Service
    • Introduction
    • Features
    • User Hierarchy and Credentials
    • Usage Overview
  • pytcup
    • Introduction
    • Purpose/Usage
    • Modules
• pyconnector
  • Introduction
  • Purpose/Usage
  • Prerequisite
  • Working with connector examples
  • Modules
    • pyconnector
• Message Routing Service
  • MR Introduction
    • Purpose of the Document
    • Reference Document
  • API Details
    • List of API Services:
  • Create Routing Rule
    • Buffer Rule
    • Feature Based
    • Sensor Based
    • Time Based
    • Expression Evaluation - if then else
    • Position Based Filtering - Geolocation
    • Observed Property
    • Meta-data Property
    • Parameter Property
    • Quality Property
    • Redis(In memory DB)
  • Operation on Topic Exchange
    • Create Topic Exchange
    • Get Topic Exchange
    • Get Topics on Topic Exchange
    • Delete a Topic Exchange
  • Describe Routing Rule
    • Get All Rules
    • Get Rule by ID
    • Get Associated Routing Keys
  • Operation on Routing Rule
    • Start the Routing Channel
    • Stop the Routing Channel
    • Update Routing Rule
    • Delete a Routing Rule
  • Execute and View Result
    • Publish Observation Data
    • SendRequest(HTTP)
    • SendRequest(gRPC)
    • View Result
  • Rules Statistics
    • List Rules Overview
    • List Statistics for All Rules
    • List Statistics for a Rule
  • Rules Versions
    • List Rules Versions
    • List Versions for a Rule
    • Get a Version of a Rule
  • Rules Download and Upload
    • Download Rules in a File
    • Download rules in a file - HTTP POST Method
    • Upload Rules from File
• MQ Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • API Details
  • List of API Services:
  • Create User
  • Operation on Accounts
    • Create an MQ-Account
    • Get List of MQ Accounts
    • Delete an MQ Account
  • Operation on consumerGroups
    • Create a consumerGroups
    • Get List of consumerGroup
    • Get Details for a consumerGroup
    • Delete a consumerGroup
  • Binding consumerGroups
    • Create a consumerGroup-bind
    • Delete a consumerGroup-bind
• Complex Event Processing(CEP)
  • CEP Introduction
    • Purpose of the Document
    • Reference Document
  • Create Rule
    • MultipleStreamJoining/filtering/SQL on streaming data
    • PureAggregation with Filtering
  • Describe Rule
    • Get All Rules
    • Get Rule by ID
  • Operation on Rule
    • Start the rule
    • Stop the rule
    • Update the rule
    • Delete a rule
  • Execute and View Result
    • Event Selections
    • Operations on Events
    • Actions
  • Appendix
    • Use Case 1
    • Use Case 2
• Action Service
  • Introduction
    • Purpose of the Document
    • Reference Document
  • Create Rule
    • Predefined Action Type
    • Custom Action Type
  • Describe Rule
    • Get All Action Rule
    • Get a Specific Action Type Rule
    • Get a Specific Action Rule
  • Action on Created Rule
    • Start an Action Service Rule
    • Stop an Action Service Rule
    • Update an Action Service Rule
    • Delete an Action Service Rule
  • View Result
    • Publish Data
    • Check Result
    • View Status
  • Service Integration
    • TDE
    • SOS
  • Statistics
    • Get All Rule Details
    • Get All Rule Statistics
    • Get a SpecificRule Statistics
  • Schedule
    • Count
    • Time
  • Rules Download and Upload
    • Download Rules in a File
    • Download rules in a file - HTTP POST Method
    • Upload Rules from File
  • Appendix 1
    • Introduction
    • Steps to Create Custom Action Type
    • Acknowledgement based Action Types
    • Kafka based Action Service
• Event Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Event Service Using Swagger
    • Accessing Swagger
    • Insert Events in Stream with sos json
    • Insert Events in Stream with flat json(sos compliant json)
    • Insert Events in Stream with flat json(any json)
    • Get events from stream by filtering with starttime and endtime
    • Get events from stream by filtering with observed property
    • Get aggregated event from stream by using aggrgation function(SUM,AVG,MAX,MIN,COUNT)
    • Get event from a stream by eventId
    • Get latest subscribed event from stream
    • Get list of subscribed events from stream
    • Get length of stream
    • Delete events from stream
• SSE
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Browser Support
  • Subscribe/View Data from TCUP Portal
  • Connection URL
    • The following are the different connection URLs:
    • SSE URLs for apiKey User
    • SSE URLs for JWT User
  • Input JSON and Sample Output
  • Subscribing using Java-client
• Websocket
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Publishing Data using Websocket
    • Publish Data from Portal
    • Websocket Publisher URL
    • Publishing Using Java-Client
  • Subscribe/View Data using Websocket
    • Subscribe/View Data from Portal
    • Websocket Subscriber URLs
    • Subscribing Using Java-client
  • Sample Input JSON
• Application Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Deploying Application Using Portal
    • Register an Application
    • Search an Application
    • Deploy an Application
    • Start an Application
    • Stop an Application
    • Undeploy an Application
    • Delete an Application
    • Application Logs
• App Guard Management Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • App Guard Organization Admin (‘Org-Admin’)
    • Features of ‘Org-Admin’
  • App Guard Tenant
    • Features of Tenant
  • App Guard Tenant-Users and User
    • Features of Tenant-Users and User
    • Running Device Agent, Register and Communication with Device
    • Update Resource Value of Device Using Command
  • DM Agent
    • Device Management Agent : C based implementation
    • Device Management Agent : Java Agent Documentation
• Database Service
  • Introduction
  • Purpose of the Document
  • Reference Document
  • Register a Database
  • Update Schema by ID
  • Drop Database by ID
  • Client Side Free Text Search
• TCUP Edge Service
  • Introduction
  • Edge Portal
  • Purpose of the Document
  • Reference Document
  • Working with Edge Portal
    • Accessing Edge Portal
    • Home Page
    • Rules
    • Sensor Data
    • Monitoring
    • Sandbox
    • Configuration
    • Console
    • Calculation Manager