List of Actions
The subsections within this section summarize the actions that are commonly supported by items on many drivers. The subsections are arranged in order, by pick action name.
You can also display a list of the actions that are commonly supported by a particular driver item, such as a channel, or scanner (see Actions that are Common to Many Drivers).
Be aware that many of these actions are only displayed for an item that is In Service and has valid configuration. Additionally, your User Account has to be allocated the relevant security permissions for the database item—the permission that applies to each pick action is mentioned alongside the description of that pick action. For more information, see Allocating Security Permissions in the ClearSCADA Guide to Security.
On some systems, certain permissions may be denied on a system-wide, ViewX user, or WebX user basis, regardless of the permissions that are allocated to your User Account (see Define whether any Permissions are Restricted in the ClearSCADA Guide to Security). On systems on which the Exclusive Control feature is used, some permissions might be denied to other users while an item or area of the system is under Exclusive Control (see Exclusive Control in the ClearSCADA Guide to Security). On systems that use Alarm Redirection, the ability to acknowledge specific alarms might be restricted to a particular User, User Group, or ViewX workstation (see Set Responsibility Action in the ClearSCADA Guide to Alarm Redirection). Any of these may result in various pick actions not being available for selection.
If you believe that a particular pick action should be available, but is not displayed for an item, check the item’s configuration, and Status display (see Status Attributes that are Common to Many Drivers).
Where a pick action request requires further user input before being executed, a pick action window is displayed. Use the window to specify the required information, then select the OK button to confirm the details and execute the request. With text entry fields on some pick action windows, an on-screen keyboard may be displayed to enable you to specify the field’s value on-screen, rather than by using a traditional keyboard. The keyboard is only displayed on ViewX workstations on which the On-Screen Keyboard feature enabled. For more information, see Use the Numeric Touch Screen Keypad in the ClearSCADA Guide to ViewX and WebX Clients, and see Use the Alphanumeric Touch Screen Keyboard in the ClearSCADA Guide to ViewX and WebX Clients. On some systems, users can choose to postpone certain requests on PSTN and direct ‘On Demand’ outstations. On such systems, an additional Queue check box is displayed on the relevant pick action windows—see Queue Check Box.
To find out about the methods that are available for each type of database item, please refer to the Database Schema (see Working with the Database Schema in the ClearSCADA Guide to the Database). The Database Schema provides details on the name and arguments of each method, so that you can call the methods from your own programs and scripts.
ATTENTION: Some pick actions and methods require date or time formats to be specified. Product releases from ClearSCADA 2014 R1 inclusive do not support the use of legacy date and time syntax for specifying such formats (see Date and Time Syntax in the ClearSCADA Guide to Core Configuration). If ClearSCADA deems the format to be invalid, it will use the regionally localized default date and time format (such as dd/MM/yyyy hh:mm:ss:SSS). The default format is determined by the user's Locale settings (see Define the Regional Settings for a User in the ClearSCADA Guide to Security).
These pick actions are common to items on many drivers:
- Abort Pulse
- Acknowledge Alarms
- Acknowledge with Comment
- Alarm Response
- Cancel Control
- Cancel Promoted Dial Out
- Cancel Promoted Scanning
- Cancel Queued Request
- Cancel Refresh
- Close Connection
- Close Line
- Control
- Disable Alarms
- Disable Channel
- Disable Comms Logging
- Disable Controls
- Disable IO Logging
- Disable Outstation
- Disable Point
- Disable Scanner
- Disable Server
- Disable Set
- Disable Switching
- Disable Telnet
- Display Outstations
- Display Points
- Display Pulse Actions
- Display Scanners
- Display Sources
- Download Configuration
- Enable Alarms
- Enable Channel
- Enable Comms Logging
- Enable Controls
- Enable IO Logging
- Enable Outstation
- Enable Point
- Enable Scanner
- Enable Server
- Enable Set
- Enable Switching
- Enable Telnet
- Execute
- Extend Connection
- Extend Line
- Fallback
- Inching
- Initialize
- One Shot
- Open Connection
- Open Line
- Override
- Preferred Channel
- Promote Dial Out
- Promote Scanning
- Refresh
- Release Exclusive Control
- Release Override
- Remove Alarms
- Remove with Comment
- Reset Call Statistics
- Reset Comms Statistics
- Reset Outgoing Call Quality Factor
- Reset Outstation
- Reset Point Statistics
- Reset Process Count
- Reset Serial Port Statistics
- Reset Statistics
- Switch Line
- Take Complete Exclusive Control
- Take Partial Exclusive Control
- Test PSTN Connection
- Tune Alarm Limits
- Tune M/S Alarm Limits
- Unacknowledge Alarms
- Unacknowledge with Comment.
Some further options available from the Edit Action, Edit Method, and Pick Action Configuration windows are methods, not pick actions:
- The options Delete Interface Event, Log Interface Event, Modify Interface Event, Refresh Alarms, and Reprioritize Alarms are methods that are purely for use with the Automation Interface. For information, see the database Schema.
- With points on which Historic is enabled, further options are available from the Historic aggregate on the above mentioned windows. The options Annotate, Insert Value, Load Data File, Load Data Value, Load Data Values, Modify Value, Optimize Data, and Processed Value are methods that are purely for use with the Automation Interface. For more information, see the database Schema.
- On items with which alarms can be associated, several methods are available to enable higher-level users to control alarm redirections via, for example, scripting. Such methods include CancelRedirections, ClearAlarmResponsibility, RestartRedirections, SetAlarmResponsibleUser, and SetAlarmResponsibleWorkstation. For further information, see Set Responsibility Action in the ClearSCADA Guide to Alarm Redirection, and see CancelRedirections and RestartRedirections Methods in the ClearSCADA Guide to Alarm Redirection.
Further Information
‘Core’ pick actions that are common to many database items: see Object Menu Options in the ClearSCADA Guide to ViewX and WebX Clients.