Data Server Editor Information

Data Server Editor Tables

The following tables correspond to the Data Server Editor.

Data Server Editor

Item	Description
New Device	Adds a new I/O device.
Delete Device	Deletes the selected device or station.
Copy Device	Copies the selected device’s content to the clipboard.
Paste Device	Pastes the selected device's content from the clipboard.
Expand All	Shows all dropdown content within the Data Server Editor window.
Collapse All	Hides all dropdown content within the Data Server Editor window.
Collapse	Collapses the selected tree from Ethernet Device or Serial Device.
Expand	Expands the selected tree from Ethernet Device or Serial Device.
Ethernet Device	Lists all created Ethernet devices under a dropdown.
Serial Device	Lists all created serial devices and their stations under a dropdown.
Certificates Editor	Opens the Certificates Editor to manage Key Pairs and Trust Stores.
MQTT Payload Editor	Opens the MQTT Payload Editor to manage MQTT payload settings.
OK	Closes the I/O Device Editor window.

Add New Server Device

Item	Description
Connection Type	Select between Ethernet or Serial to determine the type of link between the HMI project and an external device.
Device Name	Assigns a name to the user’s device.
Device Type	Assigns a protocol to communicate over for the I/O device.

General

Item	Description	Note
Device Name	Assigns a name to the device.
Device Protocol	Assigns a protocol to communicate over for the I/O device.	Options: EtherNet/IP Server MQTT JSON Publisher Modbus TCP OPC UA Server Sparkplug Edge Node
Use All Tags	Specifies if the server will use all tags or a tag list.	MQTT JSON Publisher and OPC UA Server only.
Server Name	Specifies the OPC UA server's name. This will be appended to the server's URL.	OPC UA Server only.
Application URI	Specifies the OPC UA server's application URI, which is used for certificate validation.	OPC UA Server only.
Application Name	Specifies the OPC UA server's application name, which is used for discovery.	OPC UA Server only.

EtherNet/IP Server

The following tables relate to the EtherNet/IP data server.

Device Setting

The following tables relate to the EtherNet/IP Device Setting tab.

Ethernet

Item	Description	Note
Port	The port which the server will be listening on.	Default: 44818

EtherNet/IP

Item	Description	Note
String Encoding	Sets the encoding method for reading and writing Strings stored on a device.	Options: ASCII ISO-8859-1 Latin1 Windows-1252 Windows-949 CP949 Shift_JIS GBK UTF-8
String Encoding Method	Sets the method for gateway to handle invalid characters.	Replace: replace any invalid characters within the String with "?". Skip: skip the invalid character and continue with the next one. Reject: reject the invalid character.

Logix Tag

The following tables relate to the EtherNet/IP Logix Tag tab.

Item	Description
New Tag	Opens the New Tag window.
Edit Tag	Edit the selected tag.
Delete Tag	Delete the selected tag.
Tag	The current tag names.
Alias	The alternate tag name.

New Tag

Item	Description
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Tag	The bound tag.
Address	The bound I/O address.
Alias	The alternative name to the bound tag or address.

Assembly Tag

The following tables relate to the EtherNet/IP Assembly Tag tab.

Item	Description
New Assembly Instance	Opens the New Assembly Instance window.
New Tag	Opens the New Tag window.
Edit Assembly Instance	Edit the selected assembly instance.
Delete Assembly Instance	Delete the selected assembly instance.
Export EDS File	Export the current assembly instance into an EDS file.
Address	Displays the current assembly instance.
Tag	Displays the tags bound to the assembly instance.

New Assembly Instance

Item	Description
Assembly Instance Number	Specifies the assembly instance number.
Data Size (Bytes)	Specifies the data size in Bytes.

New Tag

Item	Description
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Tag	The bound tag.
Address	The bound I/O address.
Assembly Instance Number	The current assembly instance number.
Byte Index	The current Byte index number.
Bit Index	The current Bit index number.

MQTT JSON Publisher

