Skip to main content

"createOutput"

JSON hub "createOutput" action creates a new FairCom Edge integration

The "createOutput" action creates a new integration.

Essential information

  • An integration connects data in the server to an output plugin that delivers tags from the server to external systems, such as connecting the integration table populated by OPC UA to the ThingWorx connector.

    • The data source for an output definition is an integration table.

    • An output plugin delivers tags from an integration table in FairCom Edge over an external protocol, such as OPC UA, to an external system, such as a device or Manufacturing Execution System (MES).

  • Each integration table can have zero or more integrations assigned to it. Thus, multiple plugins can read from the same integration table. For example, the MQTT and THINGWORX plugins can use the same integration table.

    Note

    Use "mqtt_configureTopic" to connect MQTT to an existing integration table.

Note

A tag is a piece of named data with an associated value. For example, the tag temperature 70 includes both the named data temperature and the value 70. In JSON, a tag is a JSON property, such as "temperature": 70. In a SQL table, a tag is a data field, such as a field named temperature with a value of 70.

Request examples

Minimal request

{
  "authToken":"anAuthorizationTokenFromTheServer",
  "api":"hub",
  "action":"createOutput",
  "params":{
     "outputName":"rest1",
     "tableName":"modbusTableTCP",
     "serviceName":"rest",
     "settings":{
        "host":"127.0.0.1:1880",
        "uri":"/equipment/2/alert",
        "body":[
           {
              "propertyPath":"Temperature",
              "propertyValue":{
                 "fromSourcePropertyPath":{
                    "formatString":" <%temperature%> "
                 }
              }
           }
        ]
     }
  }
}

Maximal request

{
  "authToken":"anAuthorizationTokenFromTheServer",
  "api":"hub",
  "action":"createOutput",
  "params":{
    "serviceName":"rest",
    "outputName":"rest1",
    "tableName": "modbusTableTCP",
    "outputFieldName": "source_payload",
    "settings":{
      "host": "127.0.0.1:1880",
      "uri": "/equipment/2/alert",
      "headers":[
        "tenantId: 99,01",
        "X-erp-module: MNT"
      ],
      "body":[
        {
          "propertyPath": "equipment",		
          "propertyValue": {"fromConstant": "0002"}
        },
        {
          "propertyPath": "description",
          "propertyValue": {
           "fromSourcePropertyPath": {
              "formatString": "Temperature is too high. Please, verify. Temperature = <%temperature%>."
            }
          }
        }
      ],
      "threshold":{
        "expression": "temperature > 60"
      }
    }
  }
}

Response example

{
  "authToken": "anAuthorizationTokenFromTheServer",
  "result": {},
  "requestId": "00000004",
  "errorCode": 0,
  "errorMessage": ""
}

Use the createOutput JSON API action to creates a new FairCom Edge integration

JSON hub APIAPI actionsjsonActionoutput actionscreate outputcreateOutput

"params"

The "params" property is an object that contains an action's parameters. Each action defines its own required and optional properties.

Property summary

Table 1. "params" property summaries

Property

Description

Default

Type

Limits (inclusive)

databaseName

specifies the name of a database

Defaults to the "defaultDatabaseName" value that is set during "createSession". If no default is set during "createSession", then "faircom" is used.

string

1 to 64 bytes

metadata

exists primarily for the user interface to find integration information

{}

object

May contain any number and type of user-defined properties

outputName

specifies a unique name for mapping of an integration table to an output plugin to an external system

A FairCom generated name that follows the pattern "Output #n from <databaseName>.<schemaName>.<tableName> to <pluginName>"

string

1 to 64 bytes

serviceName

specifies the name of a service that collects data from an external source and inserts it into an integration table

Required - No default value

string

1 to 64 bytes

"MODBUS"
"OPCUA"
"REST"
"THINGWORX"

settings

contains properties needed to configure the data source of the specified plugin

{}

object

settings
.body

specifies information to send to a REST server

Optional

array of objects

settings
.body
.propertyPath

specifies the name of data to be defined by "propertyValue"

Required - No default value

string

settings
.body
.propertyValue

specifies an array of properties that define the data of a named "propertyPath"

