Troubleshooting batch edited display names

Using the Batch Editor for adjusting display names can save time; however, it easy to overlook some things that prevent success. This section lists some common pitfalls and recommendations when using this method.

Key concepts

Keep in mind the following when using the Batch Editor:

  • The Batch Editor runs against all listed objects in the view when you select an action, whether or not any appear selected (highlighted). Therefore, be sure to select and remove any unwanted objects in the view before running any action.
  • Display names are stored on the parent of the target slot or component.
  • The “BNameMap” value of the parent’s displayNames slot (if present) contains all explicitly assigned display names for child slots or components. Editing from the Batch Editor replaces this entire value with your new value—it does not “append” to any existing value.
  • If batch editing display names that were originally manually set, the corresponding displayNames slot is likely to have its “Readonly” config flag set. This prevents any batch edit operation on it. In this case, use the Batch Editor to edit slot flags on the displayNames slot (clear the “Readonly” flag).

Common pitfalls

The following are some common pitfalls when using the Batch Editor against display names:

  • Added displayNames values appear to be added without errors; however the target slots do not appear to have the display name values.

    This can happen when “automatic display name” values are entered in BNameMap “key value” pairs, instead of actual slot names. For example, entering:{Set=Change Setpoint;} instead of {set=Change Setpoint;}. In this case a batch edit would run without errors, and a displayNames slot would be created. However, none of the set slots would have their display name value bolded (changed). See BNameMap syntax.

  • Omitting the ending semi-colon after each BNameMap “key-value” pair of a displayNames slot. This is required even if only one pair (display name) is entered.
  • Entering the slot to be added in the Batch Editor as displayName instead of displayNames. The Batch Editor looks specifically for a displayNames slot, and if misspelled without the trailing “s”, display names are not affected.