Application Integration Guide > CallAPI > CallAPI and your own program > Cobol

 Cobol

The CallAPIA programming interface that processes a script in the Automation Engine system. It can be called directly from within the program itself or from a different program. can be used to process scripts in the AE system from your own  Java programs.

The delivery directory contains sample programs that provide a detailed description of how a scriptA particular Automation Engine object type. activation can be implemented.

General

Scripts are always activated with the following steps:

  1. Log on to the AE system.
  2. Transfer the script to the AE system.
  3. Log off from the AE system.

You can log on to several AE systems at the same time and process various scripts. In this case, a Dialog license is used for each connection.

Call

Call the CallAPI using the command CALL UCCALL3. Return code 0 is supplied if the actionActions are predefined building blocks for recurring activities. They are commonly used for managing third party systems or in deployment scenarios. was successful or a message number if an error occurred.

Description

Call

Logging on to the AE system

CALL UCCALL3 USING structure, loginAn Automation Engine object type that stores account credentials used by agents on target systems. data, connection

Format for login data:  
Client, 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.
, [departmentDepartment name to which the Automation Engine user belongs., [passwordA secret combination of characters for a Automation Engine user.]]

Format for connection data for the communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components.:
DNS name:port number

or
TCP/IP address:port number

Activating a script

CALL UCCALL3 USINGstructure, script

Logging off the AE system

CALL UCCALL3 USING structure

Variables

The supplied sample program explains the structure AE-RECORD. It contains the following variables:

Variable

Data type

Description

UC-OPERATION

PIC X(4)

Operation code

This variableIt stores or retrieves values dynamically at runtime. An individual Automation Engine object type. must be set if the universal functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… should be used.

Allowed values:
"OPC_LOGON" - logs on to the AE system
"OPC_LOGOFF " - logs off the AE system
"OPC_ACTIVATE_SCRIPT" - activates a script

UC-ERROR-CODE

PIC X

The error code in cErrorCode is automatically set and can contain one of the following values:

" " - no error occurred
"P" - invalid parameter(s)
"O" - invalid opcode
"I" - initialization failed
"Q" - login failed
"R" - memory allocation failed
"L" - memory 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. failed
"S" - socket error
"T" - timeout
"U" - error message of the AE system

UC-INTERFACE-NR

PIC X(3)

The interface number must always contain the value 3.

UC-SYSTEM-NAME

PIC X(8)

Name of the AE system to which the connection should be established

UC-TIMEOUT

PIC 9(4) COMP-4

Time in seconds during which the CallAPI waits for an AE system response

UC-LANGUAGE

PIC X

Language in which messages are output

FILLER

PIC X(2)

Not used

UC-FLAG1

PIC X

Depending on the specified value, this flag results in one of the processing options listed below:

"CALL_FLAG1_INI_SERVER" - connection to communication process is retrieved from INI file
"CALL_FLAG1_INI_LOGIN" - login data is retrieved from INI file
"CALL_FLAG1_INI_USEMSL" - converts variable message parts to a complete message text
"CALL_FLAG1_INI_USEALL" - settings made in the INI file section [GLOBAL] are used
"CALL_FLAG1_TRC_HANDLE" - for internal CallAPI processing only
"CALL_FLAG1_LOG_HANDLE" - for internal CallAPI processing only
"CALL_FLAG1_INI_FILE" - name of INI file
"CALL_FLAG1_TRC_OUTPUT" - for internal CallAPI processing only

FILLER

PIC X(2)

Not used

UC-OUTPUT-LEN

PIC 9(8) COMP-4

Not used

UC-RUNNR

PIC 9(8) COMP-4

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 . of the script

UC-RETURN-CODE

PIC 9(8) COMP-4

Return code of script execution

UC-MESSAGE-TEXT

PIC X(256)

Variable message part explaining the return codeThe value that represents the result of tasks and script functions.'s value

UC-PRT-INI

PIC S9(8)

For internal CallAPI processing only

UC-HND-LOG

PIC S9(8)

For internal CallAPI processing only

UC-HND-TRC

PIC S9(8)

For internal CallAPI processing only

UC-HND-HLP

PIC S9(8)

For internal CallAPI processing only

UC-POINTER

PIC S9(8)

For internal CallAPI processing only

FILLER

PIC X(12)

Not used

UC-INIFILE

PIC X(45)

Path and name of INI file

 

See also:

About the CallAPI

 


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

Copyright © 2016 Automic Software GmbH