Programming Guide

OpenText Activator for SAP Solutions

This guide describes the components of Activator and contains

tutorials for its implementation.

LLESSAP100000-PGD-EN-1
Programming Guide
OpenText Activator for SAP Solutions
LLESSAP100000-PGD-EN-1
Rev.: 2011-Sept-28
This documentation has been created for software version 10.0.
It is also valid for subsequent software versions as long as no new document version is shipped with the product or is
published at https://knowledge.opentext.com.
Open Text Corporation
275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1
Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Email: [email protected]
FTP: ftp://ftp.opentext.com
For more information, visit http://www.opentext.com

Copyright © by Open Text Corporation, Open Text Inc.

Open Text Corporation is the owner of the trademarks Open Text, OpenText, The Content Experts, OpenText ECM Suite,
OpenText eDOCS, eDOCS, OpenText FirstClass, FirstClass, OpenText Exceed, OpenText HostExplorer, OpenText Exceed
OnDemand, OpenText Exceed 3D, OpenText Exceed Freedom, OpenText Exceed PowerSuite, OpenText Exceed XDK,
OpenText NFS Solo, OpenText NFS Client, OpenText NFS Server, OpenText NFS Gateway, OpenText Everywhere, OpenText
Real Time, OpenText Eloquent Media Server, OpenText Integrated Document Management, OpenText IDM, OpenText
DocuLink, Livelink, Livelink ECM, Artesia, RedDot, RightFax, RKYV, DOMEA, Alchemy, Vignette, Vizible, Nstein,
LegalKEY, Picdar, Hummingbird, IXOS, Alis Gist-in-Time, Eurocortex, Gauss, Captaris, Spicer, Genio, Vista Plus, Burntsand,
New Generation Consulting, Momentum Systems, DOKuStar, and RecoStar among others. This list is not exhaustive.
All other products or company names are used for identification purposes only, and are trademarks of their respective own-
ers. All rights reserved.
 Table of Contents

1 Activator basics......................................................................... 5
1.1 Components............................................................................................. 5
1.2 Structure................................................................................................... 6

2 SAP OSpace .............................................................................. 7

2.1 RFC/BAPI API.......................................................................................... 7
2.2 Configuration API ................................................................................... 11

3 Tutorials ................................................................................... 15
3.1 Using the SAP OSpace.......................................................................... 15
3.2 Using the configuration API ................................................................... 19

IDX Index......................................................................................... 23

LLESSAP100000-PGD-EN-1 Programming Guide iii

Chapter 1
Activator basics
OpenText Activator for SAP Solutions (Activator) extends Content Server to connect
to SAP systems and call RFCs (Remote Function Calls).

1.1 Components
The Content Server loads a Java library (jsaprfc.jar) that contains a Java class
(JRFC) that acts as a wrapper of SAP's JCo library.
The communication between Content Server and an SAP server is done by the SAP
JCo 3.0 library.

Activator implements a storage for connection configuration data in the Content

Server database. Applications can use the SAP Systems configuration pages
provided by Activator, which eliminates the need of a custom implementation of
such configuration pages.
For detailed information on how to use the configuration pages, see OpenText
Activator for SAP Solutions - Installation and Configuration Guide (LLESSAP-IGD).
All functions needed to call RFCs or BAPIs are included in the SAP OSpace; this
SAP OSpace wraps the Java calls needed to perform RFCs. All database access

LLESSAP100000-PGD-EN-1 Programming Guide 5

Chapter 1 Activator basics

regarding SAP system configuration data are hidden in the configuration API of the
SAP OSpace.
Custom OScript can use the configuration API to retrieve the list of configured SAP
systems and to connect to a specific SAP system. To call RFCs or BAPIs, the
RFC/BAPI API of the SAP OSpace provides the necessary functions.

1.2 Structure
This guide covers the following:
• Overview of the components of Activator.
• Tutorials: The first tutorial gives an example on how to use the features available
in the SAP OSpace. The second tutorial makes use of the SAP system configura-
tion API.

6 Programming Guide LLESSAP100000-PGD-EN-1

