Automate Schedule - Get variable |
Declaration
| <AMSKYBOT ACTIVITY="get_variable" IP="text" PORT="number" USERNAME="text" PASSWORD="text (encrypted)" VARIABLENAME="text" RESULTVARIABLE="text" /> |
Description
Retrieves information about a Automate Schedule variable and populates an existing Automate variable with results.
|
NOTE:To retrieve data regarding Automate Schedule variables, you must have View authority to the “Automate Schedule Variables” secured area. |
Practical Usage
Can be used to retrieve details about a Automate Schedule variable.
Parameters
Connection
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Connection |
--- |
--- |
--- |
--- |
Indicates where this activity's Automate Schedule credentials should originate from. This is a visual parameter used only during design-time, thus, contains no properties or markups. The available options are:
|
|
Session |
Text |
Yes if Connection parameter set to Session |
Automate ScheduleSession1 |
SESSION="Session1" |
The name of the session to associate this activity with. This parameter is active only if the Connection parameter is set to Session. If the Connection parameter is set to Host, this parameter is ignored and the remainder of the parameters specified below becomes active. NOTE: Use the End Session activity to end an active Automate Schedule session. |
|
Server |
Text/Number |
Yes if Connection parameter set to Host |
(Empty) |
|
The Domain Name System (DNS) name (i.e. www.domain.com) or IP address (i.e. 93.184.216.119 ) of the Automate Schedule Server with which to establish communication. |
| Port |
Number |
Yes if Connection parameter set to Host |
(Empty) |
PORT="8008" |
The TCP/IP port assigned to allow communication with Automate Schedule. |
| User name |
Text |
Yes if Connection parameter set to Host |
(Empty) |
USERNAME="SuperFlyBot" |
A valid username of a user configured to access Automate Schedule. NOTE: Certain Automate Schedule activities may or may not be permitted depending on the permissions set for the user. |
| Password |
Text |
Yes if Connection parameter set to Host |
(Empty) |
PASSWORD="encrypted" | A valid password configured for the username entered above. |
|
Proxy type |
Text (options) |
No |
Default |
|
The type of proxy required for Automate Schedule connections that pass through a proxy server. The available options are:
|
|
Use authentication |
--- |
--- |
--- |
--- |
If enabled, indicates that proxy authentication is implemented, thus, the authentication-based parameters specified below are put into effect. This is a design-time parameter, therefore, contains no properties or markups. It is active only if the Proxy type parameter is set to HTTP. |
|
Proxy server |
Text |
No |
(Empty) |
PROXYSERVER="proxy.host.com" |
The host name (server.domain.com) or IP address (xxx.xxx.xxx.xxx) of the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. |
|
Proxy username |
Text |
No |
(Empty) |
PROXYUSERNAME="ProxyUser" |
The proxy username to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
|
Proxy password |
Text |
No |
(Empty) |
PROXYPASSWORD="encrypted" |
The proxy password to authenticate with. This parameter is available only if the Use Authentication parameter is enabled. |
|
Proxy port |
Number |
No |
8008 |
PROXYPORT="8008" |
The port that should be used to connect to the proxy server. This parameter is available only if the Proxy type parameter is set to HTTP. The default value is 8008. |
Variable
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Name |
Text |
Yes |
(Empty) |
VARIABLENAME="theVar" |
The name of the Automate Schedule variable to retrieve data from. Enter the name manually in the provided text box or click the folder icon to open the Automate Schedule browser which allows connection to the server in order to browse available Automate Schedule variables. |
|
Populate variable with Automate Schedule variable definition |
Text |
Yes |
(Empty) |
RESULTVARIABLE="theVar" |
The name of an existing Automate variable to populate with information about the notification list. |
Additional Notes
By default, Automate Schedule has the web services option disabled. This will prevent Automate's Automate Schedule actions from running. To enable the Automate Schedule Web Service, log into Automate Schedule's UI and select from the main menu Admin -> System Settings. Scroll down to the Configure Features section and click the EDIT link. Check the Allow Web Service Requests check box (as shown below) and save the settings.
Example
- The sample AML code below can be copied and pasted directly into the Steps Panel of the Task Builder.
- Parameters containing user credentials, files, file paths, and/or other information specific to the task must be customized before the sample code can run successfully.
Description
This sample task demonstrates use of the List variables and Get variable activities. A List variables step populates a dataset with a list of Automate Schedule variables. A Loop dataset step is then used to loop through the dataset. A Get variable step retrieves the name of an individual variable during each iteration and displays the data in a message dialog.
<AMVARIABLE NAME="Var_data" VALUE="" />
<AMSKYBOT SESSION="Skybot_1" IP="10.0.1.69" PORT="8008" USERNAME="admin" PASSWORD="AM4xbZm+mwQN5MGOCNMiHvJ5srNQYnFndV8aME" />
<AMSKYBOT ACTIVITY="list_variable" SESSION="Skybot_1" RESULTDATASET="VarInfo" />
<AMLOOP ACTIVITY="dataset" DATASET="VarInfo"><AMSKYBOT ACTIVITY="get_variable" SESSION="Skybot_1" VARIABLENAME="%VarInfo.VariableName%" RESULTVARIABLE="Var_data" /><AMSHOWDIALOG>%Var_data%</AMSHOWDIALOG></AMLOOP>
<AMSKYBOT ACTIVITY="get_variable" SESSION="Skybot_1" VARIABLENAME="%VarInfo.VariableName%" RESULTVARIABLE="Var_data" />
<AMSHOWDIALOG>%Var_data%</AMSHOWDIALOG>
<AMLOOP ACTIVITY="end" />
<AMSKYBOT ACTIVITY="close_skybot" SESSION="Skybot_1" />