User Guide > UserInterface > System Overview > Agents

Agents

The category "Agents" lists all agents that are allowed for a particular 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.. Currently inactive agents are displayed with a white symbol. All agents of the system can be viewed and 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  authorizations be changed in the System OverviewThe UserInterface window that contains information about the Automation Engine system. of client 0000.

Column

Description

Name

The name of the agent.

Authenticated Shows whether an agent has been authenticated.

Version

The agent version including its patch level.

Platform

Platform on which the agent runs.

HW

Computer's hardware information (such as the system type, number of processors, processor type).

SW

Computer's operating system.

SW Version

the version of the operating system.

Last Check

The time of the last check.

CP

Linked communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components..

Time Diff.

The time difference between agent and AE system.

IP Addr.

Agent's TCP/IP address.

Port No.

Agent's port number.

License Class

Agent's license class.

MIB

Agent's MIB information.

Service

Indicates if the agent is responsible for a specific service:

"MAIL" - E-mail connectionThis is a functionality of Windows and UNIX Agents that is used to send e-mails.
"SQL" (only for databaseA database is an organized collection of data including relevant data structures. agents) - agent is responsible for dissolving "SQL" type Variable objects.

Compress

Compression type which is used for file transfers by default.

The administrator can define this type in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_HOSTCHAR_DEFAULT with the key "FT_COMPRESS".

If a different compression method should be used for a file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object)., it can be changed in the FileTransfer objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.

License category

Name of the license category assigned to the agent

Authorizations

Rights that are assigned to the agent.

"R" - Read
"W" - Write
"X" - Execute

Job res. max.

Resources that the agent provides for jobs.

Format: Currently used resources (maximum number of resources)

The administrator can specify the resource value using the key WORKLOAD_MAX_JOB in the variable UC_HOSTCHAR_*.

FT res. max.

Resources that the agent provides for file transfers.

Format: Currently used resources (maximum number of resources)

The administrator can specify the resource value using the key WORKLOAD_MAX_FT in the AE variable UC_HOSTCHAR_*.

Keep alive

The time interval for periodical checks.

The administrator can specify the time interval with the key KEEP_ALIVE in the variable UC_HOSTCHAR_*.

Roles

Agent roles.

The administrator can determine role names in the agent variable UC_EX_HOST_ROLE.

Last logoff Agent's last logoff time from AE system.
Number of clients Number of 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.-defined clients in which the agent has particular authorizations.
Linked Indicated if the agents is linked to a ServiceManagerA program that facilitates the starts and stops of Automation Engine components. which depends on the settings made in the Agent object's Attributes tab.
Process ID The agent's process identification number.
Net Area

The name of the agent's net area.

By default, the name of the Automation Engine systemAn environment that is managed by Automation Engine components. [Formerly called "UC4 system."] is used for this value.

Context Menu

Individual agent commands are available via the context menu. It is possible to access statistical and reportA report provides more detailed information about a task's execution or a component. data, search for objects using the agent or disconnect the connection. All possible commands are explained below:

Command

Description

Statistics or report

Calls the statistics or the last report.

Activity Window

Opens the Activity Window with a filter to agent tasks.

Edit

Opens the corresponding Agent object.

This command is only available in system client 0000.

Start

Starts the agent via a ServiceManager.

This option can only be used if a ServiceManager is available for starting the agent. Furthermore, it is required to enter the ServiceManager settings in the Agent object either manually or with the command "Refresh ServiceManager Scan".

Please enable the relevant ports in your firewall, so that the server processThe core of the component Automation Engine. Different types are available: communication, work and dialog processes, as well as nonstop processes. will be able to connect to the ServiceManager. You have to use the ports defined in the INI file of the ServiceManager.

Disconnect Agent

Disconnects the connection on a temporary basis. The agent reconnects to the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. as soon as the next signal for agent checking is sent. Disconnecting an agent connection is reasonable when a new communication process is started and the agents rearrange themselves in order to have workload well-balanced.

