Administration Guide > Configuration > Structure of the Configuration Files > BS2000 Agent

BS2000 Agent

See also: Notes for Configuration-File Adjustments

 Default values have been specified for most parameters. They can be changed if required. Parameters that 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.

Structure of the INI File x.xxx.UCXJB2?.INI

Section/Parameter Description
(GLOBAL)  

SYSTEM=

Name of the AE system.

This entry must comply with the entry in the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes.'s INI file.

NAME=

Name of the 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

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.
LOGGING= Name of the log file.

You can enter the 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. ID here. If the User ID has not been specified, the log file is written to the User ID under which the jobAn Automation Engine object type for a process that runs on a target system. has been executed.

The number signs serve as placeholders for a series in numerical order. When you start the agent, the log files are renamed so that the most current log file is always the one with the number "00".

LOGCOUNT= Number of stored log files.
LANGUAGE=

Language that should be used for the logging. You can specify a primary and a secondary language.

Allowed values: E, D, F
Default: "E,D" (primary English, secondary German)

If there is no message in the primary language, the system searches for a message in the secondary language.

LICENCE_CLASS= License class that corresponds to the acquired license and the hardware and software that is used.

Allowed values: "1" to "9"
"1" to "9" = Agent's license class

JOINREAD=

Parameter that determines the passwordA secret combination of characters for a Automation Engine user. in BS2000 if there is no password in the Login objectAutomation Engine controlled activities and processes are structured in the form of objects. See also: Task.

Allowed values: "0" and "1" (default value)

"0" = Do not determine password.
"1" = Determine password.

USERID_TYPE=

Additional way for the OS to allow or reject access to certain users.

Allowed values: INCL, EXCL

"INCL" = Access must be granted for every single user specified in (USERID).
"EXCL" = Access is denied to the users that are specified in (USERID). All other users can start jobs.

ft_temp_file=

Creates temporary files in file transfers.

Allowed values: "yes" (default value) and "no"

"yes" - The file obtains a temporary name that is composed of the letter "T" and an alphabetic string that stems 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.
"no" - The agent assigns the final file name when the file transfer starts.

FileProcessingTimeout=

The time limit in second for the file search

The file search aborts when the specified time limit is reached.

No time limit applies when you either define the setting "0" (default) or "-1".

This parameter is relevant for FileSystem events and the scriptA particular Automation Engine object type. element GET_FILESYSTEM.

FileProcessingMaxDepth=

The maximum level of sub-directories for FileSystem events.

You use this setting in order to determine the extent to which the directory structure is included in your search for FileSystem eventAction that is triggered if particular conditions apply. It can be an Automation Engine object type or an entry in a Policy Orchestrator EventBase. files. The search directory serves as the basis for the maximum sub-directory level.

By limiting the directory level, you can improve the performance of FileSystem events especially when their folderTop level entities such as Environment, Deployment Target, Activity, … are stored in folders. The permissions a user has on an entity depend on the permissions that are set on the folder for the entities. structure is deeply nested and includes numerous files.

Allowed values:
"0" (default) = There is no limitation.
"1" = The files are only searched in the search directory. Sub-directories are not included in this search.
"2" = With this setting being used, the search for files includes the search directory and one directory level below.
"3" = The search includes the directory plus two sub-directory levels.
etc.

This parameter is relevant for FileSystem events and the script element GET_FILESYSTEM.

(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)

Entry of authorized BS2000 users in the format:
User name
=START

Entry of unauthorized BS2000 users in the format:
User name
=NO_START

(VARIABLES) This section contains the agent variables with agent information and settings.

(TRACE)

 

FILE= Name of the trace file.

You can enter the user ID here. If it is not entered, the trace file is written to the User ID under which the job has been executed.

The number signs serve as placeholders 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=
FILETRANSFER=
UCON=
RFC=
MEMORY=
Trace flags of the agent.

Allowed values: "0" (default value) to "9"

Trace flags should only be used in close cooperation with Automic Support.

(TCP/IP)  
PORT= Port number of the agent.
Other agents and the Job Messenger establish a connection with the agent by using this port number.

BINDADDR=

IP address or host name for the connection to the agent.

Use this parameter if the connection should be established via a particular IP address (for example, the computer has more than one network interface card).

