Add Tags
You can add tags to connected devices by navigating to DeviceHub > Tags.
To learn more about the list of registers for specific devices, visit the Industrial Systems Connection Guide.
You can add tags as follows:
- Add a tag: Adds a single tag for the selected device.
- Multiple tags in a CSV file: Uploads a list of tags from a CSV file.
- Browse Tags: Search for pre-defined device tags and select the ones to add. See Search for Pre-defined Device Tags to learn more.
Before You Begin
Before creating tags, make sure you have connected a device. Refer to Connect a Device.
Important
Refer to the following information on Free Tags and OPC UA Drivers:
- Certain device drivers do not have a list of register names in the Add Tag form. These are referred to as Free Tags.
- You must enter case-sensitive register names exactly how they are defined in the device.
- Devices do not display a Connected status until a tag with a correct register name is created. See Device Connectivity Issues for more information.
- For OPC UA, map the OPC server tags to the client. Enter the Register Name using this format where the semicolon is required: ns=1;s=tagname . For example: ns=2;s=Channel1.Device1.Tag1.
Add an Individual Tag
You can manually add individual tags to a device.
To add a tag for a single register:
- Navigate to DeviceHub > Tags.
- From the Tags pane, click Add Tag, and then select Add Tag. The Add Tag dialog box appears.
- Click the Select a Device field, and then select an option from the drop-down list. Only devices that had been added to Belden Horizon Data Operations appear in the drop-down list. The fields displayed in the Add Tag dialog box depend on the device driver type.
- From the Add Tag dialog box, complete the parameters for the tag. Refer to the Industrial Systems Connection Guide for parameters specific to your device driver and review the Tag Parameters section.
- The following optional parameters apply to all device drivers. Configure them as needed.
- Tag Formula: Enter a formula for the tag to process the generated data. See Tag Formula Variables to learn more. Two variables are permitted: value (current tag value) and timestamp (current tag UNIX time in milliseconds). The following math functions are available:
- sin
- cos
- tan
- sqrt
- power: power(x) performs the operation 10^x.
- log: log(x) is the natural logarithm (the logarithm is in base e).
- exp: exp(x) performs the operation e^x.
- For additional functions on tag values such as rounding and data conversions, you can use Analytics or the Flows Manager.
- Only Publish on Change of Value: Select the checkbox to customize NATS messages to be published only when the value parameter changes from a previous value to a new one. Change of Value only applies to boolean, numeric (such as int or float), and simple string data types. It does not apply to complex types, such as JSON or array. Poll-once topics will not be affected by Change of Value settings. These topics will still only see a single message.
- Meta Data: Metadata summarizes basic information about data. This feature allows you to define key-value pair data for the device output payload later on. It can then be used to find, use, and reuse particular instances of data. See Organize Device and Tag by Using Metadata to learn more.
- When done configuring the tag, click Add Tag.
The tag appears in the Tags pane.
Add Multiple Tags
You can add multiple tags at once by downloading a CSV template file, filling out the file with tag details and additional tag fields as needed, and then uploading the CSV file.
Important: When saving the CSV file, you must ensure that commas are used as column delimiters and not semicolons. If semicolons are used as column delimiters, you won't be able to upload the CSV file successfully. See DeviceHub Troubleshooting to learn more.
Step 1: Download a Sample CSV Template
You will need to download a template CSV file that has the required fields for the tags you will add.
To download a sample CSV template:
- From the Tags pane, click the Help icon.
- Select Sample CSV Template. The sample Tags CSV is downloaded to your local drive.
Step 2: Populate the CSV Template File
You can now populate the CSV template with the tags that will be added. A row/record for each tag must be populated with attribute values, as described below. The order of the attribute columns in the template file may be in any order.
Refer to the following sections for information on populating the CSV template file.
Example of a Tag CSV File
deviceId | deviceName | driverName | name | tagName | description | valueType | registerID | publishCov | tagFormula | metaData | pollingInterval |
|---|---|---|---|---|---|---|---|---|---|---|---|
A581B3E2-12CC-4A69-92C0-2C09DAFC5148 | Test_Device | AB CompactLogix Ethernet FreeTag | TestRegisterName | TestTagName | SampleDescription | bool | | TRUE | value+timestamp+100 | {"MetaDataKey1":"MetaDataValue1"} | 1 |
Tag Attribute Rules
- The deviceName is required to find the corresponding device. The deviceId can be omitted. If the deviceId is not included, a device name not found error displays, but the tags will still be successfully added.
- Attribute values are required unless noted as optional.
- If an optional value is null, it is ignored. This allows for the loading of register definitions for multiple device types from a single file.
- If the value is null and the device driver defines it as mandatory, the tag is not imported.
- If an optional value is present in the CSV file, but it is not supported by the device driver, it is treated as an error and the tag is not imported.
- Attribute columns in the CSV can be in any order.
Attribute Name | Data Type | Description | Required | Notes |
|---|---|---|---|---|
deviceId | string | ID of the device. You can get this value from the device tile in DeviceHub > Devices. | No | Get this value from the Copy icon next to the device ID in the device tile in DeviceHub > Devices. If a device identified by the deviceId is not found, deviceName is used. |
deviceName | string | The name you configure for the device. | Yes | |
driverName | string | Driver name is for validating optional attributes against registration.json. This type should directly correspond to the name of the driver package. | No | Get this value from the Copy icon next to the driver name in the device tile in DeviceHub > Devices. |
name | string | PLC register name or full PLC register address. | Yes | Depends on valueType This name is case sensitive. |
tagName | string | The name you configure for the tag. | Yes | |
description | string | The description you configure for the tag. | No | |
valueType | string | Type of the register value. | Yes | The list of available selection depends on the Register Table of the device. Examples: bit, word |
registerID | string | A unique register Id generated for this tag | No | This should be left blank as this value is generated when the tag is created. |
publishCoV | boolean | A flag that indicates whether the Only Publish on Change of Value setting is enabled. | No | If left bank, the value FALSE is set by default. |
tagFormula | string | A formula that will transform the tag payload value to a new final value. | No | This column will be empty if there is no formula entered. Available parameters for the formula are as follows:
Available math functions
Example formula: sin(value) + 1 For additional functions on tag values such as rounding and data conversions, you can use Analytics or the Flows Manager. See Analytics Guides and Flows Guides to learn more. |
metaData | string | A JSON-formatted string containing one or more Metadata key-value pairs | No | |
pollingInterval | float | Polling interval in seconds | No | How often the tag will poll the driver for a value. 0 means auto polling disabled. 1 means poll every 1 second. If left blank, a value of 1 is set. |
CSV Formatting and Escaping Rules
Because CSV format is not standardized, several different methods could be used for escaping special characters. And, depending on locality, a different value separator may be used. For example, in European countries, a semi-colon is widely used as a separator. The Belden Horizon Data Operations CSV specification adheres to the rules used by Microsoft Excel, as listed below:
- Field separators can be comma (,), semicolon (;), or tab (\t).
- Fields can have white spaces around them. This space is removed during processing.
- Fields can be escaped with double quotes (") or single quotes ('). Leading or trailing white spaces inside the quotes are preserved.
- Any separator characters within a quoted field is treated as part of the field value.
- Any quotation character in a field value must be escaped with a backslash (\) character.
- Fields are parsed based on their data type: string values are read "as is" and numeric values are parsed with a numeric parser.
- Empty fields are treated as null values.
Step 3: Upload Populated CSV File of Tags
Once the CSV template file is populated, you can upload it to add all tags that were added to the file.
To upload a populated CSV file:
- From the Tags pane, click Add Tag, and then select Upload CSV. The Upload Tags dialog box appears.
- Click Select CSV.
- Select the file to upload and click Open.
- From the Upload Tags dialog box, click Upload. Upon a successful upload, the tags appear in the Tags pane. If the details in the CSV file do not match the expected configuration, error messages indicate the issues.
Search for Pre-defined Device Tags
Some DeviceHub devices give you the option of searching, selecting, and downloading pre-defined device tags.
Devices that support searching for device tags display a tag icon in the top-right corner of the device card.
There are two ways to search for device tags:
Note: The Server Search option is available for Belden Horizon Data Operations version 3.5.2 and later.
- Use Browse Tags to view all available tags for a device. You can then select and download tags applicable for your DeviceHub device.
- Use Server Search to search for device tags. You will need to know the name of the tags you want to search for and add to your DeviceHub device.