Versions Compared

Key

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

...

  • Store & Forward Enabled
    • Whether to enable Store & Forward capabilities for this stream
  • Store & Forward Type
    • The type of the Store & Forward mechanism options: In_Memory and Disk_Backed (available in release 4.0.17 and higher)
    • Data stored with an In_Memory Store & Forward will not be persisted across a module configuration change, module disable/enable, module restart or power loss
    • Data stored with a Disk_Backed Store & Forward will persist across a module configuration change, module disable/enable, module restart or power loss
  • Message Capacity - deprecated in 4.0.19
    • The maximum number of messages to store before dropping the oldest historical messages
  • History Max Size
    • The maximum number of megabytes history can use before dropping the data
    • In_Memory Store & Forward will use the Ignition Java Heap memory
  • Max History Age
    • The maximum number of minutes to store history before dropping the data
  • Flush Period
    • The period of time to wait (in milliseconds) between sending when flushing messages
Tip

Prior to release 4.0.22, Disk-Backed History stores are located here ~yourIgnitionInstance\user-lib\cls\data\h2

From release 4.0.22, Disk-Backed History store are located here ~yourIgnitionInstance\data\modules\com.cirrus-link\com.cirruslink.injector.aws.gateway\h2


Advanced

  • Partition Key Count
    • The number of partition keys to use for inserts
  • Partition Key
    • An optional partition key pattern that supports token substitution for the following message fields: ${group}, ${edgenode}, ${device}.  This should only be configured if explicitly defined partition keys are necessary when inserting into the Kinesis Stream.
  • Max Message Size
    • The maximum message size in bytes to send. Generally, this should match the max message size allowed by AWS Kinesis.

...