Automate Schedule - Hold agent queue |
Declaration
| <AMSKYBOT ACTIVITY="hold_agent_queue" IP="text" PORT="number" USERNAME="text" PASSWORD="text (encrypted)" AGENTNAME="text" /> |
Description
Holds an agent job queue. This will prevent all jobs in the queue from running.
|
NOTE: To hold or release agent queues, you must have Change authority to the “Agents” secured object (or to the specific agent itself). |
Practical Usage
Can be used to hold a job queue until released or until a date and time have been reached. To release an agent queue, use the Release agent queue activity.
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. |
Agent
|
Property |
Type |
Required |
Default |
Markup |
Description |
|
Name |
Text |
Yes |
(Empty) |
AGENTNAME="A410BB" |
The name of the agent from which to hold the queue. NOTE: If the agent queue is already held at runtime, no action will be performed and no errors will occur as a result. The agent queue will continue at its present state. |
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 sessions and loop operations as well as the List agents and Hold agent queue activities:
Step 1 - A Create session activity creates and starts a Automate Schedule session in which subsequent Automate Schedule steps can link to.
Step 2 - A List agents activity retrieves all agents and places their names in a dataset.
Step 3 - A Loop dataset activity loops through the dataset.
Step 4 - During each iteration, a Hold agent queue activity performs a hold on the next agent on the list.
Step 6 - An End loop activity ends the loop operation.
Step 7 - An End session activity ends the current session.
<AMSKYBOT SESSION="Skybot_1" IP="10.0.1.69" PORT="8008" USERNAME="admin" PASSWORD="AM4xbZm+mwQN5MGOCNMiHvJ5srNQYnFndV8aME" />
<AMSKYBOT ACTIVITY="list_agent" SESSION="Skybot_1" RESULTDATASET="theAgent" />
<AMLOOP ACTIVITY="dataset" DATASET="theAgent"><AMSKYBOT ACTIVITY="hold_agent_queue" SESSION="Skybot_1" AGENTNAME="%theAgent.AgentName%" /></AMLOOP>
<AMSKYBOT ACTIVITY="hold_agent_queue" SESSION="Skybot_1" AGENTNAME="%theAgent.AgentName%" />
<AMLOOP ACTIVITY="end" />
<AMSKYBOT ACTIVITY="close_skybot" SESSION="Skybot_1" />