Chapter 2
SAP OSpace
Activator encapsulates the SAP JCo Java classes within an OScript API.
The API is subdivided in two parts:
RFC/BAPI API
This API creates new temp objects for RFCs or BAPI methods and provides
importing, exporting and table parameters as features of these temp objects.
Configuration API
This API provides access to the SAP systems configuration data that is
maintained by administrators in the Content Server administration pages.

2.1 RFC/BAPI API

2.1.1 $SAP.RFC ConnectEx function (String, String, String,
String, String, String, String, String, String, String,
String)
Connects to the specified SAP system and returns the initialized JCoDestination
object.
Parameters
destination
Type: string
The SAP destination name; this parameter is case-sensitive.
type
Type: string
The RFC connection type. Use value A for the application server (parameter
ashost must be specified), value B for load balancing using message server
(parameters mshost and pool must be specified).
ashost
Type: string
The SAP ABAP application server hostname; mandatory for a direct
connection. Specify empty string if RFC connection type is B.
mshost
Type: string
The SAP message server hostname; mandatory for a logon balancing
connection. Specify empty string if RFC connection type is A.

LLESSAP100000-PGD-EN-1 Programming Guide 7

Chapter 2 SAP OSpace

sysnr
Type: string
The system number of the SAP ABAP application server; mandatory for a
direct connection.
client
Type: string
The SAP client; mandatory logon parameter. Client numbers are usually
three-digit numbers.
user
Type: string
The SAP user name used to log in to the SAP system.
pass
Type: string
The password associated with the SAP user name.
lang
Type: string
The code for the logon language; parameters are e.g. DE (German) or EN
(English).
groupname
Type: string
The group of SAP application servers; mandatory for a logon balancing
connection.
sysid
Type: string
The system ID of the SAP system; mandatory for a logon balancing
connection.
Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.connection: JCoDestination object already connected to SAP system (.OK is
true).
.exception: Assoc with exception data if .OK is false and an exception occurred.

2.1.2 $SAP.RFC New function (Dynamic, String)

Creates a new temp of the base RFC object if it does not already exist for the given
RFC name.
The feature jcoConnection will be set with the given JCoDestination object; the
features OSName and fRfcName will be set with the name of the RFC.
In $SAP.RFC New, the target SAP system gets called to retrieve the description of the
function interface of the desired RFC; the function then uses this information to
create features for each RFC parameter. In addition, an Assoc fImports is created

8 Programming Guide LLESSAP100000-PGD-EN-1

 2.1 RFC/BAPI API

with all import parameters and an Assoc fExports is created with all export
parameters. Table parameters are added to the fImports and fExports.
To set values of importing or table parameters, just set the values of the features
with the name of the parameter in the newly created RFC object.
Parameters
connection
Type: dynamic
The JCoDestination instance to be used for connecting to the SAP system.
rfcName
Type: string
Name of the RFC for which the RFC object should be created.
Return Value
Type: $SAP.RFC
A new temp of a $SAP.RFC object or undefined in case of an error.

2.1.3 $SAP.RFC Call function

Calls the RFC that was specified with the $SAP.RFC New function. The
implementation of the $SAP.RFC Call function passes every importing or table
parameter to the actual JCo call and executes the RFC. The features of the $SAP.RFC
object that represent the exporting or table parameters are set with the values
returned by the RFC.
Return Value
Type: Assoc
.OK: true if execution of $SAP.RFC Call was successful, otherwise false.
.message: error message (.OK is false).
.stacktrace: Java stacktrace (.OK is false).

2.1.4 $SAP.RFC Delete function ($SAP.RFC temp object)

Releases the temp object of $SAP.RFC; this also releases the internally stored
JCoDestination object.

Parameters
rfcObject
Type: object
The $SAP.RFC temp object to be deleted.

2.1.5 $SAP.BAPI ConnectEx function (String, String, String,

String, String, String, String, String, String, String,
String)
Identical to the $SAP.RFC ConnectEx function; for details see 7.

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 9

Chapter 2 SAP OSpace

2.1.6 $SAP.BAPI New function (Dynamic, String, String)