Required - No default value

object

settings
.headers

specifies additional information about the request. It is a list of elements with the key-value format

Optional

List of strings with the format key: value

settings
.host

specifies the IP or hostname of the Rest resource, including port

Required - No default value

string

settings
.threshold

specifies properties that define the threshold for sending a REST command

settings
.uri

specifies the identifier name of the REST resource

Required - No default value

string

outputFieldName

specifies the field that the MQTT Subscription engine should use as the payload when it sends the payload to subscribers

"source_payload"

string

"source_payload"
"t1"
"t2"
"t3"
"t4"
"t5"
"t6"
"t7"
"t8"
"t9"

tableName

specifies the name of a table

Optional - No default value

string

1 to 64 bytes



"databaseName"

The "databaseName" property is an optional string that specifies the database that contains the tables. It defaults to the database name supplied at login.

Note

In the API Explorer, "defaultDatabaseName" is set to "ctreeSQL" in the "createSession" action that happens at login.

Essential information

  • A zero-length "databaseName" is invalid.

  • Its limits are from 0 to 64 bytes.

  • If the "databaseName" property is omitted or set to null, the server will use the default database name specified at login.

  • If no default database is specified during "createSession", "defaultDatabaseName" will be set to the "defaultDatabaseName" value that is specified in the services.json file.

"metadata"

The "metadata" property is an optional JSON object. It exists primarily for the user interface to find integration information. By default, it is an empty JSON object.

Essential information

  • It contains a flexible set of properties.

  • It typically contains tags and description properties.

Example

{
  "description": "",
  "tags": [""],
  "yourOwnProperties": "usage, purpose, notes, location, etc.",
}

"settings"

Property summary

Table 2. "settings" property summaries

Property

Description

Default

Type

Limits

"host"

contains the IP or hostname of the Rest resource, including the port

Required - No default

string

"uri"

contains the identifier name of the REST resource

Required - No default

string

"headers"

contains additional information about the request. It is a list of elements with the key-value format

Optional

List of strings with the format key: value

"body"

contains information to send to a REST server.

Optional

array of objects

"body"."propertyPath"

specifies the name of data to be defined by "propertyValue".

[Required]

No default

string

"body"."propertyValue"

contains an array of properties that define the data of a named "propertyPath".

[Required]

No default.

object

"threshold"

contains properties that define the threshold for sending a REST command



"body"."propertyValue"

This is a required object that contains properties that define the data values of a "propertyPath". It is required and has no default value.

The data values specified in the "propertyValue" object can be a string or an object.

  • "fromConstant" indicates the value is a string. For example —

    "propertyValue": {"fromConstant": "0002"}

  • "fromSourcePropertyPath" indicates the value is an object. For example —

    "propertyValue": {"fromSourcePropertyPath": { "formatString": "Temperature = <%input_temp%>" }}

    Characters in the "formatString" value that are enclosed by "<%" and "%>", specify the name as an input property that will be replaced by an input property value.

    Here is a REST command example for the "propertyPath" named "description", that received an input_temp value of 103:

    {  description: "Temperature = 103."}

    If the input value is not found, it is replaced with NULL:

    {  description: "Temperature = NULL."}

"outputFieldName"

The "outputFieldName" property is an optional string that contains the name of a field from an integration table. It defaults to "source_payload".

"tableName"

The "tableName" property contains the name of the table in the database where the event occurred. It is a non-zero-length string.

A table name may contain up to 64 ASCII characters and must not start with a number.

A table in DBnotify is defined by "databaseName", "ownerName" and "tableName" or by "dataFilePath".

A database is a set of data that is managed by a database server. A database contains data that is organized into tables, records, and fields. A database is a huge composite data type that represents a group of interconnected objects. A database allows records to be joined together for querying, searching, and processing by users, applications, and services.

A database is a security container that controls which accounts have permissions to access specific data.

JavaScript Object Notation (JSON) is a simple format for representing data. It requires very little markup and is flexible enough to represent the majority of data structures. It is self-describing, which makes it ideal for schemaless applications and search. It can optionally be paired with a schema to define an expected structure.