The following tables relate to the MQTT JSON Publisher data server.

Device Setting

The following tables relate to the MQTT JSON Publisher Device Setting tab.

MQTT

Item	Description	Note
Broker Address	The address of the MQTT broker.	Can be a URL or IP address. Must be unique across all client I/O devices in the project.
Port	The port which the MQTT broker is listening on.	Default: 1883
Client ID	The client ID used when connecting to the broker.	Should be unique to the broker.
Use Clean Session	Specifies whether the client should connect to the broker with the clean session flag set.
Keep Alive (s)	The keepalive time, in seconds, used by the MQTT client.
Use SSL	Specifies whether the SSL authentication is needed when connecting to the broker.
Key Pair	The UUID of the Key Pair which will be used when connecting to the broker.	Use SSL must be set to true.
Trust Store	The UUID of the Trust Store which will be used when connecting to the broker.	Use SSL must be set to true.
Use MQTT Passwords	Specifies whether the SSL authentication will be needed to connect to the broker.
MQTT Username	The username to be used when connecting to the broker.	Use MQTT Passwords must be set to true.
MQTT Password	The password to be used when connecting to the broker.	Use MQTT Passwords must be set to true.

MQTT Message Queue

Item	Description	Note
Use Message Queue	Specifies whether the client should use a message queue.	This will store messages while the client is disconnected.
Message Queue Size	Specifies the maximum number of messages to be held in the message queue.	Default: 1,000 Minimum: 20 Maximum: 10,000
Message Queue Publish Rate Limit	Specifies the minimum time between publishes, with 0 being as fast as possible.	Default: 0 Minimum: 0 Maximum: 10,000
Use Message Queue Age Limit	Specifies whether the publisher will impose an age limit on queued messages.
Message Queue Age Limits (s)	Specifies the maximum age, in seconds, of a message that will be published. Older messages will be discarded.	Default: 600 Minimum: 10 Maximum: 2,592,000

Running Mode

Item	Description	Note
Running Mode	Specifies the trigger used by the server for publishing values.	Options: On Scan All On Scan Delta On Change Any
Polling Rate (ms)	Specifies the polling rate used by the server for On Scan running modes.	On Scan All or On Scan Delta must be selected.

Payload Info

Item	Description	Note
Publish Payload Format	Sets the format being used for published payloads.	Default: Single No Wrap Basic
Publish QOS	The QoS used when publishing messages.	Options: Zero 1 2
Publish Retain Messages	Specifies whether published messages should be retained.
Publish Topic Prefix	Prefix appended to the topic name.
Publish Topic Suffix	Suffix appended to the topic name.
Access Type	Specifies whether the publisher will also handle subscriptions for write requests.	Options: Publish/Subscribe Publish Only
Subscribe Payload Format	Sets the format expected for subscribed payloads.	Default: Single No Wrap Basic
Subscribe QOS	The QoS used when subscribing to messages.	Options: Zero 1 2
Subscribe Tag Identifier Type	Specifies how to identify the tag(s) a write request is for.	Options: Topic Payload
Subscribe Clamp Method	Specifies how a provided value will handle conversion to the tag's data type.	Options: Reject Clamp Overflow
Subscribe Topic Prefix	Prefix appended to the topic name.
Subscribe Topic Suffix	Suffix appended to the topic name.

Device Tag

The following tables relate to the EtherNet/IP Logix Tag tab.

Item	Description
New Tag	Opens the New Tag window.
Edit Tag	Edit the selected tag.
Delete Tag	Delete the selected tag.
Tag	The current tag names.
Access Type	The access type bound to the tag.

New Tag

Item	Description	Note
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Tag	The bound tag.
Address	The bound I/O address.
Access Type	Specifies whether the publisher will also handle subscriptions for write requests.	Options: Publish/Subscribe Publish Only
Publish ID	The publish identifier.
Publish Topic	The topic to publish to.
Subscribe ID	The subscribe identifier.
Subscribe To...	The topic to subscribe to.

