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

 Java

The CallAPI 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 package com.uc4.uccall3.

The delivery directory contains sample programs that provide a detailed description of how a script 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 code

Function

Logging on to the AE system

boolean

logon()
logon
(client, user, [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_host" - DNS name or TCP/IP address of the computer on which the communication process 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 RunID of the last activated script

int

getRunNumber()

Logging off the AE system

void

logoff()

 

See also:

About the CallAPI