Prerequisites:
The station must be running and opened in
Workbench, with the program module installed on the
Niagara host. The ProgramService should be in the station’s Services folder.
CAUTION: Before using the Batch Editor, always save and backup the station. It is easy to make errors using the Batch Editor, and there is no undo. Therefore in a worst-case scenario, you can always reinstall the saved station from your backup.
Batch Editor changes to any component’s displayNames slot are not possible if that slot has the “Readonly” flag set. If necessary,
clear the “Readonly” flag from the displayNames slot of any component you wish to edit using the Batch Editor. You can do
this either from each individual slot sheet, or else by using the Batch Editor.
Perform the following steps:
- In
Workbench with the station opened, access the Batch Editor (in the Nav tree, expand the Config, Services node and double-click ProgramService).
- Use the Find Objects function and/or drag and drop components with an existing display name that you wish to change to an identical value. Note
all components listed in the view will be changed in an identical manner.
- Click Edit Slot to bring up the popup Edit Slot dialog.
- In the Edit Slot dialog, click the Property field control and select displayNames from the drop-down list.
At least one of the components listed in the Batch Editor must have the “Readonly” flag cleared on its displayNames slot; otherwise displayNames is not available in the list of properties.
The
Edit Slot dialog populates the
New Value field with the value of the
displayNames slot for the
first component listed in the Batch Editor.
NOTE: This does not mean all components listed in the Batch Editor list have identically configured display names. Although if you clicked OK now, the Batch Editor would attempt to make this happen.
- Edit the New Value field in the Edit Slot dialog with the display name value(s) you wish to set in all components listed in the Batch Editor. Use the proper BNameMap
syntax.
You must enter the semi-colon (;) at the end of each value string, which is required even if entering only one key-value pair.
Note that the field editor does not stretch to display all of the text.
- With the New Value field edited to the desired value(s), click OK.
A BatchEditor Results popup replaces the Edit Slot dialog. It lists the edit slot results for each component listed in the Batch Editor.
- Click OK to close the BatchEditor Results dialog and return to the Batch Editor view.
Example batch edit of existing display names
In this example, numeric points named “OccCoolStpt” under the station’s LonNetwork are given a display name change.
- The Find Objects function in the Batch Editor is used to find the target components.
- The Edit Slot button is clicked, and the Edit Slot popup dialog appears.
The displayNames slot is selected in the Property field. Note if all components listed in the Batch Editor have the “Readonly” flag set on their displayNames slot, the Property field is not available in the drop-down list, as shown in the preceding figure.
However, if at least one of the components listed has the “Readonly” flag cleared on its displayNames slot, this slot is available, as shown in the following figure.
The New Value field in the Edit Slot dialog initially reflects the current displayNames slot value in the first component listed in the Batch Editor.
In this case, the value is {override=Override Occ Cool Setpt;}
- The changed value is typed into the New Value field.
Note the field editor does not stretch to display all of the text entered. In this case the new value (to be written to all
components listed in the Batch Editor) is:
{override=Override Occ Cool Setpt;set=Change Occ Cool Stpt;}
- The OK button is clicked in the Edit Slot dialog, which is replaced by the BatchEditor Results popup showing the edit slot results.
In this example with six components originally listed in the Batch Editor, only three components have result lines. This indicates
that the other three (missing) components did not have a displayNames slot. Of the three components acted upon by the Batch Editor, two actually had the slot edit performed, while one component
was skipped because its displayNames slot had its “Readonly” config flag set.