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

Installing the CallAPI for VSE

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 VSE.

TCP/IP for VSE is required in order to use the CallAPI for VSE. Communication to the Automation EngineThis component drives an Automation Engine system and consists of different types of server processes. is established using TCP/IP sockets. The configurationA set of constituent components that make up a system. This includes information on how the components are connected including the settings applied. must allow a connection to the Automation Engine, in other words, it must be possible for the VSE to access the IP address and port number of the Automation Engine.

Supplied Files

File name Description

sample1.jcl

VSE example jobAn Automation Engine object type for a process that runs on a target system., assigning AE Script using SYSIPT
sample2.jcl VSE example job, AE Script via library element
ucx.msl Message library in adequate form for VSE
ucxbvse.bin CallAPI utility in binary form
ucxbvse.ini Configuration file

ucxbvse.punch

CallAPI utility as PUNCH output

 


Procedure

Adjust the supplied INI file to the values of your installation.

You can keep your existing INI file even if there is a new Automation Engine version. It might be required to adjust it. More detailed information is provided in the Release Notes, a collection of which is found in the manual Release Notes.

First, a library should be created in the VSE. It is called "PRD2.UC4" in this document. You can, of course, select any name of your choice. The library can be created with a job using the utility LIBR:

* $$ JOB JNM=CREATE,CLASS=A,DISP=D
* $$ LST CLASS=A,DISP=D
// JOB CREATE
// EXEC LIBR
DEFINE SUB=PRD2.UC4
/*
/&
* $$ EOJ

The next step is to transfer the files to the VSE operating system. This is possible with IND$FILE or, if available, by using FTP on the VSE computer.

If IND$FILE is not possible and no FTP is available, the program must be created using the Punch file ucxbvse.punch.

Transfer with IND$FILE

Many 3270 emulations support the file-transfer method IND$FILE. In the IBM emulation, there are the console utilitiesUtilities support the execution of administrative tasks in an Automation Engine system (such as reorganizing and archiving the Automation Engine database). SEND.IND$FILE and RECEIVE. IND$FILE must be installed on the VSE in order to use this type of file transferTransfers files from one computer to another. A particular Automation Engine object type (FileTransfer object).. Use the following steps to confirm installation:

  1. Log on to VSE in CICS.
  2. Delete the CICS screen (F9 key = Escape).
  3. Enter IND$

IND$FILE has successfully been installed if no error message is displayed. Press the F3 key (end IND$ transaction) and the F3 key (back to CICS menu) to get back.

If you want to execute the transfer, you should be on the deleted CICS screen with the 3270 emulation. If this is not possible for reasons of security, you can change to a transfer mode using the menu items 3 (Operations), 8 (Personal Computer Move Utilities) and 6 (PC file transfer).

Now switch to a console window (start CMD) on the PC and transfer the following three files using the SEND command:

send ucx.msl     b: ucx     msl   (FILE=LIB L=PRD2 S=UC4
send ucxbvse.ini b: ucxbvse ini   (FILE=LIB L=PRD2 S=UC4
send ucxbvse.bin b: ucxbvse phase (FILE=LIB L=PRD2 S=UC4 binary

In this example, the emulation "B" was ready for transfer.

Alternately, the phase can also be created from the PUNCH file. Do so by transferring the file shown below instead of the file "ucxbvse.bin":

send ucxbvse.punch b: ucxbvse (FILE=PUN binary LRECL=80

Change to the Punch Queue (item 3) when the PUNCH file has been successfully transferred in the emulation via the menu items 3 (Operations) and 2 (Manage Batch Queues). Copy "UCXBVSE" with 4 (Copy to Primary Library). After a successful copying process, "UCXBVSE" can be deleted from the Punch Queue.
Then change back to the main menu (F3 key) and move to the Primary Library with menu item 5 (Program Development) and 1 (Program Development Library). Open the file "UCXBVSE" for editing and insert the following JCL lines at the beginning of the file:

* $$ JOB JNM=CATAL,CLASS=A,DISP=D
* $$ LST CLASS=A,DISP=D
// JOB CATAL
// OPTION CATAL
// LIBDEF *,CATALOG=PRD2.UC4
INCLUDE

Add the following JCL lines at the end of the file:

// EXEC LNKEDT
/*
/&
* $$ EOJ

Save the modified file and start the created job with 7 (Submit). The phase "UCXBVSE.PHASE" should be available in the library "PRD2.UC4" if the job has been processed successfully.

FTP Transfer

For an FTP file transfer, it is necessary to have an FTP server installed on the VSE. Open a console window on the PC and transfer the files by FTP 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. to the VSE:

ftp vse.mycompany.com
cd PRD2
cd UC4
put ucx.msl
put ucx.bvse.ini
bin
put ucxbvse.bin ucxbvse.phase
quit

Use

If the INI file has not yet been adjusted on the PC, do so by logging on to the CICS with the 3270 emulation. Change to an empty CICS screen with the F9 key. Enter DITTO and change to the "LDL - Library Directory List" mask using menu items 5 (Work with VSE libraries) and 2 (List directory). Enter the library PRD2.UC4. Use the cursor to move to the member "UCXBVSE INI", press the F4 key. The member can now be edited with menu item 4.

Enter the server data for the installation (section server). If required, you can specify a default 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. for the CallAPI in the user section.

 

See also:

CallAPI for VSE

 


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

Copyright © 2016 Automic Software GmbH