Creates a new temp of the base BAPI object if it does not already exist for the given
BAPI name and BAPI method. Then it creates a new child object of the temp for the
specified method.
The feature jcoConnection will be set with the given JCoDestination object; the
features OSName and fBapiName will be set with the name of the BAPI.
The implementation of the $SAP.BAPI New is calling SWO_BUSINESS_OBJECTS_GET to
get the list of BAPIs and then RPY_OBJECTTYPE_READ to get keyfields, methods,
methodParams, methodExceptions and documentation of the BAPI.
For each method a new child object of the new temp of $SAP.BAPI is created. The
feature OSName is set with the method name. The feature fBapiMethodName is set
with the uppercase method name. Features are created for each import, export and
table parameter. In addition, an Assoc fImports is created with all import
parameters and an Assoc fExports is created with all export parameters. Table
parameters are added to the fImports and fExports, exceptions are added to the
Assoc fExceptions. To set values of importing or table parameters, just set the values
of the features with the name of the parameter in the newly created BAPI method
object.
Note: $SAP.BAPI behaves like $SAP.RFC but with the difference that for the
BAPI methods new child objects are created and the parameters are added as
features to this child object.
Parameters
connection
Type: dynamic
The JCoDestination instance to be used for connecting to the SAP system.
bapiName
Type: string
Name of the SAP business object type (BAPI).
bapiMethod
Type: string
Name of the method of the specified SAP business object type.
Return Value
Type: $SAP.BAPI
A new temp of a $SAP.BAPI object or undefined in case of an error.

2.1.7 $SAP.BAPI Call function

Identical to the $SAP.RFC Call function; for details see 9.

2.1.8 $SAP.BAPI Delete function ($SAP.BAPI temp object)

Identical to the $SAP.RFC Delete function; for details see 9.

10 Programming Guide LLESSAP100000-PGD-EN-1

 2.2 Configuration API

2.2 Configuration API

Activator has a database table (OTSAPACT_SYSTEMS_CFG) for storing configuration
data, which is maintained by an administrator using the SAP Systems
administration pages of the Content Server Administration.
An OScript API allows retrieving the configuration data without needing to know
the schema of the database table. Therefore OpenText recommends using the
following functions to access the SAP system configuration.

2.2.1 $SAP.SapSystems ConnectToDestination function

(Object, String)
Connects to an SAP system that is configured with its connection parameters in the
SAP Systems administration pages of the Content Server Administration.
All connection parameters required, including user name and password are taken
from the SAP system's configuration settings that are stored in the Content Server
database.
Parameters
prgCtx
Type: object
Program context
destination
Type: string
Name of the logical SAP system. Must be configured by using the SAP
Systems administration pages of the Content Server Administration.
Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.connection: JCoDestination instance (.OK is true).

2.2.2 $SAP.SapSystems ExistsSapSystem function (Object,

String)
Checks the Content Server database for an SAP system configuration for the
specified logical SAP system name.
Parameters
prgCtx
Type: Object
Program context
destination
Type: String
Name of the logical SAP system.

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 11

Chapter 2 SAP OSpace

Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.found: number of configured SAP systems with the specified logical SAP
system name.

2.2.3 $SAP.SapSystems GetEnabledSapSystems function

(Object)
Returns an Assoc with the configuration data of all configured SAP systems that are
enabled.
Parameters
prgCtx
Type: object
Program context
Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.sapsystems: Assoc with an Assoc item for each SAP system. The key in the
.sapsystems Assoc is the logical SAP system name. Each of the SAP system
items has the following elements:
• DEST: Logical SAP system name.

• ASHOST: Application server hostname.

• MSHOST: Message server hostname.

• GROUPNAME: Group of SAP application servers; mandatory for a logon

balancing connection.
• RFCTYPE: RFC connection type.

• SYSNR: SAP system number.

• BASEURL: Configurable URL part that is permanent for this SAP system; can
be used by applications to build URLs for accessing SAP transactions via the
web browser.
• USERNAME: Username to be used for logging into the SAP system.

