Add New / Edit Parameter window

How do I open the Add New / Edit Parameter window?

Click

on the Parameters
tab toolbar.

In the Parameters
tab, right-click a group name and then click Add New Parameter
.

The settings in the window are functionally grouped. Some settings appear conditionally based on selections made in other settings. This table describes the settings in the Add New / Edit Parameter
window.

Name	Type	Description
01 General
Name	Text entry	The name of the parameter. This is a required field.
Parameter Help	Text entry	Help text to explain the function of the parameter and the result when specific values are entered. Appears at the bottom of the parameter window when the parameter is selected in the Application Code Manager application.
Scope	Dropdown menu	The library object that contains the parameter. The list includes all library objects in the library object tree. The default value is the current library object. Parameters can be moved to a different library object by changing the selection here.
Data Type	Dropdown menu	The data type of the parameter. Options are: Bool (Boolean) String Int (Integer) Real AxisID
02 Reference
Reference Type	Dropdown menu	Determines whether the parameter is accessible to user input as an entry field, is populated automatically by a calculation, or references other parameters. The options are: Immediate: The parameter is accessible to user input as an entry field. Calculated: The parameter is not accessible to user input. The value is set to the name or description of the selected Parameter. Reference: The parameter references an external reference. The parameter and the external reference function as a consumed and a produced tag. The parameter is linked to the external reference after instantiation. The Filter setting can be used to set criteria for the external reference.
These fields appear if Calculated is selected in Reference Type .
Reference Linked Parameter	Dropdown menu	Select the parameter that this parameter is linked to from the list. The list of available parameters is composed of parameters within the library object where the Reference Type is defined as "Reference". This is a required field.
Reference Field	Dropdown menu	Select the field within the parameter that contains the value to use. This is a required field.
Use Custom	Text entry	Specifies a condition which, if true at instantiation, overrides the default and opens the field to user input. The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder.
03 Data
Default Value	Text entry	The default value for the parameter. The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder .
This field appears if String is selected in Data Type and the Reference Type is Immediate .
Max Length	Text entry	The maximum length allowed for the value of the parameter. The length can be entered manually in which case the parameter value will be limited to this number of characters in Application Code Manager . Leave blank to allow any length.
Append	Text entry	A text string that will be added to the end of the value of the parameter.
These fields appear if Integer or Real is selected in Data Type .
Min	Text entry	The minimum value for the parameter. The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder . This is a required field.
Max	Text entry	The maximum value for the parameter. The value can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder . This is a required field.
Engineering Unit	Text entry	A unit of measure added to the value of the parameter to provide additional context.
Invalid	Text entry	An additional condition for validation of parameter values. The condition can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder .
This field appears if Integer is selected in Data Type .
Padding	TRUE-FALSE Dropdown menu	When TRUE is selected, single-digit integer values will be padded with zeros.
This field appears if Integer is selected in the Data Type field and the parameter is being added to a subobject .
AutoIncrement	TRUE-FALSE Dropdown menu	When TRUE is selected, the parameter will be populated automatically and the value incremented every time a new subobject is added to an ACM Project. For example, multiple channel subobjects will be numbered sequentially as they are added.
AutoIncrementOffset	Text entry	When a library object is created, set the offset to increment the autoincrement parameter value.
04 UserInterface
Group	Text entry	The group in the Parameters tab where the parameter will appear. If the value entered matches an existing group name, the parameter will appear in this group. If the value entered does not match an existing group name, a new group will be created.
Filter	Text entry	When Reference has been selected as the Reference Type for the new parameter, use this field to create a filter expression to limit the external references. For example, an input parameter for a valve can be limited to an input channel that is a subobject of a module. The filter expression can be entered manually or generated by the Parameter Filter Builder. Click the ellipsis (...) button next to the field to open the Parameter Filter Builder .
Visible	Text entry	Defines a condition to control whether the parameter is displayed when the library object is added to an ACM Project. The condition can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder .
Disabled	Text entry	Defines a condition that disables the parameter during instantiation. The condition can be entered manually or generated by an expression. Click the ellipsis (...) button next to the field to open the Expression Builder . This field only affects parameters that are included in a subobject.
Read Only	TRUE-FALSE Dropdown menu	Determines whether the user will be able to enter values for the parameter in the ACM application, or only read values that have been generated.
This field appears if Immediate is selected in the Reference Type field and String , Integer , or Real is selected in the Data Type field .
Control Type	Dropdown menu	Determines the mode of user interaction with the parameter. TextBox . The parameter value is directly typed into a text box. DropDownList . The parameter value is selected from a list of possible values.
This field appears if DropDownList is selected in the Control Type field .
Control Values	Text entry	Defines the items included in the dropdown list from which the user can select. Enter the options as a comma-separated string. This is a required field when it appears.

Parameters tab

Provide Feedback

Have questions or feedback about this documentation? Please submit your feedback here.