Administration Guide > Installation > New Installation > Installing the CallAPI for SAP

Installing the CallAPI for SAP

This document guides you through the new installation of a 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. for SAP.

AE supplies a CallAPI for SAP. You can use this interface to directly run AE Scripts from ABAP programs. The CallAPI is represented by an RFC Server that includes the functionPre-defined run book template in the Automation Engine. One single step only, e.g. Start Windows Service, Copy file,… module "AE." You call this module directly from ABAP.

The CallAPI for SAP is available under UNIX and Windows.

A three-character code is assigned to each supported UNIX variant. This code appears in some file names and is described in the terminology (AP6 for AIX, for example). Throughout this document the specific code is replaced by "???."

Supplied Files

The files that belong to the CallAPI are provided in the subdirectories of the IMAGE:CallAPI\SAP. The subdirectory \SAMPLE contains examples. These examples are not platform-specific.

Windows

UNIX

Description

ucxsapc.jar

ucxsapc.jar

RFC Server

ucxsapc.ini

ucxsapc.ini

INI file for RFC Server

uccall3.jar

uccall3.jar

CallAPI for JAVA

uc.msl

uc.msl

Message library

 


Technical Implementation

Diagram of the technical implementation

 


Putting into Operation

Note that a sound knowledge of  SAP's RFC technology is required put the RFC Server into operation.

1. Installing the Java Runtime Environment (JRE)

If JRE is already available in the required version, you can skip this step.

java -version

If several JRE or Java SDK versionsAn application version holds zero or more deployment packages and may have dependencies to zero or more application versions of the same (or to different) applications are installed on the computer, the order of the directories that is indicated in the settings of %PATH% or $PATH is relevant. The particular Java Runtime Environment that is listed first in the listShows entities in a grid view of directories is applied.

2.

Transferring the files

Windows:

UNIX:

(Linux: tar -zxvf ucs???.tar.gz)

The files that are supplied appear in their corresponding directories. The tar file can then be deleted after unpacking.

AIX: export LIBPATH=Paths of the installation directories

HP-UX: export SHLIB_PATH=Paths of the installation directories

Solaris, Linux, zLinux: export LD_LIBRARY_PATH=Paths of the installation directories

Example for HP-UX:
The CallAPI for SAP was installed in /opt/uc4/callapi/bin and the RFC library in /opt/uc4/callapi/rfclib. The environmentAn Environment consists of Deployment Targets which represent your endpoints. Different environments are used for different phases in the software delivery cycle, for example Development, QA, Staging, Production. An environment is typically set up once and used by several applications. variable must be set as follows:

export SHLIB_PATH=//opt/uc4/callapi/bin:/opt/uc4/callapi/rfclib

3. Installing the SAP Java Connector

AIX: export LIBPATH=path of the installation directory

HP-UX: export SHLIB_PATH=path of the installation directory 

Solaris, Linux, zLinux: export LD_LIBRARY_PATH=path of the installation directory

Example for HP-UX:
The CallAPI for SAP is installed in /opt/uc4/callapi/bin. The SAP Java Connector must be stored in the same directory. Set the environment variable as follows:

export SHLIB_PATH=//opt/uc4/callapi/bin

 

4.

Adjusting the INI file for the RFC Server program

Adjust the file ucxsapc.ini according to your environment. The sections [CP_LIST] and [RFC] are the essential parameters. The section [CP_LIST] contains the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. data. The section [RFC] determines the SAP Gateway to which the RFC Server registers.

Example for the INI-file sections [RFC] and [CP_LIST]: 

[RFC]

hostname=sap01

PROGID=TEST

GWSERV=sapgw00

RFC_TRACE=1

unicode=1

 

[CP_LIST]

2217=fsu

It is not required to use a new INI file with each new Automation Engine version. Just make sure to update your INI file. The relevant information is provided in the Release Notes, which are available in the manual Release Notes.  

5. Starting the RFC Server

The RFC Server can run as a service under Windows. In UNIX, you can either use the ServiceManagerA program that facilitates the starts and stops of Automation Engine components. or start using the command nohup.

The RFC Server can be called with the Java Application Launcher using the following parameters (optional):  

File name Start parameter

Description

ucxsapc.jar -IPath and file name Path and name of the INI file for the RFC Server
-V

Outputs the Automation Engine version including the hotfix number in the following format:

"ucxsapc version Automation Engine version plus hotfix number"

-VPath and file name

Outputs the Automation Engine version including the hotfix number to the file in the following format:

"ucxsapc version Automation Engine version plus hotfix number"

The following command-line call can be used to start the RFC Server:

java -jar ucxsapc.jar

Use the following command to start the RFC Server on a HP-UX platform (64 bit): 

java -d64 -jar ucxsapc.jar

5. Checking the registration in the SAP system

Start the transaction "SMGW" with SAPGUI or log on to the Gateway Monitor via Tools -> Administration -> System Monitoring -> Gateway-Monitor. Select Jump -> Registered Systems. The started server program should be shown in system type REGISTER_TP.

Example of an Overview

LU name   TP name   Host name       Host address      System type  Request
R31       sapgw00   R31             193.154.170.111   LOCAL_R3    16:33:07
wgntw13   uc4call   WGNTW13         193.154.170.13    REGISTER_TP 12:11:18
R31                 R31             193.154.170.111   REMOTE_GWY  10:25:14

6. Defining the RFC destination in the SAP system

Start the transaction "SM59" or log on via Tools -> Administration -> Management -> Network -> RFC Destination. Specify a TCP/IP connection:

If the SAP system consists of several applicationAn application is a software which helps a user to fulfill specific tasks. In the context of ARA see also: Application entity. servers, the SAP Gateway on which the RFC Server registeredThis is the status of a task that runs within a group and is waiting for its start. should also be entered in the RFC destination. Otherwise, ABAP programs can only establish a connection if they run on the same application server as the one on which the RFC Server has registered.

Example of a TCP/IP connection

Test the connection using the button Test Connection.

Example of a test result

Connection type:   TCP/IP connection
Logon:             1,360 msec
0  KBytes:           264 msec
10 KBytes:            39 msec
20 KBytes:            62 msec
30 KBytes:            45 msec

A successful test result indicates that the CallAPI is ready for operation.

See also:

CallAPI for SAP

 


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

Copyright © 2016 Automic Software GmbH