Modbus TCP

The following tables relate to the Modbus TCP data server.

Device Setting

The following tables relate to the Modbus TCP Device Setting tab.

Ethernet

Item	Description	Note
Port	The port which the server will be listening on.	Default: 502

Modbus

Item	Description	Note
Unit ID	The unit identifier of the server.
String Encoding	Sets the encoding method for reading and writing Strings stored on a device. This setting can be overwritten for tags in the Edit Tag menu.	Options: ASCII ISO-8859-1 Latin1 Windows-1252 Windows-949 CP949 Shift_JIS GBK UTF-8
String Encoding Method	Sets the method for gateway to handle invalid characters.	Replace: replace any invalid characters within the String with "?". Skip: skip the invalid character and continue with the next one. Reject: reject the invalid character.

Device Tag

The following tables relate to the Modbus TCP Device Tag tab.

Device Tag

Item	Description
New Tag	Opens the New Tag window.
Edit Tag	Edit the selected tag.
Delete Tag	Delete the selected tag.
Address	The current addresses for each Modbus register.
Tag	The current tag names.

New Tag

Item	Description	Note
Tag Type	The type of tag.	Options: 0: Coil 1: Discrete Input 3: Input 4: Holding
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Tag	The bound tag.
Address	The bound I/O address.
Register	The corresponding Modbus register.

OPC UA Server

The following tables relate to the OPC UA Server data server.

Device Setting

The following tables relate to the OPC UA Server Device Setting tab.

Ethernet

Item	Description	Note
Port	The port which the server will be listening on.	Default: 4840

Encryption

Item	Description	Note
Enable Encryption	Specifies whether encryption support will be enabled.	Requires users to upload a certificate.
Generate Certificate	Specifies whether gateway will automatically generate a certificate for the server or if the server will use certificates provided by the user.
Key Pair	The UUID of the Key Pair uploaded by the user.
Trust All Certificates	Specifies whether a Trust Store will be used for certificate validation or if all certificates will automatically be trusted.
Trust Store	The UUID of the Trust Store uploaded by the user.

Encryption - Allowed Client Security Policies

Item	Description	Note
Require Encryption	Specifies whether encryption is required or not.
Basic 128 RSA-15	Specifies whether the Basic128Rsa15 security policy will be enabled.	Options: Disabled Signed Signed and Encrypt Both
Basic 256	Specifies whether the Basic256 security policy will be enabled.	Options: Disabled Signed Signed and Encrypt Both
Basic 256 SHA-256	Specifies whether the Basic256Sha256 security policy will be enabled.	Options: Disabled Signed Signed and Encrypt Both
AES-128 SHA-256 RSA-OAEP	Specifies whether the Aes128_Sha256_RsaOaep security policy will be enabled.	Options: Disabled Signed Signed and Encrypt Both

Authentication - Anonymous

Item	Description
Allow Anonymous Authentication	Specifies whether anonymous authentication is allowed by the server.
Allow Anonymous Browse	Specifies whether clients using anonymous authentication can browse nodes on the server.
Allow Anonymous Read	Specifies whether clients using anonymous authentication can read from nodes on the server.
Allow Anonymous Write	Specifies whether clients using anonymous authentication can write to nodes on the server.

Authentication - Users

Item	Description
Allow Username Authentication	Specifies whether username/password authentication is allowed by the server.
Add New User	Adds a new user to the access the server.
Username	Username of the newly added user.
Password	Password of the newly added user.
Allow Browse	Specifies whether the current user can browse nodes on the server.
Allow Read	Specifies whether the current user can read from nodes on the server.
Allow Write	Specifies whether the current user can write to nodes on the server.

Authentication - Certificates

Item	Description
Allow Certificate Authentication	Specifies whether certificate authentication is allowed by the server.
Allow Certificate Browse	Specifies whether clients using certificate authentication can browse nodes on the server.
Allow Certificate Read	Specifies whether clients using certificate authentication can read from nodes on the server.
Allow Certificate Write	Specifies whether clients using certificate authentication can write to nodes on the server.

