Interact with Other Systems

API Test Base interacts with other systems through related Java libraries. When the libraries are not open source, they need to be copied to corresponding folders under <APITestBase_Home>/lib.

Databases

To use Database Test Step to interact with a database, such as Oracle or SQL Server, as part of a test case, copy related JDBC drivers like below. JDBC URL is used in database endpoint for connecting to the database.

Oracle

Oracle JDBC driver comes with Oracle installation. For example, C:\oraclexe\app\oracle\product\11.2.0\server\jdbc\lib. Copy ojdbc8.jar or ojdbc6.jar to <APITestBase_Home>/lib/jdbc/oracle folder.

Sample JDBC URLs:

jdbc:oracle:thin:@myhost:1521:mySID
jdbc:oracle:thin:@myhost:1521/myServiceName


SQL Server

SQL Server JDBC driver can be downloaded from Microsoft web site. After unzipping it, copy sqljdbc41.jar to <APITestBase_Home>/lib/jdbc/sqlserver folder.

To enable API Test Base to use Windows authentication to connect to SQL Server, also copy sqljdbc_auth.dll from the unzipped folder to <APITestBase_Home>/lib/jdbc/sqlserver, and add <APITestBase_Home>/lib/jdbc/sqlserver to the PATH environment variable of the Windows OS where API Test Base is running.

Notice that there are two sqljdbc_auth.dll files in the unzipped folder. Use the one from folder x64 or x86 for 64 or 32 bit Windows OS.

Sample JDBC URLs:

//  When using SQL Server authentication
jdbc:sqlserver://myhost:1433;database=myDatabase;

//  When using Windows authentication
jdbc:sqlserver://myhost:1433;database=myDatabase;integratedSecurity=true


IBM MQ

To use MQ Test Step to interact with IBM MQ as part of a test case, copy below jars to <APITestBase_Home>/lib/mq.

//  For MQ 8.0.0.x
com.ibm.mq.jar
com.ibm.mq.jmqi.jar
com.ibm.mq.pcf.jar


These jars can be found at <MQ_Install_Dir>/java/lib.

To interact with multiple versions of MQ at the same time, use the jars of the highest version.

IIB

To use IIB Test Step to interact with IIB (only v10 is supported) as part of a test case, copy IBM jars to corresponding folders.

Copy below jars to <APITestBase_Home>/lib/iib/v100.

IntegrationAPI.jar
jetty-io.jar
jetty-util.jar
websocket-api.jar
websocket-client.jar
websocket-common.jar


These jars can be found at <IIB_Install_Dir>/common/classes and <IIB_Install_Dir>/common/jetty/lib.