"describeOutputs" (JSON Action)

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

"params": {
  "databaseName": "mainDatabase"
  }

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.

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

The "outputName" property is an optional string that specifies a unique name for mapping an integration table to an output plugin to an external system.

  "params": {
    "outputName": "AcmefactoryLine1Station1AcidbathTelemetryOutput"
  }

The "ownerName" property is an optional string from 1 to 64 bytes that identifies the user who owns an object (see Object owner). If it is omitted or set to "" or null, the server uses the default owner name supplied during the "createSession" action or uses the account's "username" as the owner name.

"params": {
  "ownerName": "SuperUser"
}

The "serviceName" property contains the name of a FairCom input or output service. This property is required.

See the "params" topic of each specific service for the requirements of this property.

The "body" property specifies information to send to a REST server by defining the "propertyPath" and "propertyValue" properties.

    "settings": {
        "body": {
            "propertyPath": "humidity",
            "propertyValue": {"fromConstant": "0002"}
        },
        "uri": "identifier name",
        "host": "hostname and port"
    }

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

      "body": [
        {
          "propertyPath": "Temperature",
          "propertyValue": {
            "fromSourcePropertyPath": {
              "formatString": "<%temperature%>"
            }
          }
        }
      ]

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.

The "host" property specifies the IP or hostname of the Rest resource, including the port.

    "settings": {
        "body": {
            "propertyPath": "humidity",
            "propertyValue": {"fromConstant": "0002"}
        },
        "uri": "identifier name",
        "host": "hostname and port"
    }

The "uri" property specifies the identifier name of the Rest resource.

    "settings": {
        "body": {
            "propertyPath": "humidity",
            "propertyValue": {"fromConstant": "0002"}
        },
        "uri": "identifier name",
        "host": "hostname and port"
    }

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

The "sourceDataFormat" property specifies the format of the "source_payload" field. You can set this property to any of the following values:

  "params": {
    "sourceDataField": "t2",
    "sourceDataFormat": "JSON",
    "sourceFields": [
      "source_payload"
    ],

The optional "sourceFields" property specifies the fields the FairCom server makes available to the output connector. The server creates a JSON object from the fields you specify, and the output connector uses it as its source data. If "sourceFields" is omitted, set to null or [], the FairCom server defaults to creating a JSON document that contains all fields from the integration table. This default allows the output connector to send data to a device from any field in the table.

An integration table has many fields, such as fields populated by transforms and MQTT. Converting all fields into JSON is slower than converting only the fields needed by the output connector. For example, input connectors and MQTT messages store their data in the source_payload field. You can use "sourceFields": ["source_payload"] to make only the source_payload field available to the output connector.

When you configure an output connector, you add propertyMap objects to the "propertyMapList". Each propertyMap object extracts data from one field and writes that data to the connected device. The value of the "propertyPath" property is a string containing the path of the data. It always starts with a field name in the "sourceFields" property. For example, if "sourceFields" is set to ["pressure"], then you must set "propertyPath" to "pressure" to use the pressure field’s value in your output. If the value you want to extract is a JSON property nested inside a field, you must add its full path to the "propertyPath". For example, if "sourceFields" is set to ["source_payload"] and source payload contains a JSON object with a "temperature" property, then you must set "propertyPath" to "source_payload.temperature".

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

See table name in System limits for table naming requirements and limitations.

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