Creating a Registry Pick Action
From Geo SCADA Expert 2019 onwards:
- The location from which the REGISTRY function retrieves a value varies, depending on the type of client from which the function is triggered and the user that is logged onto that client. With ViewX and Virtual ViewX clients, the value is now stored in the registry of the User Account database item that is associated with the logged on user.
- You cannot use the REGISTRY function if you are accessing the database as the Guest User or Super User. You can only use the function if you are logged on via a Geo SCADA Expert User Account.
For more information, see REGISTRY.
You can use the Pick Action Configuration Wizard to associate a Mimic object with a Registry pick action. When the pick action is selected, a value is written to the registry. This value can be used in animations as part of a condition in an expression.
For example, a common use of the Registry pick action is to write a value to the registry key that is used to determine whether a layer is visible.
You can find more detailed information on using the Registry pick action feature for controlling the visibility of layers and applying different filters to an embedded SQL list in Local Variables (Registry Key Settings).
To set up a Registry pick action:
- Display the Pick Action Wizard (see Accessing the Pick Action Configuration Wizard).
- Select the Registry option.
- Use the Disabled check box to define whether the pick action you are setting up is enabled or disabled.
If you select the check box, the pick action will be disabled—it will not be available to users. This setting is designed for use with animations. By animating the PickDisabled property of an object, you can make the availability of a pick action dependent on a condition. For example, you could set the pick action to disabled on the Pick Action Wizard and then use an animation to associate the Mimic object's PickDisabled property with a digital point. The state of the digital point will affect whether the hyperlink is enabled or disabled.
If you clear the check box, the hyperlink pick action is available for selection. This is the default setting.
- Select the Next button.
- Enter the name of the registry key in the Name field. If this registry key does not already exist, the selection of the pick action will cause the system to create the entry in the registry. The registry key will have the value that you define in step 7 as its default value.
You cannot include parentheses ( ) in the Name.
Typically, engineers configure the animations for a Registry pick action before they setup the pick action. If the name of the registry key and the default value has already been specified in the animations, the settings on the pick action wizard will not be used to create a new registry key (unless they specify a different registry name).
- Use the Type combo box to define the type of value that will be written by the pick action. The value can be:
- Number—The value consists only of numerical characters.
- String—The value contains letters.
- In the Value field, enter the Value that is written to the registry key when the pick action is selected. This is the value that will be used as the default value for the registry entry if the registry key does not already exist.
The value will be overridden by any values that are specified as part of a registry animation (see Local Variables (Registry Key Settings)).
From Geo SCADA Expert 2019 onwards, the location from which the REGISTRY function retrieves a value varies, depending on the type of client from which the function is triggered (see REGISTRY).
- Select the Next button.
- Enter a comment in the Pick Action Comment field (if required). The comment is shown in the status bar when a user positions the cursor over the Mimic object. If you do not enter a comment, a default comment is shown in the status bar instead.
- Select the Next button.
- Select the Finish button.
The Mimic object is now associated with a Registry pick action. You can test the registry pick action by displaying the Mimic in Run mode and selecting the object that is associated with the Registry pick action (pick actions are only available in Run mode). When the pick action is selected, the relevant value is written to the registry key. By using the registry in animation expressions, you can apply local changes to a Mimic (see Local Variables (Registry Key Settings)).