Automation Engine Script Guide > Ordered by Function > System Conditions and Settings > :DISCONNECT

:DISCONNECT

Script statement: Disconnects a connection to the AE system

Syntax

:DISCONNECT Connection, Name

Syntax

Description/Format

Connection

Type of connection
Format: script literal, script variable or number

Allowed values: "USER", "HOST" and "HOSTGROUP"
"USER" = Connection of a userIn the Automation Engine, a user is an instance of a User object, and generally the user is a specific person who works with Automic products. The User object is assigned a user ID and then a set of access rights to various parts of the Automation Engine system and product suite. These access rights come in the form of Automation Engine authorizations and privileges, Decision user roles and EventBase rights and ARA web application object rights. You can manage all these centrally in the ECC user management functions. See also, Unified user management. or user groupA group of users who have a common profile of rights. A particular object type in the Automation Engine. User groups are an organizing construct to help you better manage users because you can grant user groups access rights the same way that you grant various access rights to a single user. All users in the user group are automatically given those access rights. This makes managing users not only more efficient but also more secure because working with user groups gives you a better overview of what rights are assigned.
"HOST" = Connection of an agentA program that enables the de-centralized execution of processes (such as deployments) on target systems (computers or business solutions) or a service that provides connectivity to a target system (such as for databases or middleware). An agent is also an object type in the Automation Engine. [Formerly called "Executor."] See also: host
"HOSTGROUP" = Connection of agents belonging to an agent groupAn agent group combines agents of the same platform. The agents that should be included in an agent group are specified by entering the agent name or via filters. A task that runs in an agent group is processed on one or all of the agent group's agents, depending on the specified mode. A particular Automation Engine object type.

Name

Name of a user, user group, agent or agent group
Format: scriptA particular Automation Engine object type. literal, script variableA placeholder for a value within a script. or number

Comments

This script statement can be used to disconnect connections to the AE system.

Users or user groups must belong to the same clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type. as the objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task in whose script this script statement is used. A UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."] message informs the user that the connection to the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. has been interrupted and that logging on again is required. This does not result in an error if there were no active connections to the AE system. If users or user groups are invalid, script processing is aborted and an error message is sent.

:DISCONNECT used in combination with "HOST" or "HOSTGROUP" does not terminate the agent but ends the connection temporarily. The agent reconnects to the Automation Engine as soon as the next signal which checks the agents is sent. Disconnecting an agent connection is useful when a new communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. starts and the agents  rearrange. Use the script element :TERMINATE to end an agent.

Instead of specifying individual agents, you can also indicate an agent group. The termination then applies to all agents that belong to this groupAn Automation Engine object type that integrates tasks so that they can be processed together..

 This script statement can only be processed if the user or agent is authorized to "cancel" processes.

Example

This 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"

Below, all databaseA database is an organized collection of data including relevant data structures. agents are disconnected.

:DISCONNECT "HOSTGROUP", "HOSTG_DB_UNIX"

 

See also:

Script element Description

:TERMINATE

Ends an agent, a work or communication process
:SHUTDOWN Ends an AE system

Script Elements - System Conditions and Settings

About Scripts
Script Elements - Alphabetical Listing

Script Elements - Ordered by Function

 


Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support

Copyright © 2016 Automic Software GmbH