• PASSWORD: Password that belongs to the USERNAME; encrypted by the Content

Server data encryption key.
• CLIENT: Client number to be used for logging into the SAP system.

• ENABLED: Enabled flag.

12 Programming Guide LLESSAP100000-PGD-EN-1

 2.2 Configuration API

• SAPSYSTEMID: SAP system ID (SAP server and client number constitute the
unique SAP system ID).

2.2.4 $SAP.SapSystems GetSapSystem function (Object,

String)
Returns an Assoc with the configuration data of the specified SAP system.
Parameters
prgCtx
Type: object
Program context
destination
Type: string
Name of the logical SAP system.
Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.sapsystem: Assoc with configuration data for the SAP system.
For the description of the Assoc’s elements see “$SAP.SapSystems
GetEnabledSapSystems function (Object)” on page 12.

2.2.5 $SAP.SapSystems GetSapSystems function (Object)

Returns an Assoc with the configuration data of all configured SAP systems
independently whether they are enabled or not.
Parameters
prgCtx
Type: object
Program context
Return Value
Type: Assoc
.OK: true if call of $SAP.RFC Connect was successful, otherwise false.
.errMsg: error message (.OK is false).
.sapsystems: Assoc with an Assoc item for each SAP system.
For the description of the Assoc’s elements see “$SAP.SapSystems GetEnabled-
SapSystems function (Object)” on page 12.

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 13

Chapter 3
Tutorials
In the following you find tutorials for the practical usage of the different methods.

3.1 Using the SAP OSpace

3.1.1 Calling RFC RFC_READ_TABLE
Use Content Server Builder and create a new empty script. Paste the following code
into it, compile and run the script. If successfully performed, it displays the number
of records of the requested table to the debug output.
Procedure The OScript below does it by performing the following steps:
1. Connect to the SAP system by calling $SAP.Rfc.ConnectEx.
2. Create a new instance of the $SAP.RFC object for RFC_READ_TABLE.
3. Set a importing parameter and call the RFC.
4. Get the requested data from the returned data and echo the results to the debug
output window.
5. Release the $SAP.RFC object.
Code

Assoc result
Assoc retval
retval.ok = true
Boolean ok = true

String destination = "DPX"

String type = "A"
String ashost = "mucr3dpx"
String mshost = ""
String sysnr = "01"
String client = "800"
String user = "mysapuser"
String pass = "xxx"
String lang = "en"
String groupname = ""
String sysid = ""

Dynamic connection = undefined

Object rfcMethod = undefined

LLESSAP100000-PGD-EN-1 Programming Guide 15

Chapter 3 Tutorials

RecArray records = undefined

// 1) connect to the SAP system by using the given connection

parameters

result = $SAP.Rfc.ConnectEx( destination, type, ashost, mshost,

sysnr, client, user, pass, lang, groupname, sysid )
if result.OK
connection = result.connection
else
retval.ok = false
retval.errMsg = result.errMsg
ok =false
end

// 2) create a new instance of the $SAP.RFC object for RFC_READ_TABLE

if ok
rfcMethod = $SAP.RFC.New( connection, "RFC_READ_TABLE" )
if IsUndefined( rfcMethod )
retval.errMsg = "ERROR: can't create $SAP.Rfc object for
_ _
RFC READ TABLE - see thread log for more information"
retval.ok = false
ok = false
end
end

// 3) set a importing parameter and call the RFC

if ok
rfcMethod.QUERY_TABLE = "USR01"
result = rfcMethod.Call()
if result.ok == false
ok = false
retval.ok = false
retval.errMsg = Str.Format( "ERROR: rfcErrorGroup: %1,
rfcErrorKey: %2, rfcErrorMessage: %3, rfcErrorCode: %4.",
result.rfcErrorGroup, result.rfcErrorKey, result.rfcErrorMessage,
result.rfcRetCode )
else
// retrieve the results
records = rfcMethod.FIELDS
end
end

// 4) display the results - just display the number of records for

simplicity or the error message

