Installing the CallAPI for VMS

The Automation Engine supplies a CallAPI for VMS. It enables calls in the Automation Engine from your own programs, which can be written in a particular programming languages such as C, C++, or COBOL.

UCXBV??C is a CallAPI utility that can be called from the command line.

A two-character code is assigned for each supported VMS variant and is used in some CallAPI file names.

Note: In this document, the specific code is replaced by ??.

Important! The communication between the Java Communication Process (JCP) and the Proxy uses TLS/SSL exclusively. Because the CallAPI does not natively support TLS/SSL and still connects to the Communication Process (CP), it cannot connect directly to the Proxy nor the JCP). However, you can route CallAPI connections through the TLS Gateway to secure them. For more information, see TLS Gateway. The exceptions are the Java and SAP CallAPIs which already use TLS/SSL to connect to the Automation Engine. They communicate directly with the JCP and use trusted certificates to authenticate their identity to other communication partners.

More information:

For additional information about the different certificate types and examples of how they could be created and used, see What Kind of Certificates Should I Use for Automic Automation v21.

Important! Please note that these are only examples, not a requirement for Automic Automation and they are not meant to replace the product documentation.

In Automic Automation Kubernetes Edition, CallAPIs establish a connection to a TCP load balancer. The address of this load balancer must be configured on both ends—the Automation Engine and the CallAPI. The only exceptions are the Java and SAP CallAPIs, which must be updated to use TLS/SSL when connecting to the Automation Engine. These two CallAPIs establish a direct connection to the Java Communication Process (JCP) through an HTTPS load balancer. In this setup, you can also route the connections of the other CallAPIs through the TLS Gateway to securely reach the HTTPS load balancer.

More information:

To install the CallAPI for VMS

You must transfer the supplied files to the host using FTP:

openIP address
User name = UC4
Password = <as specified>
cd SRC
pwd(check directory)
put MAKEXAMP.COM
put UCXBVXXC.C
put UCCALL3.H
bin
put UCXBV??C.OLB
cd ../BIN
pwd(check directory)
putUCXBV??C.EXE
ascii
put API_START.COM
put UCXBVXXC.INI
put UCX.MSL
bye

Adjust the INI file (UCXBVXXC.ORI.INI) of the VMS CallAPI to your system environment, see Call API VMS INI file.

Note: You can keep your existing INI file even if there is a new Automation Engine version and adjust it as required.