Authentication - Policies

Item	Description	Note
Match Endpoint Security Policy	Specifies whether the authorization tokens should be encrypted using the same security policy as the endpoint they are attached to.
Allow Unencrypted Authentication	Specifies whether the server will use the None policy for the None endpoint or use all other policies instead.
Authentication Security Policy	Specifies whether the security policy is used for all authorization tokens.	Options: None Basic128Rsa15 Basic256 Basic256Sha256 Aes128_Sha256_RsaOaep

Tag Options

Item	Description	Note
Server Layout	Specifies the layout used to allocate and organize nodes on the server.	Options: Basic Device
Default Allow Read	Specifies whether the created nodes will allow read access by default.
Default Allow Write	Specifies whether the created nodes will allow write access by default.

Device Tag

The following tables relate to the OPC UA Server Device Tag tab.

Item	Description
New Tag	Opens the New Tag window.
Edit Tag	Edit the selected tag.
Delete Tag	Delete the selected tag.
Tag	The current tag names.
Browse Name	The current browse names.

New Tag

Item	Description	Note
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Browse Name	The browse name bound to the tag.
Allow Read	The read pattern on the server.	Options: Use Server Default True False
Allow Write	The write pattern on the server.	Options: Use Server Default True False

Sparkplug Edge Node

The following tables relate to the Sparkplug Edge Node data server.

Device Setting

The following tables relate to the Sparkplug Edge Node Device Setting tab.

MQTT

Item	Description	Note
Broker Address	The address of the MQTT broker.	Can be a URL or IP address. Must be unique across all client I/O devices in the project.
Port	The port which the MQTT broker is listening on.	Default: 1883
Client ID	The client ID used when connecting to the broker.	Should be unique to the broker.
Use Clean Session	Specifies whether the client should connect to the broker with the clean session flag set.
Keep Alive (s)	The keepalive time, in seconds, used by the MQTT client.
Use SSL	Specifies whether the SSL authentication is needed when connecting to the broker.
Key Pair	The UUID of the Key Pair which will be used when connecting to the broker.	Use SSL must be set to true.
Trust Store	The UUID of the Trust Store which will be used when connecting to the broker.	Use SSL must be set to true.
Use MQTT Passwords	Specifies whether the SSL authentication will be needed to connect to the broker.
MQTT Username	The username to be used when connecting to the broker.	Use MQTT Passwords must be set to true.
MQTT Password	The password to be used when connecting to the broker.	Use MQTT Passwords must be set to true.

Sparkplug

Item	Description
Group ID	Part of the ID of the Sparkplug Edge node used in the MQTT topic of every message.
EoN ID	Part of the ID of the Sparkplug Edge node used in the MQTT topic of every message.
Use Primary Host Application	When enabled, the Sparkplug Edge Node will not publish a BIRTH message until it receives an online STATE message from the PHA.
Primary Host Application	Host Application ID of the Primary Host Application.
Use Metric Aliasing	Makes the communication more efficient by assigning a unique alias number to each metric.
Use All Devices	Use all devices and all tags.

Device Tag

The following tables relate to the Sparkplug Edge Node Device Tag tab.

Item	Description
New Device	Opens the New Device window.
New Tag	Opens the New Tag window.
Edit Tag	Edit the selected tag.
Delete Tag	Delete the selected tag.
Device	The current I/O devices.
Identifier	The current I/O device identifiers.

New Device

Item	Description
Device	The list of created I/O devices.
Identifier	The identifier name to bind to the I/O device.
Use All Tags	Specifies if the server will use all tags or a tag list.

New Tag

Item	Description
Device	The list of created I/O devices.
Tag/Address	Toggle to bind an I/O address.
Tag/Address	Toggle to bind a tag.
Select a Tag...	Select a tag to bind.
Identifier	The identifier name to bind to the tag.