:DISCONNECT

Use the :DISCONNECT script statement to disconnect a connection to the AE system. Users or user groups that are defined as connections must belong to the same client as the object in whose script you use this script statement. An Automic Web Interface message informs the user that the connection to the Automation Engine has been interrupted and that they must re-log on. Doing so does not result in an error if there are no active connections to the AE system. If users or user groups are invalid, script processing aborts, and the system sends an error message. Instead of specifying individual agents as connection, you can also indicate an agent group. The ended then applies to all agents that belong to this group.

Note: Users or agents need the right to cancel processes, as otherwise this script statement cannot be processed.

Syntax

:DISCONNECT Connection, Name

Parameters

:DISCONNECT
Disconnects a connection to the AE system
Connection
Type of connection
Format: script literal, script variable, or number
Allowed values:
- USER
  Connection of a user or a user group
- HOST
  Connection of an agent
- HOSTGROUP
  Connection of agents that belong to an agent group

Notes

Using :DISCONNECT together with HOST or HOSTGROUP does not terminate the agent, but it ends the connection temporarily. The agent reconnects to the system when it receives a signal that checks the agent. Disconnecting an agent connection with :DISCONNECT is useful when you start a new communication process and want the agents to rearrange.
To terminate an agent, you can use the :TERMINATE script statement.

Name
Name of a user, user group, agent, or agent group.
Format: script literal, script variable, or number

Example

The following example disconnects the user SMITH/AE from the AE system.

:DISCONNECT "USER", "SMITH/AE"

The agent WIN01 is disconnected from the AE system.

:DISCONNECT "HOST", "WIN01"

The next example disconnects all database agents.

:DISCONNECT "HOSTGROUP", "HOSTG_DB_UNIX"