Importing Network Signals and Messages into Capital Dictionary

You can import network signals and messages in XML format into Capital Dictionary.

When doing this there are two types of import:

• Import — Removes all network signal and message data in Capital Dictionary, and replaces it with the signal and message data from the XML file.
• Import Merge — If a message or signal name and revision match in Capital Dictionary and the XML file, its properties in Capital Dictionary are replaced with the properties from the XML file. If there is no match for a message or signal name and revision from the XML file, a new message or signal is created in Capital Dictionary using the values from the XML file. See the Results section below for examples. If a message or signal name and revision exist in Capital Dictionary but have no match in the XML file, the message or signal remains unchanged in Capital Dictionary.

Prerequisites

You must have the user permissions:

• Export & Import System Data
• Object Type Information

The XML file must use a bridgesobjecttypeinfo.xsd schema that is available in the dtd directory of your Capital installation. See "Network Dictionary XML File" for an example.

CAUTION: The XML file must contain all the signals needed for respective messages. If messages refer to missing signals they will be ignored on import.

Procedure

1. In Capital Dictionary, click either the Import or Import Merge action from the dropdown at the top of the user interface. An Open dialog box displays.
2. Navigate to the XML file and click Open.

Results

If you selected the Import action, the import removes all network signal and message data in Capital Dictionary (including relationships between signals and messages), and replaces it with signal and message data from the XML file. No other data is removed or replaced.

If you selected the Import Merge action:

• If there is no match for a message or signal name and revision from the XML file, a new message or signal is created in Capital Dictionary using the values from the XML file.

  For example: Capital Dictionary contains a Signal_1 Revision 2. The XML file contains a Signal_1 Revision 1. After the import, Capital Dictionary contains both a Signal_1 Revision 2 and a Signal_1 Revision 1.

• If a message or signal name and revision match in Capital Dictionary and the XML file, its properties in Capital Dictionary are replaced with the properties from the XML file.

  For example: Capital Dictionary contains a Signal_2 Revision 1 with Short Description "Signal_2 Short Description". The XML file contains a Signal_2 Revision 1 with Short Description "Signal_2 New Description". After the import, Capital Dictionary contains a Signal_2 Revision 1 with Short Description "Signal_2 New Description" — that is, the Short Description from the XML file.

Note: Incoming properties from the XML file completely overwrite the Capital Dictionary database. That is, if incoming messages/signals have no properties but matching ones in Capital Dictionary do, the Capital Dictionary ones are removed.

Incoming associations (relationships between signals and messages) completely overwrite the Capital Dictionary database, except where the incoming signals and messages have no relationships at all defined. In this case, the existing relationships in the Capital Dictionary database remain.

If the import errors (due to an invalid XML file for example), an error displays as a red strip across the Capital Dictionary interface.

Figure 1. Import Error (figure not reproduced)

If the import produces any warnings (such as the same message name and revision), the relevant cells appear as red in Capital Dictionary.

Figure 2. Import Warning (figure not reproduced)

Parent Topic: Export and Import of Network Signals and Messages

---

Capital® Devices™ User Guide, v2018.1s

Unpublished work. © Siemens 2020