Bulk editing configuration objects > Bulk editing unit modules

Unit module syntax table

The following table shows the available fields and valid field values for unit modules.

Table: Valid Field Values for Unit Modules

Field

Valid Values

Required for Import

description

As many as 255 characters using any keyboard characters. Note that only the first 24 characters appear in faceplates.

No

area

Plant area name may be up to 16 characters long.

Yes

unit_mod_class

Unit class name. The class must already exist in the database.

Yes(1)

unit_mod_name

Unit module name. As many as 16 characters. The string must contain one letter and can include the following: $, -, _.

Yes

work_in_prog

Flag used during configuration to mark a module as being unfinished.

T or F

No

scan_rate

Use Select Entry for list of valid entries.

No

primary_display

The primary control display picture name without extension.

No

detail_display

The detail display picture name without extension.

No

faceplate_display

The faceplate display picture name without extension.

No

equip_id

Equipment ID used by the system to acquire and release resources.

Valid range: 1 to 65535.

No

max_owners

Specifies the number of requesters that can use this resource simultaneously.

No

downstream_unit_selection

How downstream units are selected. Valid values are:

  • no_downstream_units

  • use_all_units

  • use_selected_units

No

downstream_units

Used on class-based unit modules only. All units in the Downstream list must currently exist in the configuration.

No

Parameter List

Depends on subtype.

No

(1) Required only if the unit module is used in a Batch process.