Tag Providers

Understanding Supported TagProvider Connections

Tag providers in FrameworkX serve as intermediaries between the software and external data sources, facilitating the exchange of data and enabling the software to access, process, and display information from various sources. By configuring and connecting to tag providers, users can efficiently integrate and manage data from different devices, systems, or protocols within the software.

The TagProvider feature is available for the following Communication Protocols:

• AB Rockwell - ControlLogix/CompactLogix Devices.
• OPC UA 
• MQTT SparkPlugB  (watch the video tutorial)

Connection with Remote Systems:

• Tatsoft FrameworX applications 

Integration for data browsing and archiving with Historians:

• CanaryLabs (watch the video tutorial)
• InfluxDB Tag Provider and Historian Integration
• OSIsoft PI Systems
• SQL Databases

TagProvider Configuration

Configuration Workflow

To connect to external data sources to use its data definitions models, follow the steps below:

Step 1: Identify the appropriate tag provider based on the communication protocol of the external data source (e.g., OPC UA, Modbus, Custom).

Step 2: In the software, navigate to the tag provider configuration section and create a new tag provider instance. Provide necessary information such as the provider's name, communication settings, and any required authentication credentials.

Step 3: Configure the tag provider's settings to ensure proper communication with the external data source. This may include specifying the IP address, port number, or other communication parameters specific to the data source or protocol.

Step 4: Test the connection between the tag provider and the external data source. If the connection is successful, the software will be able to access and process the data from the external source.

Step 5: Import the tag definitions from the external data source using the methods described in the previous document (e.g., copy-pasting from other projects or Excel, importing from CSV files, using the Import Tag Wizards, or utilizing the EngWrapper API).

Step 6: Organize and manage the imported tags within the software using features such as Asset Modeling or custom templates.

Conclusion
Integrating external data sources with tag providers in [Software Name] enables users to efficiently manage and process data from various systems within the software. By following the guidelines outlined in this document, users can successfully configure and connect to tag providers, ensuring seamless integration and enhanced software functionality.

Creating a new TagProvider

In your Engineering Environment, navigate to Edit → Tags. You should see a tab called Providers.

Click the Create New TagProvider... button to open a dialog window. Select a Communication Protocol from the list, and define its name.

After you select a Protocol, you will see a configuration table with columns that are similar to the ones in the Channels, Nodes, and Points pages. However, the columns will all be grouped on a single page. For this example, we will use MQTTspB.

The configuration settings are detailed below:

• Name: Name of the provider. This will be used to access elements from this namespace.
• Provider: Communication Protocol of choice.
• Parameters: Char separator for the communication protocol of choice.
• Primary/Backup Station: Connection String information used to establish a communication (same as on Devices → Nodes).
• Access: AccessType for this connection (Read/Write/ReadWrite).
• ReadTime: Read Pooling Rate.
• WriteTime: Write Rate.

The Primary/Backup Station will be configured according to the communication protocol.

For more information, please refer to the specific protocol documentation.

Access Elements in Engineering

Once you finish your configuration and establish a successful connection, you will be able to access the variables from the Device in various places within the Engineering Environment.

Browsing the tags

You can start by clicking on the Object Selection button (1). In the left portion of the popup window, you should see a list of objects from every Project Namespace. Use the name that you defined in the TagProvider configuration (2) to search for the namespace. 

Expand the list so you can see all the variables from that Device. By selecting an element, you can see the current value read from the Device (3).

Directly accessing tags

You can also access your variables directly through their addresses, following the same syntax used in Devices → Points: <ProviderName>.("<Type>:<Address>").

E.g.:

• ControlLogix.("DINT:PROGRAM:MAINPROGRAM.MYDINT")
• ControlLogix.("DINT:MyArray1DimDINT[0]")

You can also add a Remote Tag to your Display. Go to the Draw Environment, select a TextBox element (or any other component/symbol), and add it to your display. Double-click it and add a TextIO Dynamic with the same method as if you were assigning a tag. 

In the ObjectName field, select the Browse button and search for the desired variables. By doing this, you can display the information from the Communication Protocol directly in you Display, without the need to create a Tag and Communication Point.

The expression field will be filled with the syntax: ?TagProviderName?.(”? Address In Provider ?”).

Since the address in the expression is a string, you can assign other Tags or Properties so that it has a Dynamic Configuration.

This feature is not limited to Displays. You can create AlarmItems, store data in Historian Tables, and use this remote variable as a Communication Point to Write Data for a different Protocol.

Working with TagProviders

Using TagProvider on Assets Displays

It is possible to have a full or partial view of the Data Model inside your Project. On Edit → Assets, you can create your own Levels and assign a part of the Device's structure to it from the Namespace discussed in the previous section.

This method allows you to import all your model, or just a piece of it, from the selected node down. The name of the Level in the Asset Tree (in Runtime) can be edited in the Description column.

In your Draw Environment, add the AssetControl component, open its configuration, and uncheck the Show only tags check box.

If you have done everything correctly, your Asset View should look something like this in Runtime.

Troubleshooting and Best Practices

Troubleshooting and Common #Issues

Some common issues that may arise while working with Tag Providers include:

#Inconsistency or missing data from external systems:

When using TagProviders, the software is dependent on the external application to provide and maintain the variables names and their structure. Refer to the TagProvider section of the manual on how to diagnose connections with external systems.

Ensure that the tag provider's configuration settings are correct, and verify the connection with the external data source. Refer to the respective protocol documentation for more information on setup and diagnosing connections with the external systems.

This concept applies to any external data source being used by the system, such as remote SQL databases or custom scripting using external APIs.

#Performance issues:

Optimize the organization of tags, assets, and templates to reduce unnecessary data overhead and improve system performance. Focus on efficient communication settings, appropriate pooling rates, and streamlined tag organization.

Best Practices and #Recommendations

To get the most out of Tag Providers, follow these best practices:

#Proper configuration of Tag Providers:

Ensure that the Tag Providers are correctly configured with the appropriate communication settings, authentication credentials, and any required parameters specific to the external data source or protocol. Refer to the respective protocol documentation for more information on the configuration process.

#Organization of the data structure:

Organize tags into a clear hierarchy, using folders and templates, to make it easier for users to find and understand the information they need. Plan your data structure carefully, considering the relationships between assets, tags, and templates. Leverage templates to create reusable data structures, reducing redundancy and streamlining data management.

#Efficient use of Tag Providers:

Use Tag Providers to integrate external data sources, ensuring a seamless exchange of information between systems. Regularly monitor and report the system performance, and connection status with the external data sources. Implement alarm conditions when critical connections are lost.

#Regular maintenance and monitoring:

Regularly review and update the Tag Providers' configuration settings to ensure their accuracy and relevance. Add specific displays and scripts to your project to monitor the performance and connection status with the external data sources. Implement alarm conditions when critical connections are lost or when inconsistencies arise in the data from external systems.

In this section...