RequestToken

(Control Token Manager)

Description: Requests a Control Token for a tag.
Returns: Nothing
Usage: Script Only.
Function Groups:

(Control Token Manager)
Related to:

CanControl (Control Token Manager) | CanDenyTokenRequest | CanGrantTokenRequest | CanReleaseToken | CanRequestToken | DenyTokenRequest | GetToken (Control Lock Module) | GetTokenLevel | GrantTokenRequest | ReleaseToken | RequestToken |

Format: \ControlTokenManager.RequestToken(TagID, Level[, Auto, Custom, Timestamp, SessionID, AccountID, MachineID, Device])
Parameters:  
TagID
Required string. The UniqueID of the tag for which a token request is to be made.
Level
Optional numeric. The priority level of the token request. Defaults to 1.
Auto
Optional Boolean. Set to TRUE if the request is automatic and to FALSE if the request is manual. Defaults to FALSE.
Custom
Optional structure. A set of custom fields to log. Must be packed.
Timestamp
Optional timestamp. The UTC time of the request. Defaults to current time.
SessionID
Optional. The ID of the session adding the token. Relevant only if token ownership is tied to sessions.
AccountID
Optional. The ID of the user requesting the token. Defaults to the signed in user at the current workstation.
MachineID
Optional. The MachineID of the workstation where the request was made. Relevant only if token ownership is tied to workstations.
Device
Optional. The IP address of a Thin Client device.
Comments:

Token ownership is affected by the value of the property, ControlTokenOwnerMode.

Manual refers to user action while Auto refers to ControlTokenManager / VTScada action

To provide the ability to control the entire tag tree, a fictitious ‘Root Tag’ is declared in the ControlTokenManager. The syntax to use this would look similar to:

\ControlTokenManager.RequestToken(\ControlTokenManager.RootTagID, Level)

This can also be configured in a Request Button widget. The Root Tag name and area can be changed by adding ControlTokenRootTagName and ControlTokenRootTagArea properties.