When you create a custom menu that contains pick actions, each action is associated with a parameter. The parameter defines the database item, script, registry key, and so on to which the action relates. For example, if a custom menu has a hyperlink action, that action can have a parameter that specifies the location of the ‘target’ display. However, there is a limitation with this as the parameter for the action is 'fixed', that is, it can only reference a specific database item, location, registry key, script and so on.
By using the Animate Parameter setting, you can set the parameter of a pick action to reference a Mimic parameter instead of a 'fixed' value. For example, instead of a hyperlink action referencing the Form of a specific database item, it can reference a Mimic parameter. The Mimic parameter can then be associated with the Form of any database item. The value that is used as the source of the Mimic parameter will be the value that is used as the value for the pick action’s parameter.
Take care not to confuse Mimic parameters with pick action parameters. A Mimic parameter is a custom property that can be animated when the Mimic is embedded, whereas a pick action parameter is the entry that associates a custom action with a database item, location, script, registry key, and so on. So a Mimic parameter can be used as the value for the parameter of a pick action.
A common use of the Animate Parameter feature is to allow a Mimic that contains a custom menu to be embedded on other Mimics, with each embedded Mimic having pick actions that are associated with different database items. For a detailed example, see Using Custom Menu Options on a Symbol to Write Values to a Point.
To configure a custom action so that it is associated with a Mimic parameter instead of a specific database item:
- Create a parameter for the Mimic that contains (or is to contain) the custom pick action menu (see Adding a Mimic Parameter).
- Display the Pick Menu window (see Using the Pick Menu Window)
- Either create a new action or edit an existing action (see Add a Custom Pick Action or see Edit a Pick Action Menu Option).
The Pick Action Wizard is displayed. - On the first page of the Pick Action Wizard, select the button for the type of action you want to create and then select the Animate Parameter check box. The options for the types of action are the same as those that are available when creating a custom action that is associated with a specific database item (see Add a Custom Pick Action).
- Select the Next button to display an expression entry page.
- On the expression entry page, define the expression for the custom action. The expression has to be valid for the type of custom action you have selected and if it references a parameter, the parameter has to be available on the Mimic.
For more information on the syntax for expressions, see Understanding the Basics of Expressions in the Geo SCADA Expert Guide to Expressions.
- Select the Next button.
- On the second expression entry page, enter an expression to define the availability of the pick action. If you leave the field empty, the pick action is made available by default. If you choose to enter an expression, the value of the expression has to be convertible to a Boolean value (as the action will be available when the expression is true and unavailable when it is false). If a custom action is unavailable, it does not appear on the custom menu.
For more information on the syntax for expressions, see Understanding the Basics of Expressions in the Geo SCADA Expert Guide to Expressions.
- Select the Next button.
- Select the Finish button to complete the custom action configuration.
- Repeat as required for other custom actions.
Be aware that there are certain circumstances in which embedded Mimics on which the Animate Parameter feature is used should not be Shared with Other Embedded Mimics.
Further Information
Understanding the Basics of Expressions in the Geo SCADA Expert Guide to Expressions.