Contents
Cirrus Link Resources
Cirrus Link Website
Contact Us (Sales/Support)
Forum
Cirrus Link Modules Docs for Ignition 7.9.x
Inductive Resources
Ignition User Manual
Knowledge Base Articles
Inductive University
Forum
The following API calls are available for the MQTT Recorder Module and can be executed within the Ignition Designer Script Console.
APIs
system.cirruslink.recorder.createConfig(type, props) → void
Parameters
String type
The type of configuration to create with valid options:
General
Tables
Map props
Dictionary of properties making up the configuration with the following keys and datatypes:
General
Id (Long)
Enabled (bool)
Datasource (str)
PartitionPeriod (str)
Tables
Id (long)
TableName (str)
Enabled (bool)
RecordType (str)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Return Value
None
system.cirruslink.recorder.readConfig(type) → List
Parameters
String type
The type of configuration to read with valid options:
General
Tables
Return Value
A List of the Dictionaries of properties making up the configurations with the following keys and datatypes:
General
Id (Long)
Enabled (bool)
Datasource (str)
PartitionPeriod (str)
Tables
Id (long)
TableName (str)
Enabled (bool)
RecordType (str)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
system.cirruslink.recorder.updateConfig(type, id, collisionPolicy, props) → void
Parameters
String type
The type of configuration to update with valid options:
General
Tables
Long id
The ID of the record to update
String collisionPolicy
"MergeOverwrite" or "Overwrite"
"MergeOverwrite" will replace the existing properties in the record ID with only those included in the call
"Overwrite" will replace all properties in the record ID with those in the call
Map props
Dictionary of properties making up the configuration with the following keys and datatypes:
General
Id (Long)
Enabled (bool)
Datasource (str)
PartitionPeriod (str)
Tables
Id (long)
TableName (str)
Enabled (bool)
RecordType (str)
GroupId (str)
EdgeNodeId (str)
DeviceId (str)
FilteredProperties (str)
Return value
None
system.cirruslink.recorder.deleteConfig(type, id) → void
Parameters
String type
The type of configuration to delete with valid options:
General
Tables
Long id
The ID of the record to delete
Return value
None