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.
Scripts are always activated with the following steps:
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 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.
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: |
UC-ERROR-CODE |
PIC X |
The error code in cErrorCode is automatically set and can contain one of the following values: " " - no error occurred |
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 |
FILLER |
PIC X(2) |
Not used |
UC-OUTPUT-LEN |
PIC 9(8) COMP-4 |
Not used |
UC-RUNNR |
PIC 9(8) COMP-4 |
|
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 |