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

RA Agent

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.

Structure of UCXJCITX.INI

Section/Parameter

Description

[GLOBAL]

 

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 "#".

Hyphens ("-") are only allowed in agent names. They must not be used in the names of any other objects.

Although agent names are limited to 32 characters, you should keep them under 25 characters. The last seven characters are used for adding the suffix '.NEW.nn' when a new agent is created from its template.

system=

AE system nameName of the Automation Engine instance to which a user is connected.
This entry must be identical to the entry in the INI file of the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes..

language=

Language for the logging

Allowed values: "E" (default value), "D" (German), "F"

logging=

Path and file name of the log file

The number signs serve as placeholders for a series in numerical order. When starting 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

max_logging_kb=

Maximum size of the log file

A new log file is created when the size specified here has been reached.

helplib=

Path and name of message file

checkRegisteredFile=

This optional field is available for OEBS agents used in a multi node system with different operating systems. In this case, this variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. should be set to 0 and no check will be performed. Therefore, the RA agent can register files that may not be valid file names on the OS where the RA agent runs.

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

"0" = Registered files are not checked.
"1" = Registered files are checked.

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

Java agents (SAP, RA, databaseA database is an organized collection of data including relevant data structures. and JMX) that run under UNIX create a keystore file with the following right: "-rw-r--r—". In doing so, other OS users can also access this file.

[RA]

 

cache_directory=

Directory to which the agent should store the RA Solutions.

[TCP/IP]

 

bindaddr=

IP address or hostComputer, target system. name for communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. connection

Use this parameter when the connection should be established via a particular IP address (e.g. the computer has more than one network interface card).

connect=

Time interval in seconds in which the agent attempts to establish connection to the Automation Engines. Affects the connection setup 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: 60 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.

cp=

Address of the communication process in the AE system to which the agent should connect itself.

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

[VARIABLES]

This section contains agent variables with agent information and settings.

[TRACE]

 

file=

Path and file name of the trace file

The number signs serve as placeholders for a series in numerical order. When starting 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

max_trace_kb=

Maximum size of the trace file

A new trace file is created when the size specified here has been reached.

tcp/ip=

Trace flag of the agent

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

Set trace flags only in close cooperation with our support team.

ra=

Trace flag of the Rapid Automation agent

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

"0" = Rapid Automation trace-file writing is deactivated.
"1" - "9" = Rapid Automation trace-file writing is activated at the specified level. "1" is the lowest level, "9" is full trace. When you need to set Rapid Automation agent trace, you almost always set it to "9".
"10" - "12" = Full trace is set, additionally third-party library trace is set if it exists. The Web Service agent has third-party trace. Third-party library trace can only be done in this file. It cannot be set through the UserInterfaceThis is the Automation Engine's graphical user interface. [Formerly called the "Rich Client", "RichGUI" and "Dialog Client."] like for other agents.

[CP_LIST]

List of communication processes

This listShows entities in a grid view is created when the agent starts and extended when new communication processes are activated. More detailed information about establishing a connection is provided in the chapter Multi-Server Operation.

The communication process which has been 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=AE name=RA01 logcount=10 logging=../temp/CIT_LOGG_##.TXT max_logging_kb=50 language=E helplib=uc.msl


[AUTHORIZATION]
InitialPackage=
KeyStore=


[RA] cache_directory=cache


[TCP/IP] connect=20 cp=localhost:2217


[VARIABLES] uc_host_jcl_var=CIT


[TRACE] file=../temp/CIT_TRACE_##.TXT trccount=10 max_trace_kb=1000 tcp/ip=0 ra=12


[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