Issue an SMS Command by Referencing the Action of a Database Item
We recommend that you use a Method Call with an alias to issue SMS commands to ClearSCADA. However, there are also two other techniques you can use to issue SMS commands: you can reference the Execute method of a Method Call (see Issue an SMS Command by Referencing the Execute action of a Method Call) or you can reference the action of a specific database item.
When you reference the action of a specific database item, you need to include the FullName value of the database item, which includes its parent Group(s) as well as its name. You also need to reference the action (method) that is to be triggered, and any parameters for the action. As database items can be nested in your system’s hierarchy, this can mean that the FullName and action reference can exceed the maximum size limit for a single SMS message. If your reference exceeds the maximum limit for an SMS, the reference is sent in parts in several SMS messages (this is called a multi-part SMS message).
Multi-part SMS messages have disadvantages when compared to using a Method Call with an alias:
- They may consist of long strings that take longer to enter manually than an alias (which is a maximum of 32 characters).
- Multi-part messages can be unreliable as ClearSCADA has to receive each part of the message before it can perform the required action. If the service provider is experiencing problems such as heavy network traffic or the network going down, there is an increased likelihood of delays and ClearSCADA may have to wait for a significant amount of time to receive all parts of a message. In some circumstances such as a network failure, parts of the message may be lost entirely or may not be received by ClearSCADA within the expected time range of 1 hour. If ClearSCADA receives part of a message and does not receive the remaining parts of the message within 1 hour, the message is disregarded.
- Increased cost. When an alias is used with a Method Call, the SMS command is one message. So the cost of sending the SMS command is the price of sending a single SMS message. With a full reference to an action, the SMS command may span several messages, with each part of the message costing the price of a single SMS message.
If, for some reason, you have a need to use a full reference to an action, the following configuration has to be in place:
- An SMS Service has to be In Service and configured to define the appropriate message settings such as Maximum Message Length, number of Retries and the Timeout.
- An SMS Pager Channel has to be In Service and configured to have the appropriate settings for the ClearSCADA-service provider connection.
- Your user account has to have the appropriate Pager ID for the device you are going to use to send the SMS. It should also be associated with the appropriate SMS Pager Service and have SMS Commands enabled.
- Your user account has to be configured to have the appropriate permission for the database item that has the action that is to be triggered. The permission required will vary according to the action you are attempting to trigger. For example, if you are using SMS to acknowledge an alarm for a point, your user account needs the Acknowledge Alarms permission for that specific point, whereas if you are using SMS to Hand Control a point, your user account will need to have the Control permission for the point.
For more information on the User Form’s Contact Information properties, see Define the E-Mail, Pager, and Voicemail Contact Settings for a User in the ClearSCADA Guide to Security.
For more information on permissions, see Permissions for Database Items in the ClearSCADA Guide to Security.
With the settings described above in place, you can use a full reference to trigger an action remotely via SMS:
- On the device that is associated with your user account, create a new SMS message.
- Enter the reference to the relevant database item’s action as the content of your SMS message. The SMS message should only contain the characters for the reference and needs to be in this format:
- Send the message to ClearSCADA.
When ClearSCADA receives your SMS message via the service provider, it determines which database item and action are referenced in the SMS message. It then executes the action.
<Database Item Reference>.<Action>(Parameters)
Where:
<Database Item Reference> is the FullName value of the database item that has the action that is to be performed. The FullName includes the database item’s parent Group(s) as well as its name. Do not enter the angle brackets < >.
<Action> is the name of the action that is to be performed. If the action has parameters, you should include them after the <Action> within parentheses in the same way as you would when using an expression. For the action, do not include the angle brackets < >, but you have to include the parentheses for any parameters ( ). For more information on entering parameters, see Grammar for Expressions in the ClearSCADA Guide to Expressions.