Equipment and control module syntax table

To successfully export and import a module⁽¹⁾ it must be based on a template.

Note

If a module is not created from a module template, you must create a template for the module to successfully export and import it with a user-defined format.

Table: Valid Field Values for Equipment and Control 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
node_name	Any valid node name	No
area	Any valid area name. If the area does not exist or is not specified, the module is imported into AREA_A.	No⁽¹⁾
module_name	Module name. As many as 16 characters. The string must contain one letter and can include the following: $, -, _.	Yes
work_in_progress	T or F	No
restore_param_vals	T or F	No
param_download_behavior	Select from list	No
module_type	A string containing any keyboard characters	No
module_subtype	An existing module subtype⁽²⁾	Yes⁽²⁾
scan_rate	0.1 = 100 ms 0.2 = 200 ms 0.5 = 500 ms 1 = 1 second 2 = 2 seconds 5 = 5 seconds 10 = 10 seconds 30 = 30 seconds 60 = 60 seconds	No
primary_display	Any valid picture name	No
detail_display	Any valid picture name	No
faceplate_display	Any valid picture name	No
equip_arbitration	T or F	No⁽³⁾
equip_id	Unique ID between 1 and 65535	No⁽³⁾
max owners	Number of simultaneous users	No⁽³⁾
Parameter List	Depends on subtype	No
Alarms⁽⁴⁾⁽⁵⁾
ALARM_TYPE	Any valid alarm type.	No
PRI	Alarm priority	No
ENAB	Alarm enabled? T or F.	No
INV	Alarm inverted? T or F.	No
ALARM_ATTR	The parameter that the alarm monitors.	No
MSG_PARAM1	Alarm message parameter 1	No
MSG_PARAM2	Alarm message parameter 2	No
SUPPRESS_TIMEOUT	Alarm shelving timeout	No
ALARM_DESCRIPTION	User-configured alarm description. As many as 255 characters (approximately the first 36 characters are visible in the DeltaV alarm banner).	No

⁽¹⁾ The system looks up the correct area on import. If the area cannot be found, the module is imported to AREA_A.

⁽²⁾ This field is required. If you do not provide this field, the system imports an empty module with default parameters. The name in this field must match the name of the module template that the structure of the new module is based on.

⁽³⁾ Applies only to modules used in batch systems.

⁽⁴⁾ Each module alarm has the following fields. In the bulk edit file each field is prepended with the alarm name. For example, ALARM1.ALARM_TYPE.

⁽⁵⁾ The alarm fields also include DeltaV Alarm Help fields that are discussed elsewhere.

⁽¹⁾ Phase logic modules are not supported.

Related information

Bulk editing alarms

Bulk editing alarm help

Alarm types