Customizing the Network Message Columns and Properties Displayed in Capital Dictionary

You can customize the columns displayed for network messages in the Messages pane of Capital Dictionary. By default, the dialog box displays the name, revision, description, and short description for each signal, but you can display other property columns between the Associated Signals column and the User Defined Properties column too.

Procedure

1. Locate a file called messageproperties.json.example in the webclient/configuration/dictionary directory of your Capital installation and rename it to messageproperties.json (that is, remove .example from the name).
2. Determine how you want to edit the columns.

Rename the column header for a default column (Name, Revision, Description, Short Description)

Edit the displayNames section of the file.

For example:

Figure 1. Example Message displayNames section (figure not reproduced)

In this example, the Short Description column displays with the header SD and the Description column displays with the header Desc.

Figure 2. Renamed Columns in Signals Panel (figure not reproduced)

Display additional property columns for the messages between the Associated Signals column and the User Defined Properties Column

You can do this to display properties outside of the User Defined Properties column or to add new properties in Capital Dictionary.

Edit the properties section of the file.

For example:

Figure 3. Example Message properties Section (figure not reproduced)

In this example, PG Definition and Comments property columns display.

Figure 4. Property Columns in Messages Panel (figure not reproduced)

CAUTION: You must ensure that you specify a different SortIndex value for each property column. This controls the order in which they display.

Add a property to the User Defined Properties column for an individual message

1. In the User Defined Properties column, click the icon in the message's row; a Properties screen displays.
2. Scroll to the bottom of the properties list and click Add new property; a row is added to the property list.
3. Specify the property name and value, and click OK.

Remove a property from the User Defined Properties column for an individual message

1. In the User Defined Properties column, click the icon in the message's row; a Properties screen displays.
2. Scroll to the property row that you want to remove, hold your mouse cursor over it.
3. Click Remove property; the row is removed.
4. Click OK.

Results

When you next access Capital Dictionary and expand the Messages panel, the columns display as you have configured them in the file.

CAUTION: You must refresh the browser for your changes to display in the panel.

Parent Topic: Capital Dictionary

Related Topics:

• Managing Capital Dictionary Entries (Signals and Messages)

---

Capital® Devices™ User Guide, v2018.1s

Unpublished work. © Siemens 2020