Automate Schedule - End session

Declaration

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

Related Topics

Description

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

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

Practical usage

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

Parameters

Session

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

Enabling Automate Schedule Web Service

By default, Automate Schedule has the web services option disabled. This will prevent 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 select EDIT. Select Allow Web Service Requests (as shown below) and save the settings.

Example

NOTE:
  • Copy and paste the sample AML code below directly into the Task Builder Steps Panel.
  • To successfully run the sample code, update parameters containing user credentials, files, file paths, or other information specific to the task to match your environment.

Description

This sample task demonstrates use of sessions and loop operations as well as the List agents and Hold agent queue activities:

  1. A Create session activity creates and starts a session.

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

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

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

  5. An End loop activity ends the loop operation.

  6. 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" />