Administration Guide > Installation > New Installation > Installing the Agent for NSK

Installing the Agent for NSK

This document guides you through the new installation of an NSK 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 following guide describes how to install an agent in an AE system in which authentication is not used.

Additional installation steps are required before the agent can be started and used if you intend to use one of the available authentication methods. More detailed information is provided in the document Advanced Security.

A three-character code is assigned to each supported NSK version. It is shown in the agent's file name and described in the Terminology (NS1 for NSK, Version D40 and later).

Requirements

Supplied Files

The files are packed in an archive file and stored in the subdirectory IMAGE:AGENTS\NSK.

File name File type Description

UC4DDL

Text

DDL description for usage in EMS filters to filter Automic related events.

UC4MACS

Text

Tacl macros used by the Automic agent, can be extended by customer if needed.

UC4TMPL

Text

EMS template file to be used with EMS if required.

UCMSL

Binary

Message texts used by the agent.

UCXBNI6C

Binary, executable

Example program showing usage of call API.

UCXBNI6O

Binary, library

Call API link library

UCXFTSRV

Binary, executable

Automic server program used for file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object)., will be automatically stopped and started by the agent when using file transfers.

UCXJNI6

Binary, executable

Automic agent

UCXJNI6M

Binary, executable

Automic program used to shutdown the agent.

UCXJNI6O

Binary, executable

Output collector used by the agent.

UCXJNI6R

Binary, executable

Used for internal purposes only, will simply output command line arguments in certain format.

UCXJNI6T

Binary, executable

Virtual terminal program, started to be used as a dummy input/output device

UCXSCAN

Binary, executable

Scan program internally used by the agent if file system scans for file patterns are requested.

UCYBWAIT

Binary, executable

Used for internal purposes only, will simply create a given delay.

CallAPI files and their implementation are described in a separate document.


Procedure

1. Transferring the files to the hostComputer, target system.
2. Starting the installation procedure

O OINSTALL

3. Adjusting the configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. file INSTINI

Parameter

Description

AE-PROGRAM-SUBVOLUME=

Sub-volume for the executable agent files.

AE-STATUS-STORE-SUBVOLUME=

Sub-volume for the StatusStore files of file transfers.

The agent automatically created StatusStore files. They store the restartA restart refers to the repetition of an object's execution. This action differs from a new start in some parts. information of active file transfers. This mechanism ensures that aborted file transfers can be restarted from a particular file position (= last restart point). Restart points are created in regular intervals (setting FT_RESTART_INTERVAL in the variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. UC_HOSTCHAR_DEFAULT). On Nonstop systems, the StatusStore files are the following 4 Enscribe Files with the default names: UC4SST, UC4SSD, UC4SSL, UC4SSH. You can subsequently change these file names in the agent's INI file.

AE-STATUS-STORE-AUDITED=

Stores StatusStore files of file transfers as Audited Files (TMF protection).

Allowed values: "Y" (recommended default value) or "N"

AE-TCPIP-PROCESS=

Name of the NonStop TCP/IP process name that the agent should use. By default, $ZTC0 is specified (system standard).

If you specify a different process name, the required ADD DEFINE TACL statement is automatically inserted in the startup obey file.

AE-SERVER-PORT

Port number of the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes.'s communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. to which the agent should connect. Ensure that all affected firewalls are configured for this port.

AE-AGENT-PORT=

Port number that the agent should use in order to contact other agents. This port cannot be used by other programs.

AE-SERVER-IP-ADDRESS=

IP address or computer name of the Automation Engine.

AE-AGENT-PROCESS=

Process name of the agent process.

AE-OC-PROCESS=

Process name of the AE output collector process.

AE-TSIM-PROCESS=

Process name of the AE terminal simulator process.

AE-SYSTEM-NAME= Logical name of the AE system (Automation Engine)

AE-AGENT-NAME=

Logical name of the agent instance.

By default, the system nameName of the Automation Engine instance to which a user is connected. of the NonStop ServerYou can use nonstop processes (NWP) in order to increase your system reliability. A specific license is required for this purpose. In nonstop operation, only the WPs of one computer are active. The processes of a different computer (nonstop processes) are available upon request. If the primary computer that includes the active WPs fails, the nonstop processes take over their role. As opposed to a usual parallel operation, the system configuration NonStop Server does not use the WPs of all computers. The WPs of ony computer are always in the mode "hot standby." [Formerly called "UC4.Nonstop Server."] without "\"  is used as the agent name:

AE-AGENT-NAME=%NODENAME%

You can also extend the agent name using pre- or postfixes.
For example:

AE-AGENT-NAME=UC4%NODENAME%EXE

AE-TEMP-SUBVOLUME=

All temporary files, such as job reports and job files, are stored in this sub-volume.

4.

Continuing the installation

5.

Starting and stopping the Agent

 

See also:

EMS template file

 


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

Copyright © 2016 Automic Software GmbH