if ok
echo ( Str.Format( "Table %1 has %2 records.",

16 Programming Guide LLESSAP100000-PGD-EN-1

 3.1 Using the SAP OSpace

rfcMethod.QUERY_TABLE, Length( records ) ) )

else
echo ( retval.errMsg )
end

// 5) cleanup

if IsDefined( rfcMethod )
$SAP.RFC.Delete( rfcMethod )
end

When you run the script, you will get the following output in the debug window:

Table USR01 has 18 records.

3.1.2 Calling BAPI method GetList of BAPI EmployeeAbstract

In the following example the method GetList of the BAPI EmployeeAbstract is
called to retrieve the employee data for a specific person. The personnel number is
specified to get only the data for one specific employee.
Procedure The OScript below does it by performing the following steps:
1. Connect to the SAP system by calling $SAP.Rfc.ConnectEx.
2. Create a new instance of the $SAP.BAPI object for BAPI Employee and method
GetList.

3. Set an importing parameter and call the BAPI method.

4. Check BAPI return value and retrieve the results.
5. Echo the results to the debug output window.
6. Release the $SAP.BAPI object.
7. Use Content Server Builder and create a new empty script. Paste the following
code into it, compile and run the script. If successfully performed, it displays the
name of the requested employee in the debug output.
Code

Assoc result
Assoc retval
retval.ok = true
Boolean ok = true

String destination = "DPX"

String type = "A"
String ashost = "mucr3dpx"
String mshost = ""
String sysnr = "01"
String client = "800"

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 17

Chapter 3 Tutorials

String user = "mysapuser"

String pass = "xxx"
String lang = "en"
String groupname = ""
String sysid = ""

Dynamic connection = undefined

Object bapiMethod = undefined
RecArray records = undefined

// 1) connect to the SAP system by using the given connection

parameters

result = $SAP.Rfc.ConnectEx( destination, type, ashost, mshost,

sysnr, client, user, pass, lang, groupname, sysid )
if result.OK
connection = result.connection
else
retval.ok = false
retval.errMsg = result.errMsg
ok =false
end

// 2) create a new instance of the $SAP.BAPI object for BAPI Employee

and method GetList

if ok
bapiMethod = $SAP.BAPI.New( connection, "EmployeeAbstract",
"GetList" )
if IsUndefined( bapiMethod )
retval.errMsg = "ERROR: can't create $SAP.BAPI object for
BAPI Employee and method GetList - see thread log for more
information"
retval.ok = false
ok = false
end
end

// 3) set a importing parameter and call the BAPI method

if ok
bapiMethod.PersonnelNumber = "00001006"
result = bapiMethod.Call()
if result.ok == false
ok = false
retval.ok = false
retval.errMsg = Str.Format( "ERROR: rfcErrorGroup: %1,
rfcErrorKey: %2, rfcErrorMessage: %3, rfcErrorCode: %4.",
result.rfcErrorGroup, result.rfcErrorKey, result.rfcErrorMessage,
result.rfcRetCode )
else

18 Programming Guide LLESSAP100000-PGD-EN-1

 3.2 Using the configuration API

// 4) check BAPI Return value and retrieve the results

if Length( bapiMethod.("Return").Code ) != 0
retval.ok = false
retval.errMsg = Str.Format("BAPI returned the
message: %1.", bapiMethod.("Return").MESSAGE )
ok = false
else
retval.message = Str.Format("Employee with personnel
number %1 is %2 %3.", bapiMethod.PersonnelNumber,
bapiMethod.PersonalData[ 1 ].FIRSTNAME, bapiMethod.PersonalData[ 1
].LAST_NAME )
end
end
end

// 5) display the results

if ok
echo ( retval.message )
else
echo ( retval.errMsg )
end

// 6) cleanup

if IsDefined( bapiMethod )
$SAP.BAPI.Delete( bapiMethod )
end

When you run the script, you will get the following output in the debug window:

Employee with personnel number 00001006 is Yasmin Awad.

3.2 Using the configuration API

In the following tutorial the code from the example in “Calling BAPI method
GetList of BAPI EmployeeAbstract” on page 17 is changed to get the connection
parameters from the configured SAP system settings instead of having hard-coded
connection parameters.
Note: For successful execution of the tutorial, an SAP system with the logical
SAP system name DPX must be configured by using the SAP Systems
administration pages from the Content Server Administration.
See below for step 1) where the logical SAP system name is used to connect to the
SAP system. The code after step 1) is the same as in the previous tutorial (Calling
RFC ‘RFC_READ_TABLE’).
Code

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 19

