Default values have been specified for most parameters. They can be changed if required. Parameters which must be adjusted to your system environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications. are written in red letters.
Section/Parameter | Description |
---|---|
[GLOBAL] | |
name= |
The agent name is limited to 32 of the following characters: A-Z, 0-9, _, ., $, @, - and #. The hostComputer, target system. name is used instead if this parameter remains undefined. Lowercase letters are converted to uppercase letters. Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects. |
system= |
AE system nameName of the Automation Engine instance to which a user is connected.. |
logging= | Path and log-file name.
The number signs serve as placeholders for a series in numerical order. Log files are renamed when the agent starts and the most current log file is always the one with the number "00". |
logcount= | Number of stored log files. |
helplib= | Path and name of message file. |
licence_class= | License class that complies with the acquired license
and the hard and software that is used. Allowed values: "1" to "9" "1" to "9" = Agent's license class |
language= |
Language that should be used for the logging. You can specify a primary and a secondary language. Allowed values: "E", "D",
"F" If there is no message in the primary language, the system searches for a message in the secondary language. |
userid_type= |
This parameter can be used to allow or reject certain users. Allowed values: "INCL", "EXCL" "INCL" = Access authorization must
be specified for every particular 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. in the [USERID] section. |
RSM= |
RSM8 must be installed in order to enable jobAn Automation Engine object type for a process that runs on a target system. reportA report provides more detailed information about a task's execution or a component. transfers to AE. If this program is not available, the parameter RSM= should be used to avoid that jobs remain stuck. Without the use of RSM8, files containing some basic information are created with the name of the job report. Allowed values: "N" and "X" "N" - A file is stored in the OUT
catalog. Do not specify this parameter RSM= if RSM8 is used. |
active_jobreport_count= |
Maximum number of job reports that can be sent to the Automation Engine at the same time. Default value: "10" |
ft_temp_file= |
Creates temporary files in file transfers. Allowed values: "yes" (default value) and "no" "yes" - The file obtains a temporary
name which is composed of the letter "T" and an alphabetic string
originating from the RunIDShort for "run number". It is a number that provides unique information about a task's execution. The RunID can include 7 to 10 digits. It is assigned by the Automation Engine component .. The new file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object). protocol additionally appends a file ID in order to obtain a unique file name because basically, only a RunID is provided. The file is renamed after it has successfully
been transferred. |
[AUTHORIZATION] | |
InitialPackage= |
The name and the path of the file that includes the authentication package (company-key file). This parameter must be specified if you use the authentication methods "Server" or "Server and Agent". Any attempt to log in fails if the company-key file cannot be found. When the agent starts, it reads the company-key file and stores its information in the file that is specified in the parameter KeyStore=. The first file is deleted afterward. |
KeyStore= |
The name and the path of the file that includes the information of the 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. (see parameter InitialPackage=). If no file name and/or path is specified, the system uses the name (file ending *.kstr) or the path of the agent's INI file. If you define a file name, the ending *.kstr is not automatically appended. The KeyStore file is created when the agent starts for the first time. You must not delete, rename or move it subsequently. Regardless of the authentication method that you use, any attempt to log in will fail if the agent cannot find this file when it starts. In this case, you must open the menu item "Renew transfer key" in the affected agent's System Overview. |
[USERID] |
Specification of authorized GCOS8 users in the format: Specification of non-authorized GCOS8 users
in the format: |
[VARIABLES] | This section contains the agent variables with agent information and settings. |
SNUMB_SUFFIX= |
Character that should be appended to the job's sequence number if the user did not specify it in the Job objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task. |
[MISC] |
|
TRCOPENCLOSE= |
Setting for the handling of trace files. Allowed values: "0" (default value) and "1" "0" - The file opens when a trace
is set and closes when the trace or the agent is closed (highly recommended). |
[HOSTS] |
Assignment of an agent's name to its address (DNS name or TCP/IP address) if it cannot directly be accessed through the address that is stored in the server. Specify several assignments line by line, there is no upper limit for the number of assignments. In file transfers, the sending agent obtains the destination agent's internal address from the Automation Engine. The sending agent replaces this internal address by the external address that is defined here. This setting is only required if you run file transfers with agents that cannot directly establish a TCP/IP connection between each other by using the address that they have received from the Server. This can happen if the agents that are involved in the file transfer are located on different networks or if a firewall is used.
|
[TRACE] |
|
file= | Path and file name of the trace file.
The number signs serve as place holders for a series in numerical order. When you start a trace, the trace files will be renamed so that the most current trace file is always the one with the number "00". |
trccount= | Number of stored trace files. |
tcp/ip= |
Trace flags of the agent.
Allowed values: "0" (default value) to "9" Trace flags must only be used in close cooperation with Automic Support. |
[TCP/IP] |
|
connwait= |
Time interval in seconds during which the agent waits for a response from its communication partner (CP or another agent). If this time limit is exceeded, the connection to the communication partner is disconnected. Default: 10 seconds |
port= | The agent's port number.
Other agents and the Job Messenger establish connection with the agent via this port number. |
connect= |
Time interval in seconds during which the agent tries to establish a connection to the Automation Engine. This affects the connection attempt for a restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. or after a lost connection. Default value: 20 seconds This parameter only works until the agent's first successful logon to the AE system. After that, the parameter RECONNECT_TIME in the Host Characteristics serves this purpose. |
report= |
Time interval in seconds in which the agent sends the logging to the Automation Engine. |
cp= |
Address of the AE system's communication process to which the agent should connect. Allowed formats: |
job_check_count= |
Number of periodical job checks that the agent should wait when the job ends. Only then the job is reported as vanished (ENDED_VANISHED statusThis represents the condition of a task (such as active, blocked, generating).). Allowed values: "0" - "32767" "0" - The agent does not use this parameter. |
[CP_LIST] |
List of communication processes. This listShows entities in a grid view is created when the agent starts and is extended when new communication processes are activated. You will find more detailed information about establishing a connection in the chapter Multi-Server Operation. The communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. that is defined in the parameter cp= (section [TCP/IP]) is not included in the cp list. Format: |
[GLOBAL]
system=uc4
name=GCOS8
logcount=4
logging=<catalog>/TMP/LOG##
language=(E,D)
helplib=<catalog>/bin/UCMSL
licence_class=1
; USERID Type = INCL/EXCL
userid_type=EXCL
ft_temp_file=yes
[AUTHORIZATION]
InitialPackage=
KeyStore=
[USERID]
;AUSTRIA=NO_START
[VARIABLES]
UC_HOST_CODE=UC_CODE
UC_HOST_JCL_VAR=GCOS8
UC_EX_PATH_BIN=<catalog>/bin
UC_EX_PATH_TEMP=<catalog>/tmp/
UC_EX_PATH_JOBREPORT=<catalog>/out/
UC_EX_JOB_MD=<catalog>/build/UCXJGC8M
[HOSTS]
; <AE-name>=<dns-name> or
; <AE-name>=<ip-addr>
[TRACE]
; DON'T REMOVE THE TRACE FLAGS !!!
file=<catalog>/TMP/TRC##
trccount=4
tcp/ip=9
filetransfer=9
job=9
event=9
variable=9
controlflow=9
message=9
dump=9
misc=9
msgconv=0
[TCP/IP]
; Agent's listen port
port=2017
; try all n seconds to connect to server
connect=20
report = 60
cp=PC01:2217
job_check_count=5
[CP_LIST]
2218=PC01
See also:
Notes for Configuration-File Adjustments
Automic Documentation - Tutorials - Automic Blog - Resources - Training & Services - Automic YouTube Channel - Download Center - Support |
Copyright © 2016 Automic Software GmbH |