Alternately, you can also specify the IP address or host name in PORT=

(Format: PORT=IP address:port or DNS name:port). Specifications made in BINDADDR= are then ignored.

BINDLOCAL=

Consideration of local host (127.0.0.1).

Use this parameter together with BINDADDR=.

Allowed values: "0" (default value), "1"

"0" - No listen socket is created.
"1" - An additional listen socket is created on the local host.

CONNECT=

Time interval in seconds during which the agent tries to establish a connection to the Automation Engines. 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: 240 seconds

This parameter is only effective until the first successful logon to the AE system. Afterwards, the parameter RECONNECT_TIME can be used in the host characteristics.

REPORT=

Time interval in seconds in which the agent sends the logging to the Automation Engine.

Default value: 60 seconds

CONNWAIT=

Time interval in seconds during which the agent waits for a response from the communication partner (CP or another agent). If the time limit is exceeded, the connection to the communication partner will be terminated again.

Default value: 20 seconds

CP=

Address of the communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. in the AE system to which the agent should connect.

Allowed formats:
DNS Name:Port number
TCP/IP Address:Port number

MAXMSGSIZE=

Maximum length of messages (in bytes) that the agent accepts.

Default value: 500 000

(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.

 

(RFC)

 

LOGON= File transfer: Evaluation of the User ID from the "File Transfer Parameters" tab .

Allowed values: "0" (default value) and "1"

"0" = The User ID is not evaluated. The file transfer runs with the agent's rights. Note that AE cannot ensure full auditing ability when you use this functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… because theoretically you can specify any user - even an invalid user.

"1" = User ID is evaluated. File transfer is executed with the user's rights. An additional Enter (RFC taskAn executable object that is running. Tasks are also referred to as activities.) is also started in the respective User ID.

PORT=  Port number that the RFC task uses to establish the connection to the agent.
TIMEOUT= Agent's maximum waiting time for the RFC task (seconds).
ENTERPAR= Additional parameters for the RFC task (see Enter command).

TASKTIMEOUT=

Time period in seconds after which an RFC task stops.

An RFC task that is started by an agent can handle multiple file-transfers orders. It ends if it does not receive a task for the time period that is defined here.

(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 connectiond in the chapter Multi-Server Operation.

The communication process that is defined in the parameter cp= (section [TCP/IP]) is not included in the cp list.

Format:
Port number
=DNS name
or
Port number
=TCP/IP address

Example of an INI File

(GLOBAL)
SYSTEM=UC4
NAME=BS2000
LOGGING=$UC4.L.LOGG.UCXJBXX.##
LOGCOUNT=10
LANGUAGE=(E,D)
LICENCE_CLASS=6
JOINREAD=1
USERID_TYPE=EXCL
ft_temp_file=yes


(AUTHORIZATION)
InitialPackage=
KeyStore=


(USERID)
TSOS=NO_START


(VARIABLES)
UC_HOST_CODE=BS2000_INTERNATIONAL
UC_HOST_JCL_VAR=BS2000
UC_EX_PATH_BIN=$UC4.UCX24.LIB
UC_EX_PATH_TEMP=$UC4.TEMP.
UC_EX_PATH_JOBREPORT=$UC4.JOB.REPORT.
UC_EX_JOB_MD=*MOD(LIBRARY=$UC4.UCX24.LIB,ELEMENT=UCXJB24M,RUN-MODE=*ADVANCED)


(TRACE)
FILE=$UC4.L.TRACE.UCXJBXX.##
TRCCOUNT=10
TCP/IP=0
FILETRANSFER=0
UCON=0
RFC=0


(TCP/IP)
PORT=2300
CONNECT=120
REPORT=60
CONNWAIT=20
CP=PC01:2217


(HOSTS)
; <AE-NAME>=<DNS-NAME> OR
; <AE-NAME>=<IP-ADDR>


(RFC)
LOGON=0
PORT=2400
TIMEOUT=90
ENTERPAR=,JOB-PRIORITY=8,START=*STD,RESOURCES=*PAR(RUN-PRIORITY=248)
TASKTIMEOUT=900


(CP_LIST)
2218=PC01

 


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

Copyright © 2016 Automic Software GmbH