Generating a service archive (SAR) file

Before we can create an API with z/OS® Connect EE, you need to generate a SAR file.

About this task

We can achieve this with IBM MQ , by using the CICS®-WOLA process described in the z/OS Connect EE Knowledge Center. See Generate a service archive from a CICS COBOL copybook for more information.

Important: The process described in the following text is optional. If we do not want to make use of the facilities provided by the API editor we do not need the SAR file. However, you might want to make use of the JSON schemas and bind files described in the preceding link, if you want to use the data transformation support provide by z/OS Connect EE.

The process described in the preceding link makes use of the BAQLS2JS utility provided with z/OS Connect EE.

This utility:

1. Generates JSON schemas and bind files which can be used with the data transformation function provided in z/OS Connect EE.

   If you want to configure these files in z/OS Connect EE, you set them in the configuration through the zosconnect_zosConnectDataXform element.

   See Use data transformations with the MQ Service Provider for more information.

2. Generates a SAR file that contains the JSON schemas from the preceding step, and a reference to the serviceName attribute of a particular z/OS Connect EE service instance.

   The reference is provided to BAQLS2JS using the SERVICE-NAME parameter.

   For example, if SERVICE-NAME=MQ1WayBackend is set as an attribute to BAQLS2JS, then BAQLS2JS would generate a SAR which could be used with an IBM MQ service instance configured as follows:

                        
   <zosconnect_zosConnectService id="MQ1WayService"
                                 serviceName="MQ1WayBackend"
                                 serviceRef="mq1way"
                                 invokeURI="/mq1way"
                                 dataXformRef="xformJSON2Byte" />
                                                           
   <mqzosconnect_mqzOSConnectService id="mq1way" 
                                     connectionFactory="jms/cf1"
                                     destination="jms/oneWayRequestQ" />
   

Results

Once generated, the SAR file can be imported into the API Editor to generate an API. See Create an API using z/OS Connect EE API Editor for more information.

Once an API has been constructed in the API Editor, an API Archive (AAR) is generated which can then be deployed to z/OS Connect EE, where it will run against the service referenced by the SERVICE-NAME attributed in BAQLS2JS. See Deploying an API to the z/OS Connect EE server for more information.