November 2010

 

Installing the uniPaaS API Interface Environment

 

 

 

 

 

 

 

 


Dear Developer,

We are proud to present the new uniPaaS API Interface library for uniPaaS Version 1.5 SP1.

The uniPaaS API Interface library is provided for uniPaaS V1.5 and V1.8 customers.

Installation

Supplied Objects

System Requirements

Configuration

Verifying API Connectivity

uniPaaS High Level Language Interface

MGCALL Program

Requester Timeout

Calling to an uniPaaS Project – Example 

Fixed QCRs

 

Installation (Top)

To install the uniPaaS API interface environment:

 Run the MfObjTrf exe file in order to transfer the product to the System i and install it.

The parameters are:

  • system i Destination Library: MGRQTOOL15
  • install on system i : V5R4 up to V6R1
  • User id: Valid System i User with QSECOFR privilege
  • Password
  • System i TCP/IP Address or Host Name
  • PC Client Code Page: for example 1255

The library name should be 10 characters long, and it should not exist on the target System i.

Supplied Objects (Top)

 

MGRQTOOL15 Library

A MGRQTOOL15 library will be created on your System i. This library contains

the objects described below:

 

Object

Type

Description

MGCALL

*PGM

The interface program

MGRUNINI

*DTAARA

The data area for the API program library, directory, and CCSSID code page

QCLSRC

*FILE

The source file with a sample CL program

QDDSSRC

*FILE

The source file with DDS for the sample CL program

TEST

*PGM

The sample CL program

TEST

*FILE

The Display file

CFGMGREQ

*CMD

The command for configuring the requester

MGCGIREQ

*DTAARA

A data area containing the IFS directory

MGRUNINI

*DTAARA

A Data area containing the library , IFS directory and codepage

 

 

 

 

 

 

 

MGRQTOOL15 IFS Directory

A MGRQTOOL15 IFS directory will be created on your System i. This directory

contains the objects described below:

 

Object

Type

Description

etc/MGREQ.INI file

 

The uniPaaS Requester file which has a uniPaaS broker address

logs

 

An empty directory for log files

projects

 

A directory with the test project

 

 

 

System Requirements (Top)

  • OS/400 V5R4 up to V6R1 
  • TCP/IP communication protocol


Configuration (Top)

Change the MessagingServer setting in the Mgreq.ini file, located in the default

folder (/mgrqtool15/etc/) to the uniPaaS Broker TCP/IP address and port.

 

The broker and the engines connected to it can be from uniPaaS 1.5 or uniPaaS 1.8.

 

Note: If the uniPaaS Broker is configured in the Windows workstation, make

sure to add that Windows workstation TCP/IP address to the TCP/IP Host Table

on System i.

Here is a sample command showing how to invoke a uniPaaS program or

iBOLT flow from the System i program:

CALL PGM(MGCALL) PARM('-APP=IFS' '-PRG=HTTP’ '-ARGS=AcodeN10')


Verifying API Connectivity (Top)

  • ADDLIBLE MGRQTOOL15
  • CHGCURDIR MGRQTOOL15
  • CALL TEST


When a uniPaaS program is executed successfully, the result data appears.

 


uniPaaS High Level Language Interface (Top)


This interface does not support returning a result file on the IFS because most native System i programs will usually not require access to IFS files. The MGCALL program, a component of the uniPaaS Server API Interface Environment, requires the parameters described below.

 


MGCALL Program (Top)

 

The MGCALL program supports the following argument formats:

 

  • Decimal, including the Packed Decimal Numeric format commonly used in business applications
  • Character
  • Binary


Each argument provides the format, length (decimal precision), and actual data.

 

Packed Decimal Argument

CL definition:

DCL VAR(&B_B) TYPE(*DEC) LEN(15 5)

Should be implemented by the string:

‘D’ 15 5 &B_B

Character Argument

DCL VAR(&A) TYPE(*CHAR) LEN(20)

DCL VAR(&B) TYPE(*CHAR) LEN(1)

Should be implemented by the string:

‘C’ 20 &A

‘C’ 1 &B

Binary Argument

DCL VAR(&D) TYPE(*INT)

Should be implemented by the string:

‘B’ 4 &D

Return Code

 

Return code for the MGCALL program should be defined as:

DCL VAR(&RETCODE) TYPE(*INT)


Requester Timeout (Top)

The default timeout of MGRQTOOL is set to 30 seconds.

To change the timeout, before executing the MGCALL API, run the following CL command:

 

ADDENVVAR ENVVAR(REQUESTERTIMEOUT) VALUE(xx) 

 

where XX is the time in seconds.  


Calling a uniPaaS Project – Example (Top)

To call a uniPaaS project named “TEST” with a program named “HLLTest”, prepare a program call as follows:

 

CALL PGM(MGRQTOOL15/MGCALL)

PARM('TEST' 'HLLTest' &RETCODE 'A' 'C' 20 &A

'D' 15 5 &B_B 'C' 1 &B 'B' 4 &D)

 

 

 

 

Fixed QCRs (Top)

996368 – Executing MGCALL asynchronously did not work correctly.

 

998932 – Calling a Windows broker resulted in the following message in the job log: "The pointer parameter passed to free or realloc is not valid"

 

 

Thank you,

uniPaaS System i team