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

 Java

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.

This requires the class UCCALL3 to be imported from the 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. com.uc4.uccall3.

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

Detailed information about the Java class is provided in the included documentation.

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.

Methods

In your program, you can use the functions listed below.

Description

Data type of return codeThe value that represents the result of tasks and script functions.

Function

Logging on to the AE system

boolean

logon()
logon
(clientA closed environment within an Automation Engine system where you can create and run objects. A client name consists of a 4-digit number that must be indicated when a user logs on to the Automation Engine system. Users and their rights are also defined in clients. A particular Automation Engine object type., 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.]])
logon
(specifications)

Data type of client: int
Data type of user: java.lang.String
Data type of department: java.lang.String
Data type of password: java.lang.String
Data type of specifications: java.util.Properties

The Java class "Properties" is used for specifications to be made. The following parameters can be configured:

"system" - name of the AE system to which a connection should be established
"language" - message language
"timeout" - period in seconds during which the CallAPI waits for an AE system response
"client" - client
"user" - user
"dept" - department
"pass" - password
"cpn_hostComputer, target system." - DNS name or TCP/IP address of the computer on which the communication processA communication process is part of the component Automation Engine. It is responsible for connecting the components. runs
"cpn_port" - port number of the communication process

Retrieving a connection error

java.lang.String

getConnectionError()

Specifying INI file

void

setConfigurationFile(path and name of INI file)

Data type of script: java.lang.String

Activating a script

java.lang.String

activateScript(script)

Data type of script: java.lang.String

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

int

getRunNumber()

Logging off the AE system

void

logoff()

 

See also:

About the CallAPI

 


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

Copyright © 2016 Automic Software GmbH