Automate Schedule - End session

Declaration

<AMSKYBOT ACTIVITY="close_skybot" SESSION="text" />

Related Topics   

Description

Ends a Automate Schedule session previously started by a Create session step.

NOTE: Automate's Automate Schedule activities enable Automate Schedule management and operations to be automated, therefore, a valid Automate Schedule license is required on the target computer in order for these activities to function properly.

Practical Usage

Ends a session started by a Create session step.

Parameters

Credentials

Property

Type

Required

Default

Markup

Description

Session

Text

Yes

(Empty)

SESSION="FlySession"

Specifies the name of the session to end.

 

Description

Error Causes

On Error

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

NOTE:
  • 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 session.

Step 2 - A List agents activity retrieves all agents and places their names in a dataset.

Step 4 - During each iteration, a Hold agent queue activity performs a hold on the next agent queue on the list.

Step 4 - During each iteration, a Hold agent queue 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.  

Copy 
<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" />