Work with Parameter Extensions

The Parameter Extension view displays the following information:

• Extension

• Description

• Data Type

• Actual Value Required

• Editable at Runtime

  NOTE: The Group appears as Tabs in the order defined in the Parameter Groups page. The Group appears with an asterisk (*) if you remove the linked group for the selected Parameter from the Parameter Groups view.

You can add a Parameter Extension manually or by exporting and importing. For more information on the export/import process, see Exporting and Importing Parameter Extensions.

To add a Parameter Extension

1. From the Main menu, select Configuration > Parameter Extensions to display the Parameter Extensions details page.

2. Select the Group tab where you want to add an extension and then click the Add button. A new row appears to the selected tab.

3. Enter the Name and Description for the Parameter Extension.
   The name must be unique for that group. You get an error if you enter an existing Parameter Extension name.

   NOTE: The Parameter Extension name can be same as an extension belonging to any group (other than All Groups). For a Parameter Extension belonging to All Groups, the name must be unique across all the groups in the model.

4. Select the Data Type from the drop-down list. The default value for the data type is Boolean. You can select either a built-in data type or the defined list data type in the system.

   NOTE: If you delete a List Data Type from the List Data Types page that is already used to create a Parameter Extension, then the deleted data type will be marked with an asterisk (*) mark in the Parameter Extension view.

5. Click to update the Actual Value Required property of the Parameter Extension. The default value of Actual Value Required property is No.

   NOTE: If the Actual Value Required property is set to Yes for a Parameter Extension then a user must provide a value for the extension before an Ack On Exit capability can be Acknowledged. It means the extension cannot be left blank.

6. Click to update the Editable At Runtime property of the Parameter Extension. The default value of the Editable At Runtime property is No. If you select the Actual Value Required property to Yes, the Editable At Runtime property is also by default updated to Yes and is not editable.

7. Click Update to save the new Parameter Extension.

   NOTE: Addition of new Parameter Extensions causes all Equipment and Formula Templates to be marked for an upgrade.

Editing a Parameter Extension

You can edit any of the following information in the existing Parameter Extension:

• Extension name

• Description

• Data Type

• Actual Value Required

• Editable at Runtime

Any modification to the Data Type deletes the existing Parameter Extension and adds a new Parameter Extension with the same name with the updated data type. As a result of this delete and re-add operation, the IO references and target values in Equipment and Formulas is reset.

Modification to a Data Type also triggers an upgrade for all Equipment and Formula Templates which have the parameters associated with the modified Parameter Extensions.

To change a parameter extensions group, you must delete and re-add the extension.

NOTE: If you change an extension's name, this immediately impacts the system and affects the current execution.

To edit a Parameter Extension

8. From the Main menu, select Configuration > Parameter Extensions to display the Parameter Extensions Details page.

9. Click Edit beside the Parameter Extension you want to change.

10. Make the changes to the Parameter Extension.

11. Click Update to save your changes.

NOTE: You are not notified of a change to the Parameter Extension name.

To delete a Parameter Extension

12. From the Main menu, select Configuration > Parameter Extensions to display the Parameter Extensions Details page.

13. Click Delete beside the Parameter Extension you want to delete. A confirmation message appears.

14. Click Yes.