Import/Export Configuration Data¶

You can import or export the following types of configuration data from or into an Excel file:

Tags
Hierarchy
Data Connectors
IO Mappings
Function Block Templates
Events
Aggregate Groups
Flowsheets

Export Configuration Data¶

To export configuration data, follow the steps below:

Choose Configuration ‣ Data Management ‣ Tools ‣ Import/Export Config from the menu.
Go to the Export tab.
Select the types of configuration data that you want to export.
Click Export Configuration Data.

Result

The Excel file is generated and automatically downloaded. You can open the file from your Downloads folder.

Export Logic¶

Configuration data is exported into separate tabs in the Excel file based on the type of data as follows:

Output	Description
Tag Configuration	A single tab page with the list of tags and their properties.
Hierarchy Configuration	A single tab page with the list of tags in the hierarchies and their levels in the hierarchy.
Connector Configuration	A single tab page with the list of data connectors and their properties.
IO Mapping Configuration	A single tab page with the list of IO mappings and their properties.
Function Block Template Configuration	Three tab pages are generated: Function Block Templates: List of function blocks and their properties. Pins: List of pins associated with function block templates. Parameters: List of parameters associated with function block templates.
Event Configuration	Six tab pages are generated: Event Configuration: List of event configurations and their properties. Event Conditionals: List of all conditionals defined for event configurations and their properties. Event Classifications: List of all classifications defined for event configurations. Event Types: List of all event types defined for event configurations. Event Reason Codes: List of all reason codes defined for event configurations. Event Corrective Actions: List of all corrective actions defined for event configurations.
Aggregates Configuration	Two tab pages are generated: Aggregate Groups: List of aggregate groups and their properties. Aggregate Group Tag IOs: List of all input and output tags defined for aggregate groups.
Flowsheet Configuration	A single tab page with the list of flowsheets and their properties.

Import Configuration Data¶

When importing configuration data, you upload an Excel file that contains the data you want to import. Before importing data, ensure that this Excel file has the required format so that the system can interpret the data correctly.

Tip

Use the Download Configuration Template button on the Configuration Template tab to generate an Excel template in a format suitable for importing data and update it as required.

To import configuration data, follow the steps below:

Choose Configuration ‣ Data Management ‣ Tools ‣ Import/Export Config from the menu.
Go to the Import tab.
Select the types of configuration data that you want to import.
Click Choose File, navigate to the file that you want to import and select it for import.
Click Import Configuration Data.

Result

Data from the Excel file is imported and data is updated in the system.

Import Logic¶

During import, configuration data is uploaded and data is updated in the system as follows:

Input	Description
Tag Configuration	Adds tag properties, such as Name, Description, Data Type, Engineering Unit Type, Hosting Data Source, Default Value, Group Name and Property Names. If the tag doesn’t exist in the system, a new one will be created. For existing tags, all configurations will be updated from the file, removing existing properties and groups, and creating new ones based on the uploaded data.
Connector Configuration	Adds data connector properties, such as Connector Name, Description, Mode, Protocol, Location, Allow Write, and Enabled fields. If a connector with the same name doesn’t exist, a new one will be created. If it does exist, the connector will be updated with the information from the Excel file.
IO Mapping Configuration	If an IO Mapping with the same connector, Tag, and External ID exists in the database, the import will update the existing IO Mapping instead of creating a new one. If no matching IO Mapping exists, a new record will be created.
Event Configuration	If an event with the same name doesn’t exist, a new event will be created. If it does exist, the existing event will be updated.
Event Conditionals	When loading event conditionals, all existing conditionals for an event will be deleted, and new ones will be created. The following conditions apply: If Quality flag is true, the Quality value is required. If Use Quality flag is false and Use Tag value is true, the Check Value tag is required. Otherwise, the Check Constant Value and Check Constant Value Unit are required. If the Event Condition Type is ‘Stale’, the Stale Detection Time in Seconds value is required.
Event Classification	If an event classification with the same name exists, a new one will not be created.
Event Type	If an event type with the same name exists, a new one will not be created. Instead, the existing event type will be updated with the information from the Excel file.
Event Reason Codes	If an Event Reason Code with the same name exists, a new one will not be created. Instead, the existing item will be updated with the configuration from the Excel file.
Event Corrective Actions	If an Event Corrective Action with the same name already exists, it will be updated. Otherwise, a new one will be created.
Aggregate Groups	If an Aggregate Group already exists, it will be updated. Otherwise, a new one will be created.
Aggregate Group Tag IOs	When uploading Tag IOs to an Aggregate Group, the existing Tag IOs from the Aggregate Group will be removed, and new ones will be added based on the uploaded data.
Function Block Template	If a Function Block Template with the same name exists, a new one will not be created. Instead, the existing template will be updated with the configuration from the Excel file.
Pins	If a Pin with the same name already exists in the configured Function Block Template, a new one will not be created. Instead, the existing pin will be updated with the configuration from the Excel file.
Parameters	If a Parameter with the same name already exists in the configured Function Block Template, a new one will not be created. Instead, the existing parameter will be updated with the configuration from the Excel file.
Flowsheets	If the Name of the flowsheet already exists, a new flowsheet with the name “{Name}_Copy#” will be created to ensure a unique name. When importing, you can indicate if the import should include mappings and/or templates. Note Ensure that the templates exist in the system. Do not modify the ‘Flowsheet Object n’ columns, as this will corrupt the flowsheet configuration exported by the tool.