Change Logging

Causes the log file to be changed. You can also use the scriptA particular Automation Engine object type. element CHANGE_LOGGING for changing the log file.

Quit

Closes the agent immediately regardless of tasks that might be running.

Delete Agent

Deletes an inactive agent. It is moved to the Recycle Bin and can be restored at a later time. Agent authorizations remain untouched.

Search for Use...

The Search dialog opens, in which you can search for objects using the agent.

Replace...

The Replace Use dialog opens, listing objects that use the agent and can therefore be replaced by another one.

Properties

Calls the Properties dialog (see below).

Export to File...

Exports the content of the agent listShows entities in a grid view to a CSV file.

Refresh ServiceManager Scan

Refreshes the ServiceManager's connection settings for the selected agents.

These settings are required for starting agents via the System Overview or the script element MODIFY_SYSTEM using a ServiceManager. The Agent object's Attributes tab can be used to display and manually edit these settings.

It can happen that the service name which has been entered in the Agent object does not comply with the corresponding service name in the ServiceManager anymore. In this case, execute the command "Refresh ServiceManager Scan" or enter the relevant values manually.

Please enable the relevant ports in your firewall, so that the server processes will be able to connect to the ServiceManager. You have to use the ports defined in the INI file of the ServiceManager.

Refresh

Refreshes the view

The following commands are only available in system client 0000. The administrator can define the ones which should be displayed in the variable UC_AS_SETTINGS.

Command

Description

Export company key Exports the company key to a file.
Authenticate Agent

Releases and agent for processing.

Subsequently, this agent can be used in your individual clients.

Withdraw authentication

Locks an agent from processing.

This agent is no longer available for processing in your clients.

Export authentication packageA Package is an instance (a version, a revision, a tag, …) of your application and defines the content which you want to deploy. Here you decide, if you want to deploy the entire application or just a few specified components.

Exports the authentication package to a file.

As of version 11 the actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. "Export Authentication Package" has been restricted to users in the System client 0. Additionally a user needs the "W" permission for the Agent object to be able to export an authentication package.

Renew transfer key The transfer key must be renewed when the agent's keystore file has been changed.

Properties

The context-menu command Properties opens a dialog where you can specify various settings.

Setting Trace

Trace options can be set or deleted on the Trace tab. All agents are able to write a trace (this can be understood as more detailed logging) which enables root cause analysis for error situations. The agent does not have to be closed for a trace but system performance can decrease due to the fact that a huge amount of data is created. Automic recommends close cooperation with our Automic Technical Support when setting trace options.

Enter the adequate number in the relevant trace option. It is also possible to specify more than one trace option.

Rapid Automation agents include an RA option where you can set trace from "0" - "9" for them. When you need to set Rapid Automation agent trace, you almost always set it to "9". Some Rapid Automation agents, such as the Web Service agent allow you to set additional third-party library trace in their UCXJCITX.INI file. Third-party trace cannot be set for those agents here.

Additional Trace Options

Error situations that occur sporadically or are not reproducible are very hard to trace. For example, some errors don't happen every night and usually not during an administrator's regular office hours. When this happens, trace files can become too big to fit in the available disk space. Additional trace options account for this. They allow you to configure string matching to stop tracing when a string you define is found in an error message.

Field

Description

Trace Type

Determines how the trace is stored.

Allowed values:

  • FILE: The trace is directly written to a file.
  • MEMORY: The trace is held in memory. In this case, the trace is only written to disk when the text in the Trace Search Key field is found.
  • Only Windows, Unix, BS2000 and z/OS agents support memory trace.

Max Trace Size (MB)