Chapter 3 Tutorials

Assoc result
Assoc retval
retval.ok = true
Boolean ok = true

String logSAPSystemName = "DPX"

Object prgCtx

Dynamic connection = undefined

Object rfcMethod = undefined
RecArray records = undefined

// create a program context

// CAUTION: in a request handler you call .PrgSession() or if
available use prgCtx parameter.

String cnctName = $Kernel.SystemPreferences.GetPrefGeneral(

'DftConnection' )
result = $LLIApi.PrgSession.CreateNewNamed( cnctName, {'Admin',
UNDEFINED, '' })
if result.OK
prgCtx = result.pSession
else
retval.OK = FALSE
retval.errMsg = "Unable to create program session"
ok = false
end

// 1) Connect to the SAP system by using the given connection

parameters

if ok
result = $SAP.SapSystems.ConnectToDestination( prgCtx,
logSAPSystemName )
if result.OK
connection = result.connection
else
retval.ok = false
retval.errMsg = result.errMsg
ok =false
end
end

// 2) Create a new instance of the $SAP.RFC object for RFC_READ_TABLE

if ok
rfcMethod = $SAP.RFC.New( connection, "RFC_READ_TABLE" )
if IsUndefined( rfcMethod )
retval.errMsg = "ERROR: can't create $SAP.Rfc object for
RFC_READ_TABLE - see thread log for more information"

20 Programming Guide LLESSAP100000-PGD-EN-1

 3.2 Using the configuration API

retval.ok = false
ok = false
end
end

// 3) Set an importing parameter and call the RFC

if ok
rfcMethod.QUERY_TABLE = "USR01"
result = rfcMethod.Call()
if result.ok == false
ok = false
retval.ok = false
retval.errMsg = Str.Format( "ERROR: rfcErrorGroup: %1,
rfcErrorKey: %2, rfcErrorMessage: %3, rfcErrorCode: %4.",
result.rfcErrorGroup, result.rfcErrorKey, result.rfcErrorMessage,
result.rfcRetCode )
else
// 4) Retrieve the results
records = rfcMethod.FIELDS
end
end

// 5) Display the results - just display the number of records for

simplicity or the error message

if ok
echo ( Str.Format( "Table %1 has %2 records.",
rfcMethod.QUERY_TABLE, Length( records ) ) )
else
echo ( retval.errMsg ) end

// 6) Cleanup

if IsDefined( rfcMethod )
$SAP.RFC.Delete( rfcMethod )
End

LLESSAP100000-PGD-EN-1 OpenText Activator for SAP Solutions 21

Index
T
tables
$SAP.SapSystems ConnectToDestination
OTSAPACT_SYSTEMS_CFG 11
function 11
tutorials
$SAP.SapSystems ExistsSapSystem
calling BAPI method GetList 17
function 11
calling RFC RFC_READ_TABLE 15
$SAP.SapSystems
using the configuration API 19
GetEnabledSapSystems function 12
using the SAP OSpace 15
$SAP.SapSystems GetSapSystem function
13
$SAP.SapSystems GetSapSystems
function 13

C
component overview 5
configuration API
$SAP.SapSystems ConnectToDestination
function 11
$SAP.SapSystems ExistsSapSystem
function 11
$SAP.SapSystems
GetEnabledSapSystems function 12
$SAP.SapSystems GetSapSystem
function 13
$SAP.SapSystems GetSapSystems
function 13
tutorial 19
configuration data of SAP system 12, 13

L
logical SAP system name 11

R
RFC/BAPI API 7

S
SAP OSpace
configuration API 11
RFC/BAPI API 7

LLESSAP100000-PGD-EN-1 Programming Guide 23