:TERMINATE

Script Statement: Ends an agent, the agents of an agent group, a work or communication process

Syntax

:TERMINATE [Connection], Name

Syntax	Description/Format
Connection	Type of connection Format: AE name, script literal or script variable Allowed values: HOST (default) = Agent HOSTGROUP = Agents of an agent group SERVER = Work or communication process
Name	Name of an agent, agent group, work or communication process Format: script literal or script variable

This script statement can be used to end agents and work and communication processes. The parameter Connection does not have to be indicated. A comma must be set if it is not used.

Instead of specifying an individual agent, you can also indicate an agent group. The termination applies to all agents that belong to this group.

Tips:

• Use the :DISCONNECT script statement to end the connection to an Agent temporarily. The Agent will reconnect to the Server when the next signal for an Agent check is sent. For more information, see :DISCONNECT.
• Use the :SHUTDOWN script statement when you want to terminate all work and communication processes of the AE system. For more information, see :SHUTDOWN.

 The right to "cancel" server processes or agents is required to execute this script statement.

Examples

The example below terminates a work process.

:TERMINATE SERVER,"AE#WP001"

In this example, the agent "WIN21" is terminated. The type of connection is not indicated.

:TERMINATE ,"WIN21"

See also: