Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Home
  • Knowledge base
  • Contact Us
  • Home
  • Configuration in the Web UI
  • Items

Item parameters

Written by Mads Mikkelsen

Updated at September 14th, 2023

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Installation & Technical information
    Introduction SIA Connect Standalone SIA Connect ANY-Ware Cellular & WiFi connectivity
  • Configuration in the Web UI
    Getting started with the UI Connectors Instances Items Mapping Data System Network Tools & Add-ons DigiCert IoT Trust Manager
  • Connectors
    Siemens S7 Azure IoT Ethernet/IP Mitsubishi MELSEC OPC-UA Server SQL MQTT Omron Host Link REST API Omron FINS Keyence Beckhoff TwinCAT BACnet Virtual OPC-UA Client MS SQL File M-Bus Modbus
  • Scripting & Variables
    Data formatting
  • Developers
    API documentation Shadow API
  • Tutorials & Guides
    InfluxDB AWS IoT Core - Amazon Web Services Microsoft Power BI KaaIoT Siemens S7 AVEVA Insight SIA Connect Demo Rack Grafana Azure
  • General
+ More

Table of Contents

Table of Contents Connector parameters Empty parameters General Setup

Articles in this section:

  • Add Items
  • Item parameters
  • Edit items
  • Import & export of items
 

Table of Contents

GeneralSetup

Item parameter contains the configuration and information of how to communicate to a certain destination on a parent instance such as variable, tunnel, backend, plc tag and data point. Each item can be configured to follow some defaults which was set when adding the parent instance such as reading interval and store time but they can also be configured individually.

Connector parameters

For connector specific parameters check out their individually articles under their sections

 

Empty parameters

SIA allows properties not to be filled so ensure that this the case for the given instance. This could for instance be the address or more specific Connector parameters that might be needed to establish proper connection to the instance.

 

General

The general parameters are everything that relates to the instance such as address and description. 


 

Parameter Description
Name Name of the item such as "Bottle counter" if the item describes a variable that counts bottles in factory or "Device-to-cloud" if the item is a tunnel to the cloud.
Unique ID Unique ID (UID) is a unique reference to an item or instance. The UID can be referred to in various places such as parameters, mappings and scripting by calling it by %UID%. E.g. calling the name of an item where BOTTLE_CNT is the UID is done by %BOTTLE_CNT.NAME%.
Description Description of the item. E.g. "Bottle counter for Machine 5" or "Data ingest backend"
Unit Unit of the measured value. E.g. "bottles", "kWh"
Enabled Enable or disable the item
Read write

Defines if the item is a read only, write only or read-write. The user interface will change accordingly for the item reflecting the specific setting.
 

  • Read and write: Allows two ways communication to the item. Both reading and writing
  • Read only: Only reading. This could be to protect against faulty writes or if it is a read only item
  • Write only: Write only. This could for instance be a API backend where you only write data.

 

Setup

The setup parameters are parameters that relates to reading, storage and how SIA should handle it. These parameters will also be used as the default for the items when you are creating items under the instance.

Parameter Description
Mode

Selects what mode the item should use:

  • Gateway: No history for data are stored on SIA
  • Logging: History of data are stored locally on SIA
Read interval

Sets the interval in which SIA Connect should poll for data:

  • Instance Default: Sets the same read interval as the Instance has 
  • Milliseconds: Polling time in milliseconds
  • Seconds: Polling time in seconds
  • Minutes: Polling time in minutes
  • Hours: Polling time in hours
  • Trigger only: Only trigger a read when the item when the item is the receiver in a mapping, and the sender has triggered said mapping
Store time

Store time for the logged data. After the data for the item have been kept in history for the given time it will be deleted.

 

Only applies in Logging mode

Max samples to store

The amount of data samples to store in the history for an item. This is a FIFO buffer, so when the amount is reached the oldest data samples will be deleted.

 

Only applies in Logging mode

Trigger behaviour

The trigger defines when a data sample is triggering the execution of a mapping or when the sample are triggered to be stored in the history.

  • Current: Only the current (latest) value that are read (no logging) 
  • All: All readings and values
  • Changes: A change and variation to a value
  • Deadband: A variation from the latest stored sample within a given interval. The interval can be given in percentage or absolute values. Prepend % to apply the deadband in percentage.
  • Equals: The reading equals a specific value

Only applies for Readable items

Minimum interval A cyclic interval that defines when to update and sample values in case the Trigger behaviour have not triggered an update.
As an example. Trigger behaviour is set to All changes and Minimum interval is set to 2 minutes. If no update on the value have occurred in the 2 minutes the system will force a update of the value each 2 minute or 2 minutes after the latest trigger have occurred.
Input template

When data is written to the item, the input template is applied to the raw data.

This is used when creating payloads or insert statements with SIA Connect scripting variables

Post-processing The readings of data samples can processed afterwards to apply logic or math. The post-processing can be used to scale the values or apply logic operations through scripting in JavaScript syntax.

Please refer to Use post-processing of samples‍ for further information and examples

 

element data item stats

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • Add Items
  • Edit items
  • Import & export of items

0
0
Expand