The effect of this setting depends on the trace type. For:

  • FILE: The setting is the maximum allowed size of a single trace file. When the size of the current trace file exceeds this limit, the file is closed and a new trace file is opened. A maximum trace size of 0 is interpreted as unlimited file size.
  • MEMORY: The setting is the maximum allowed memory to be used for the trace. When the size of the trace exceeds this limit, the oldest trace entries are overwritten with new ones. The minimum memory trace size used by all agents is 32MB.
  • If memory trace is activated and the trace is later written to disk, when the Search Key is found, the set max trace size limit does NOT apply to the file on the disk. This is because the trace requires less space in memory than on the disk.

Search Key Type

This setting has no effect in this releaseReleases combine a set of activities and a set of packages as well as other release artifacts under a timeline (a plan including milestones and phases), which can be planned, baselined and tracked.. It is present for a future enhancement.

Allowed values:

  • SIMPLE
  • REGEX
Trace Search Key

The string which is searched for in the trace while it is being written. If this string is found, all trace options are reset and the tracing stops. You can use wildcards in the file name: * stands for several characters, ? for exactly one character.

Workload Balancing and Agent Settings

Workload balancing and agent settings can be specified in the lower part of the window. These are valid until the agent connection is interrupted or ended.

The default value is specified by the administrator in the variable UC_HOSTCHAR_*.

Description

UC_HOSTCHAR_*

Max. resources jobs:
Maximum number of resources the agent provides for jobs (allowed values: "0" - "100000"). The resource value is not checked if the checkbox is not activated.

WORKLOAD_MAX_JOB

Max. resources file transfer:
Maximum number of resources the agent provides for file transfers (allowed values: "0" - "100000"). The resource value is not checked if the checkbox is not activated.

WORKLOAD_MAX_FT

Max report blocks
Maximum number of report blocks to be stored in the AE database (allowed values: "1" - "10000").

MAX_REPORT_SIZE

Check interval
Time interval for the periodic Automation Engine check.

KEEP_ALIVE

Viewing Agent Information (Variables)

The Agent info tab includes information about agent variables.

Information

Description

HOST_HTYP_HW

Hardware information about the computer
(for example, system type, number of processors, or processor type).

HOST_HTYP_SW

Operating system of the computer.

HOST_HTYP_SWVers

Version of the operating system or business solution.

HOST_CodeName

Name of the CodeTable object in use.

HOST_JCLVar

JCL variant (Job Control LanguageShort form of "Job Control Language". It refers to applications that are processing steps executed on computers.).

HOST_HostAttrType

Type of the agent.

HOST_TcpIpAddr

DNS name or TCP/IP address of the agent.

HOST_TpcIpPort

Port of the agent.

HOST_Active

Shows whether the agent is active or inactive.

Allowed values: "0" and "1"
"0" - Agent is not active
"1" - Agent is active

HOST_JobCnt

Number of currently active agent jobs

HOST_MaxWaiting

Displays whether the value specified with WORKLOAD_MAX_JOB was exceeded.

Allowed values: "0" and "1"
"0" - Value lies below WORKLOAD_MAX_JOB
"1" - Value was exceeded

HOST_Daylight

Retrieves if summertime applies.

When being started, the agent verifies whether summer or wintertime applies.

Allowed values: "Y" and "N"
"Y" - Summertime
"N" - Wintertime

HOST_LicenceClass

License class

HOST_Version

Agent version including hotfix level.

HOST_JobMd

Path of the Job Messenger.

HOST_PathBin

Path of the BIN directory.

HOST_PathJobReport

Path of the directory in which the jobAn Automation Engine object type for a process that runs on a target system. report is stored.

HOST_PathTemp

Path of the Temp directory.

HOST_LoginMask

Mask for the loginAn Automation Engine object type that stores account credentials used by agents on target systems. information.

HOST_MibMonitoring

Shows whether the agent's availability is monitored.

Allowed values: "0" and "1"
"0" - The agent is not monitored
"1" - The agent is monitored

HOST_LicCategory

License category.

 

See also:

Agent

 


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

Copyright © 2016 Automic Software GmbH