Script Parameters
Trigger scripts take parameters to promote script reuse, rather than limiting a script by hard-coding values in it.
Parameter lines are placed after the description code block. Commented lines starting with @param define the script parameters. The first word after @param is the field type (String, Boolean, MultiString).
After the field type, the remaining text is the name of the parameter. The parameter name appears on the Parameters tab in the PTC RV&S Administration Client. Commented lines until the next @param or end of comments appear as tooltips for the parameter.
For example, the following script code:
// @param String Priority Field Name
// The name of the field which contains the priority to be escalated.
// The field must be of type integer or a pick field.
where String is the field type and Priority Field Name is the parameter name. Displays a tooltip containing “The name of the field which contains the priority to be escalated. The field must be of type integer or a pick field.” for the Priority Field Name field under the Parameter tab.
Related Topics