Versions Compared

Old Version 29

changes.mady.by.user Gill Houghton

Saved on

compared with

New Version Current

changes.mady.by.user Gill Houghton

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

There are sample API scripts available for each API call.

Warning

Configuration changes made through scripting do not have the same validation as when made through the UI. 

For example, deleting a Sets configuring that is being referenced by a Servers configuration will result in the UI showing an Internal Error. Follow the instructions here to recover the configuration.


APIs

  • Anchor
    publish
    publish
    system.cirruslink.transmission.publish(mqttServerName, topic, payload, qos, retained) → void
    • Parameters
      • String mqttServerName
        • The name of the server connection to use in the MQTT Transmission Server configuration. This must match an existing server name in the configuration.
      • String topic
        • The MQTT topic to publish on. This must be a valid MQTT topic
      • byte[] payload
        • An array of bytes representing the MQTT payload
      • int qos
        • The MQTT 'Quality of Service' to use. This must be either 0, 1, or 2
      • boolean retained
        • Whether or not to publish this message with the retained flag set
    • Return Value
      • None
  • Anchor
    createConfig
    createConfig
    system.cirruslink.transmission.createConfig(type, props) → void
    • Parameters
      • String type

        • The type of configuration to create with valid options:

          • History Stores
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • Records
          • Files
          • UnsTransmitters (added 4.0.25)
          • Records
          • Files
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes:
          • History Stores

            • Id (long)(cannot be null)

            • Name (str)

            • Enabled (bool)

            • TransmissionHistoryStoreType (str) "IN_MEMORY" or "DISK_BACKED"

            • EdgeNodeTagCapacity (int)(deprecated 4.0.19)

            • DeviceTagCapacity (int)(deprecated 4.0.19)

            • HistoryMaxSize (int)(added 4.0.22)
            • HistoryMaxAge (int) (added 4.0.19)

            • FlushQuantity (int)

            • FlushPeriod (long)

            • RollingHistoryBufferEnabled (boo)(added 4.0.17)
            • RollingHistoryMaxAge (int) (added 4.0.17)
            • RollingHistoryPruneInterval (int)(added 4.0.17)
            • H2dbDirectory (str)(added 4.0.25)
            • H2dbPort (int)(added 4.0.22)
          • Cert Files

            • Id (long)(cannot be null)

            • Name (str)

            • FileContents (str)

            • Description (str)

          • Servers

            • Id (long)(cannot be null)

            • Name (str)

            • Url (str)

            • ServerSetId (str) (must be included)

            • Username (str)

            • Password (str)

            • CaCertFileId (long)

            • ClientCertFileId (long)

            • ClientPrivateKeyFileId (long)

            • ClientKeyPassword (str)

            • HostnameVerification (bool)

            • TlsAlpnExtensions (str)

            • ClientId (str)

            • KeepAlive (int)

            • RandomStartupDelay (str)

            • ReconnectDelay (long)

            • DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"

            • AutoReconnectRpcClient RpcClientKeyPassword (boolstr) RpcClientKeyPassword (str) (added 4.0.18)
            • RpcClientEnabled (bool) (added 4.0.18)
            • RpcClientPrivateKeyFileId (long) (added 4.0.18)
            • RpcTlsAlpnExtensions (str) (added 4.0.18)
            • RpcHostnameVerification (bool) (added 4.0.18)
            • RpcUsername (str) (added 4.0.18)
            • RpcClientId (str) (added 4.0.18)
            • RpcClientCertFileId (long) (added 4.0.18)
            • RpcPassword (str) (added 4.0.18)
            • RpcCaCertFileId (long) (added 4.0.18)
          • Sets

            • Id (long)(cannot be null)

            • Name (str)

            • Description (str)

            • PrimaryHostId (str)

            • AutoReconnectRpcClient (bool)
            • RpcClientEnabled (bool) (added 4.0.18)
            • RandomizeServerConnections(bool) (added 4.0.28)
          • Transmitters

            • Id (long)(cannot be null)

            • Name (str)

            • Enabled (bool)

            • TagProvider (str)

            • TagPath (str)

            • TagPacingPeriod (long)

            • ServerSetId (long) (must be included)

            • DiscoveryDelay (long)

            • AliasedTags (bool)

            • CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"

            • BlockCommands (bool)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • CacheBirthsEnabled (bool)

            • HistoryStoreId (long)

            • EnableStoreForwardByDefault (bool)

            • InOrderHistory (bool)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

            • RebirthDebounceDelay (long)

            Records
            • Id RedundancyTransitionActiveDelay (long)TagProvider (str(added 4.0.25)
            • TagFolderPath AlarmJournalName (str)

            • RecordType (long)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • (added 4.0.30)
            • UseCirrusEncoder OverridePublishTag (bool) PublishTagPath (str)EnableSignature (bool)(added 4.0.2030)
            • SignaturePassword ReconciliationWindow (strlong)(added 4.0.2030)HashingAlgorithm (str)
          • UnsTransmitters(added 4.0.20)"SHA_1","SHA_224","SHA_256","SHA_384" or "SHA_512"25)

            • Id (long)(cannot be null)

            • Name

            Files

            • Id (long)

            • TagProvider (str)

            • TagFolderPath (str)

            • EnableAutoPublishing Enabled (bool)

            • FileScanRate TagProvider (intstr)

            • GroupId TagPath (str)

            • EdgeNodeId ServerSetId (strlong) DeviceId (strmust be included)

            • MessageSize DiscoveryDelay (intlong)MessagePacingPeriod

            • PropsQos (int)MessageAckTimeout
            • PropsRetain (bool)
            • DataQos (int)
    • Return Value
      • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
    AnchorreadConfig
            • DataRetain (bool)

            • HistoryStoreId (long)

            • EnableStoreForwardByDefault (bool)

            • SendAllProps (bool)

            • FilteredProperties (str)

            • UseTopicPrefixToken (bool)
            • TagPacingPeriod (long)
            • GroupId (str)(must be unique across this Transmission system)
            • EdgeNodeId (str)(must be unique across this Transmission system)
            • DeviceId (str)(must be unique across this Transmission system)
          • Records

            • Id (long)(cannot be null)

            • TagProvider (str)

            • TagFolderPath (str)

            • RecordType (long)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • OverridePublishTag (bool)

            • PublishTagPath (str)

            • EnableSignature (
    readConfigsystem.cirruslink.transmission.readConfig(type) → List
    • Parameters
      • String type

        • The type of configuration to read with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • Records
          • Files
    • Return Value
      • A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
        • History Stores

          • Id (long)

          • Name (str)

          • Enabled (bool)

          • TransmissionHistoryStoreType (str) "In-Memory" or "Disk-Backed"

          • EdgeNodeTagCapacity (int)(deprecated 4.0.19)

          • DeviceTagCapacity (int)(deprecated 4.0.19)

          • HistoryMaxAge (int)(added 4.0.19)

          • FlushQuantity (int)

          • FlushPeriod (long)

          • RollingHistoryBufferEnabled (
            • bool)(added 4.0.
            17
            • 20)
            RollingHistoryMaxAge
            • SignaturePassword (
            int
            • str)(added 4.0.
            17
            • 20)
            RollingHistoryPruneInterval
            • HashingAlgorithm (
            int
            • str)(added 4.0.
            17)
        • General

          • Id (long)

          • Enabled (bool)

          • AuditProfileRecordId (long)(added 4.0.16)
        • Cert Files

          • Id (long)

          • Name (str)

          • FileContents (str)

          • Description (str)

            • 20)"SHA_1","SHA_224","SHA_256","SHA_384" or "SHA_512"
          • Files

            • Id (long)(cannot be null)

            • TagProvider (str)

            • TagFolderPath (str)

            • EnableAutoPublishing (bool)

            • FileScanRate (int)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • MessageSize (int)

            • MessagePacingPeriod (int)

            • MessageAckTimeout (int)

    • Return Value
      • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
  • Anchor
    readConfig
    readConfig
    system.cirruslink.transmission.readConfig(type) → List
    • Parameters
      • String type

        • The type of configuration to read with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • UnsTransmitters (added 4.0.25)
          • Records
          • Files
    • Return Value
      • A List of Dictionaries of properties making up the configurations with the following keys and datatypes:
        • History Stores

          • Id (long)

          • Name (str)

          • Enabled (bool)

          • TransmissionHistoryStoreType (str) "In-Memory" or "Disk-Backed"

          • EdgeNodeTagCapacity (int)(deprecated 4.0.19)

          • DeviceTagCapacity (int)(deprecated 4.0.19)

          • HistoryMaxSize (int
          Servers

          • Id (long)

          • Name (str)

          • Url (str)

          • ServerSetId (str)

          • Username (str)

          • Password (str)

          • CaCertFileId (long)

          • ClientCertFileId (long)

          • ClientPrivateKeyFileId (long)

          • ClientKeyPassword (str)

          • HostnameVerification (bool)

          • ClientId (str)

          • KeepAlive (int)

          • RandomStartupDelay (str)

          • ReconnectDelay (long)

          • DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"

          • AutoReconnectRpcClient (bool)
          • RpcClientKeyPassword (str) (added 4.0.18)
          • RpcClientEnabled (bool) (added 4.0.18)
          • RpcClientPrivateKeyFileId (long) (added 4.0.18)
          • RpcTlsAlpnExtensions (str)(added 4.0.1822)
          • RpcHostnameVerification HistoryMaxAge (boolint)(added 4.0.1819)

          • FlushQuantity (int)

          • FlushPeriod (long)

          • RpcUsername RollingHistoryBufferEnabled (strbool)(added 4.0.1817)
          • RpcClientId RollingHistoryMaxAge (strint)(added 4.0.1817)
          • RpcClientCertFileId RollingHistoryPruneInterval (longint)(added 4.0.1817)
          • RpcPassword H2dbDirectory (str)(added 4.0.18)25)
          • H2dbPort (int)(added 4.0.22)
        • General

          • Id (long)

          • Enabled (bool)

          • AuditProfileRecordId RpcCaCertFileId (long)(added 4.0.1816)
        • Cert FilesSets

          • Id (long)

          • Name (str)

          • Description FileContents (str)

          • PrimaryHostId Description (str)

        • ServersTransmitters

          • Id (long)

          • Name (str)

          • Enabled Url (boolstr)

          • TagProvider ServerSetId (str)

          • TagPath Username (str)

          • TagPacingPeriod Password (longstr)

          • ServerSetId CaCertFileId (long)

          • DiscoveryDelay ClientCertFileId (long)

          • AliasedTags ClientPrivateKeyFileId (boollong)

          • CompressionTypeWrapper ClientKeyPassword (long) "NONE" "DEFLATE" or "GZIP"str)

          • HostnameVerification BlockCommands (bool)

          • ConvertUdts ClientId (boolstr)

          • PublishUdtDefinitions KeepAlive (boolint)

          • OptimizeUdts RandomStartupDelay (boolstr)

          • CacheBirthsEnabled (bool)

          • HistoryStoreId ReconnectDelay (long)

          • EnableStoreForwardByDefault DataFormatTypeWrapper (bool)

          • InOrderHistory (bool)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • FilteredProperties (str)

          • RebirthDebounceDelay (long)

        • Records

          • Id (long)

          • TagProvider (str)

          • TagFolderPath (str)

          • RecordType (long)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • OverridePublishTag (bool)

          • PublishTagPath (str)

        • Files

          • Id (long)

          • TagProvider (str)

          • TagFolderPath (str)

          • EnableAutoPublishing (bool)

          • FileScanRate (int)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • MessageSize (int)

          • MessagePacingPeriod (int)

          • MessageAckTimeout (int)

    AnchorupdateConfigupdateConfigsystem.cirruslink.transmission.

          • str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"

          • RpcClientKeyPassword (str) (added 4.0.18)
          • RpcClientPrivateKeyFileId (long) (added 4.0.18)
          • RpcTlsAlpnExtensions (str) (added 4.0.18)
          • RpcHostnameVerification (bool) (added 4.0.18)
          • RpcUsername (str) (added 4.0.18)
          • RpcClientId (str) (added 4.0.18)
          • RpcClientCertFileId (long) (added 4.0.18)
          • RpcPassword (str) (added 4.0.18)
          • RpcCaCertFileId (long) (added 4.0.18)
        • Sets

          • Id (long)

          • Name (str)

          • Description (str)

          • PrimaryHostId (str)

          • AutoReconnectRpcClient (bool)
          • RpcClientEnabled (bool) (added 4.0.18)
          • RandomizeServerConnections(bool) (added 4.0.28)
        • Transmitters

          • Id (long)

          • Name (str)

          • Enabled (bool)

          • TagProvider (str)

          • TagPath (str)

          • TagPacingPeriod (long)

          • ServerSetId (long)

          • DiscoveryDelay (long)

          • AliasedTags (bool)

          • CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"

          • BlockCommands (bool)

          • ConvertUdts (bool)

          • PublishUdtDefinitions (bool)

          • OptimizeUdts (bool)

          • CacheBirthsEnabled (bool)

          • HistoryStoreId (long)

          • EnableStoreForwardByDefault (bool)

          • InOrderHistory (bool)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • FilteredProperties (str)

          • RebirthDebounceDelay (long)

          • RedundancyTransitionActiveDelay (long)(added 4.0.25)

          • AlarmJournalName (str)(added 4.0.30)
          • UseCirrusEncoder (bool) (added 4.0.30)
          • ReconciliationWindow (long)(added 4.0.30)
        • UnsTransmitters(added 4.0.25)
    updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • String type

        • The type of configuration to update with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • Records
          • Files
      • 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:
          • History Stores

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • TransmissionHistoryStoreType (str) "IN-MEMORY" or "DISK_BACKED"

            • EdgeNodeTagCapacity (int)(deprecated 4.0.19)

            • DeviceTagCapacity (int)(deprecated 4.0.19)

            • HistoryMaxAge (int)(added 4.0.19)

            • FlushQuantity (int)

            • FlushPeriod (long)

            • RollingHistoryBufferEnabled (bool)(added 4.0.17)
            • RollingHistoryMaxAge (int)(added 4.0.17)
            • RollingHistoryPruneInterval (int)(added 4.0.17)
          • General

            • Id (long)

            • Enabled (bool)

            • AuditProfileRecordId (long)(added 4.0.16)
            • Cert Files

          • Id (long)

          • Name (str)

          • Enabled (bool)

          • TagProvider

            FileContents

            (str)

          • Description

            TagPath (str)

          • ServersId

            ServerSetId (long)

            Name

            (

            str

            must be included)

            Url

          • DiscoveryDelay (

            str

            long)

            ServerSetId
          • PropsQos (strint)Username
          • PropsRetain (strbool)Password (str
          • DataQos (int)
          • DataRetain (bool)
          • CaCertFileId

            HistoryStoreId (long)

            ClientCertFileId

          • EnableStoreForwardByDefault (

            long

            bool)

            ClientPrivateKeyFileId
          • SendAllProps (longbool)
          • ClientKeyPassword

            FilteredProperties (str)

          • HostnameVerification

            UseTopicPrefixToken (bool)

          • TagPacingPeriod (long)
          • ClientId GroupId (str)KeepAlive (int(must be unique across this Transmission system)
          • RandomStartupDelay EdgeNodeId (str)ReconnectDelay (long(must be unique across this Transmission system)
          • DataFormatTypeWrapper DeviceId (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"(must be unique across this Transmission system)
        • Records

          • Id (long)

          • TagProvider (str)

          • TagFolderPath (str)

          • RecordType (long)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • OverridePublishTag (bool)

          • PublishTagPath (str)

          • EnableSignature
          • AutoReconnectRpcClient (bool)
          • RpcClientKeyPassword (str) (added 4.0.18)
          • RpcClientEnabled (bool) (added 4.0.18)
          • RpcClientPrivateKeyFileId (long) (added 4.0.18)
          • RpcTlsAlpnExtensions (str) (added 4.0.18)
            • RpcHostnameVerification (bool)(added 4.0.1820)
          • RpcUsername SignaturePassword (str)(added 4.0.1820)RpcClientId
          • HashingAlgorithm (str)(added 4.0.18)
          • RpcClientCertFileId (long) (added 4.0.18)
          • RpcPassword (str) (added 4.0.18)
          • RpcCaCertFileId (long) (added 4.0.18)
          • Sets

            • Id (long)

            • Name (str)

            • Description (str)

            • PrimaryHostId (str)

          • Transmitters

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • TagProvider (str)

            • TagPath (str)

            • TagPacingPeriod (long)

            • ServerSetId (long)

            • DiscoveryDelay (long)

            • AliasedTags (bool)

            • CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"

            • BlockCommands (bool)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • CacheBirthsEnabled (bool)

            • HistoryStoreId (long)

            • EnableStoreForwardByDefault (bool)

            • InOrderHistory (bool)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

            • RebirthDebounceDelay (long)

          • Records

            • Id (long)

            • TagProvider (str)

            • TagFolderPath (str)

            • RecordType (long)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • OverridePublishTag (bool)

            • PublishTagPath (str)

          • Files

            • Id (long)

            • TagProvider (str)

            • TagFolderPath (str)

            • EnableAutoPublishing (bool)

            • FileScanRate (int)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • MessageSize (int)

            • MessagePacingPeriod (int)

            • MessageAckTimeout (int)

    • Return Value
      • A map representing the updated configuration after it has been written to the database. (added 4.0.16)
    AnchordeleteConfigdeleteConfigsystem.cirruslink.transmission.deleteConfig(type, id) → void
    • Parameters
      • String type

        • The type of configuration to delete with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • Records
          • Files
      • Long id
        • The ID of the record to delete
    • Return Value
      • True if the record is successfully deleted otherwise False is returned (added 4.0.16)

...

          • 20)"SHA_1",SHA_224","SHA_256","SHA_384" or "SHA_512"
        • Files

          • Id (long)

          • TagProvider (str)

          • TagFolderPath (str)

          • EnableAutoPublishing (bool)

          • FileScanRate (int)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • MessageSize (int)

          • MessagePacingPeriod (int)

          • MessageAckTimeout (int)

  • Anchor
    updateConfig
    updateConfig
    system.cirruslink.transmission.updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • String type

        • The type of configuration to update with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • UnsTransmitters
          • Records
          • Files
      • 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:
          • History Stores

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • TransmissionHistoryStoreType (str) "IN-MEMORY" or "DISK_BACKED"

            • EdgeNodeTagCapacity (int)(deprecated 4.0.19)

            • DeviceTagCapacity (int)(deprecated 4.0.19)

            • HistoryMaxSize (int)(added 4.0.22)
            • HistoryMaxAge (int)(added 4.0.19)

            • FlushQuantity (int)

            • FlushPeriod (long)

            • RollingHistoryBufferEnabled (bool)(added 4.0.17)
            • RollingHistoryMaxAge (int)(added 4.0.17)
            • RollingHistoryPruneInterval (int)(added 4.0.17)
            • H2dbDirectory (str)(added 4.0.25)
            • H2dbPort (int)(added 4.0.22)
          • General

            • Id (long)

            • Enabled (bool)

            • AuditProfileRecordId (long)(added 4.0.16)
          • Cert Files

            • Id (long)

            • Name (str)

            • FileContents (str)

            • Description (str)

          • Servers

            • Id (long)

            • Name (str)

            • Url (str)

            • ServerSetId (str)

            • Username (str)

            • Password (str)

            • CaCertFileId (long)

            • ClientCertFileId (long)

            • ClientPrivateKeyFileId (long)

            • ClientKeyPassword (str)

            • HostnameVerification (bool)

            • ClientId (str)

            • KeepAlive (int)

            • RandomStartupDelay (str)

            • ReconnectDelay (long)

            • DataFormatTypeWrapper (str) "Sparkplug_B_v1_0_Protobuf" or "Sparkplug_B_v1_0_JSON"

            • RpcClientKeyPassword (str) (added 4.0.18)
            • RpcClientPrivateKeyFileId (long) (added 4.0.18)
            • RpcTlsAlpnExtensions (str) (added 4.0.18)
            • RpcHostnameVerification (bool) (added 4.0.18)
            • RpcUsername (str) (added 4.0.18)
            • RpcClientId (str) (added 4.0.18)
            • RpcClientCertFileId (long) (added 4.0.18)
            • RpcPassword (str) (added 4.0.18)
            • RpcCaCertFileId (long) (added 4.0.18)
          • Sets

            • Id (long)

            • Name (str)

            • Description (str)

            • PrimaryHostId (str)

            • AutoReconnectRpcClient (bool)
            • RpcClientEnabled (bool) (added 4.0.18)
            • RandomizeServerConnections(bool) (added 4.0.28)
          • Transmitters

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • TagProvider (str)

            • TagPath (str)

            • TagPacingPeriod (long)

            • ServerSetId (long)

            • DiscoveryDelay (long)

            • AliasedTags (bool)

            • CompressionTypeWrapper (long) "NONE" "DEFLATE" or "GZIP"

            • BlockCommands (bool)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • CacheBirthsEnabled (bool)

            • HistoryStoreId (long)

            • EnableStoreForwardByDefault (bool)

            • InOrderHistory (bool)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

            • RebirthDebounceDelay (long)

            • RedundancyTransitionActiveDelay (long)(added 4.0.25)
            • AlarmJournalName (str)(added 4.0.30)
            • UseCirrusEncoder (bool) (added 4.0.30)
            • ReconciliationWindow (long)(added 4.0.30)
          • UnsTransmitters(added 4.0.25)

            • Id (long)

            • Name (str)

            • Enabled (bool)

            • TagProvider (str)

            • TagPath (str)

            • ServerSetId (long) (must be included)

            • DiscoveryDelay (long)

            • PropsQos (int)
            • PropsRetain (bool)
            • DataQos (int)
            • DataRetain (bool)

            • HistoryStoreId (long)

            • EnableStoreForwardByDefault (bool)

            • SendAllProps (bool)

            • FilteredProperties (str)

            • UseTopicPrefixToken (bool)

            • TagPacingPeriod (long)
            • GroupId (str)(must be unique across this Transmission system)
            • EdgeNodeId (str)(must be unique across this Transmission system)
            • DeviceId (str)(must be unique across this Transmission system)
          • Records

            • Id (long)

            • TagProvider (str)

            • TagFolderPath (str)

            • RecordType (long)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • OverridePublishTag (bool)

            • PublishTagPath (str)

            • EnableSignature (bool)(added 4.0.20)
            • SignaturePassword (str)(added 4.0.20)
            • HashingAlgorithm (str)(added 4.0.20)
          • Files

            • Id (long)

            • TagProvider (str)

            • TagFolderPath (str)

            • EnableAutoPublishing (bool)

            • FileScanRate (int)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • MessageSize (int)

            • MessagePacingPeriod (int)

            • MessageAckTimeout (int)

    • Return Value
      • A map representing the updated configuration after it has been written to the database. (added 4.0.16)
  • Anchor
    deleteConfig
    deleteConfig
    system.cirruslink.transmission.deleteConfig(type, id) → void
    • Parameters
      • String type

        • The type of configuration to delete with valid options:

          • History Stores
          • General
          • Cert Files
          • Servers
          • Sets
          • Transmitters
          • Records
          • Files
      • Long id
        • The ID of the record to delete
    • Return Value
      • True if the record is successfully deleted otherwise False is returned (added 4.0.16)


Anchor
SampleScripts
SampleScripts
Sample Script


Warning
Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.


Code Block
languagepy
# Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.

# MQTT Transmission Create Transmitter
# Get the Default Set ID
sets = system.cirruslink.transmission.readConfig("Sets")
for config in sets:
  if config["Name"] == "Default":
    setId = config["Id"]
    logger.debug("New Set ID: " + str(setId))

# Create Transmitter One
transmitterProps = {}
transmitterProps["Name"] = "Custom One"
transmitterProps["Enabled"] = True
transmitterProps["TagProvider"] = "default"
transmitterProps["TagPath"] = ""
transmitterProps["TagPacingPeriod"] = 1000
transmitterProps["ServerSetId"] = setId
transmitterProps["DiscoveryDelay"] = 0
transmitterProps["AliasedTags"] = False
transmitterProps["CompressionTypeWrapper"] = "NONE"
transmitterProps["BlockCommands"] = False
transmitterProps["ConvertUdts"] = True
transmitterProps["PublishUdtDefinitions"] = True
transmitterProps["OptimizeUdts"] = True
transmitterProps["CacheBirthsEnabled"] = False
#transmitterProps["HistoryStore"] = None
transmitterProps["EnableStoreForwardByDefault"] = True
transmitterProps["InOrderHistory"] = False
transmitterProps["GroupId"] = "Test1G"
transmitterProps["EdgeNodeId"] = "Test1E"
transmitterProps["DeviceId"] = None
transmitterProps["FilteredProperties"] = "accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts"
transmitterProps["RebirthDebounceDelay"] = 5000
system.cirruslink.transmission.createConfig("Transmitters", transmitterProps)

# MQTT Transmission Update Existing Transmitter
# Read Config
savedTransmitters = system.cirruslink.transmission.readConfig("Transmitters")
for config in savedTransmitters:
  if config["Name"] == "Custom One":
    logger.info("Transmitter Config: " + str(config))
    customOneId = config["Id"]

# Update Config using MergeOverwrite
transmitterProps = {}
transmitterProps["GroupId"] = "Test2G"
transmitterProps["EdgeNodeId"] = "Test2E"
system.cirruslink.transmission.updateConfig(“Transmitters”, customOneId, “MergeOverwrite”, transmitterProps)

# Update Config using Overwrite
transmitterProps = {}
transmitterProps["Name"] = "Custom One"
transmitterProps["Enabled"] = True
transmitterProps["TagProvider"] = "default"
transmitterProps["TagPath"] = ""
transmitterProps["TagPacingPeriod"] = 1000
transmitterProps["ServerSetId"] = setId
transmitterProps["DiscoveryDelay"] = 0
transmitterProps["AliasedTags"] = False
transmitterProps["CompressionTypeWrapper"] = "NONE"
transmitterProps["BlockCommands"] = False
transmitterProps["ConvertUdts"] = True
transmitterProps["PublishUdtDefinitions"] = True
transmitterProps["OptimizeUdts"] = True
transmitterProps["CacheBirthsEnabled"] = False
#transmitterProps["HistoryStore"] = None
transmitterProps["EnableStoreForwardByDefault"] = True
transmitterProps["InOrderHistory"] = False
transmitterProps["GroupId"] = "Test2G"
transmitterProps["EdgeNodeId"] = "Test2E"
transmitterProps["DeviceId"] = None
transmitterProps["FilteredProperties"] = "accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts"
transmitterProps["RebirthDebounceDelay"] = 5000
system.cirruslink.transmission.updateConfig(“Transmitters”, customOneId, “Overwrite”, transmitterProps)

# Delete Config
system.cirruslink.transmission.deleteConfig("Transmitters", customOneId)

# Disable UNS topic prefix (unsA1.0)
transmitters = system.cirruslink.transmission.readConfig("UnsTransmitters")
name = "UNS Transmitter"
for transmitter in transmitters:
  if transmitter["Name"] == name:
      transmitterId = transmitter["Id"]
transmitterProps = {}
transmitterProps["UseTopicPrefixToken"] = False
system.cirruslink.transmission.updateConfig("UnsTransmitters", transmitterId, "MergeOverwrite", transmitterProps)

...

Warning
Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.
Code Block
languagepy
# Cirrus Link provides these scripts as examples only, they are not supported or guaranteed to meet any particular functionality. Cirrus Link cannot provide any assistance to modify these scripts to meet a particular need.
# MQTT Transmission Create Transmitter
logger = system.util.logger("com.cirruslink.examples.transmitter.customtransmitters")

# Get the Default Set ID
sets = system.cirruslink.transmission.readConfig("Sets")
for config in sets:
  if config["Name"] == "Default":
    setId = config["Id"]
    logger.debug("New Set ID: " + str(setId))

# Create Transmitter One
transmitterProps = {}
transmitterProps["Name"] = "Custom One"
transmitterProps["Enabled"] = True
transmitterProps["TagProvider"] = "default"
transmitterProps["TagPath"] = ""
transmitterProps["TagPacingPeriod"] = 1000
transmitterProps["ServerSetId"] = setId
transmitterProps["DiscoveryDelay"] = 0
transmitterProps["AliasedTags"] = False
transmitterProps["CompressionTypeWrapper"] = "NONE"
transmitterProps["BlockCommands"] = False
transmitterProps["ConvertUdts"] = True
transmitterProps["PublishUdtDefinitions"] = True
transmitterProps["OptimizeUdts"] = True
transmitterProps["CacheBirthsEnabled"] = False
#transmitterProps["HistoryStore"] = None
transmitterProps["EnableStoreForwardByDefault"] = True
transmitterProps["InOrderHistory"] = False
transmitterProps["GroupId"] = "Test1G"
transmitterProps["EdgeNodeId"] = "Test1E"
transmitterProps["DeviceId"] = None
transmitterProps["FilteredProperties"] = "accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts"
transmitterProps["RebirthDebounceDelay"] = 5000
system.cirruslink.transmission.createConfig("Transmitters", transmitterProps)

# Read Config
savedTransmitters = system.cirruslink.transmission.readConfig("Transmitters")
for config in savedTransmitters:
  if config["Name"] == "Custom One":
    logger.info("Transmitter Config: " + str(config))
    customOneId = config["Id"]

# Update Config using MergeOverwrite
transmitterProps = {}
transmitterProps["GroupId"] = "Test2G"
transmitterProps["EdgeNodeId"] = "Test2E"
system.cirruslink.transmission.updateConfig(“Transmitters”, customOneId, “MergeOverwrite”, transmitterProps)

# Update Config using Overwrite
transmitterProps = {}
transmitterProps["Name"] = "Custom One"
transmitterProps["Enabled"] = True
transmitterProps["TagProvider"] = "default"
transmitterProps["TagPath"] = ""
transmitterProps["TagPacingPeriod"] = 1000
transmitterProps["ServerSetId"] = setId
transmitterProps["DiscoveryDelay"] = 0
transmitterProps["AliasedTags"] = False
transmitterProps["CompressionTypeWrapper"] = "NONE"
transmitterProps["BlockCommands"] = False
transmitterProps["ConvertUdts"] = True
transmitterProps["PublishUdtDefinitions"] = True
transmitterProps["OptimizeUdts"] = True
transmitterProps["CacheBirthsEnabled"] = False
#transmitterProps["HistoryStore"] = None
transmitterProps["EnableStoreForwardByDefault"] = True
transmitterProps["InOrderHistory"] = False
transmitterProps["GroupId"] = "Test2G"
transmitterProps["EdgeNodeId"] = "Test2E"
transmitterProps["DeviceId"] = None
transmitterProps["FilteredProperties"] = "accessRights;clampMode;deadband;deadbandMode;formatString;historicalDeadband;historicalDeadbandMode;historicalDeadbandStyle;historyEnabled;historyMaxAge;historyMaxAgeUnits;historyProvider;historySampleRate;historySampleRateUnits;historyTagGroup;historyTimeDeadband;historyTimeDeadbandUnits;opcItemPath;opcServer;permissionModel;rawHigh;rawLow;sampleMode;scaleFactor;scaleMode;scaledHigh;scaledLow;tagGroup;valueSource;expression;expressionType;ConfiguredTagPath;eventScripts;readPermissions;writePermissions;eventScripts"
transmitterProps["RebirthDebounceDelay"] = 5000
system.cirruslink.transmission.updateConfig(“Transmitters”, customOneId, “Overwrite”, transmitterProps)

# Delete Config
system.cirruslink.transmission.deleteConfig("Transmitters", customOneId)