Installing the CallAPI for Windows

The Automation Engine supplies a CallAPI for WINDOWS which can be used for WINDOWS on Intel computers. The CallAPI enables calls in the Automation Engine from your own procedures or programs, which can be written in a particular programming languages such as C, C++, COBOL, Java, Visual Basic, VBA, or VBS.

UCXBXXXC.EXE is a CallAPI utility that can be called from the command line, in an MS DOS box or in a batch file.

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 Windows

  1. Install the Microsoft Visual C++ 2017 Redistributable Package from the IMAGE:CRTS directory, if necessary.

  2. Transfer the files to a separate directory (C:\AUTOMIC\CALLAPI\WINDOWS).

  3. Adjust the INI file (UCXBXXXC.INI) of the Windows CallAPI to your system environment, see Call API Windows INI file.

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

  4. Use OLE.

    1. Install the library UCXBWI3C.DLL by using the program REGSVR32. This program is available in the Windows system directory by default.

    2. Register the delivered service UCXBWI3C.DLL from the command line.

      Example

      <Your path to regsvr>\regsvr32 c:\AUTOMIC\callapi\bin\ucxbwi3c.dll

See also:

Platforms for CallAPIs