Deploying an API requester WAR file

Deploy, update, or remove your zosConnect-3.0 API requester dynamically when you add or remove API requester WAR files from the z/OS Connect Server applications directory.

About this task

zosConnect-3.0 Applies to zosConnect-3.0.

Started task Applies to z/OS Connect Servers run by using a z/OS started task procedure.

An API requester is a Liberty web application and can be deployed, and managed in the same way as any other web application running in Liberty. This section explains deploying, updating, and removing an API requester.

Important: zosConnect-3.0 WAR files can be deployed to a z/OS Connect Server that is running as a started task that is at the same release level or later of the z/OS Connect Gradle plug-ins that were used to generate the artifacts. For more information, see z/OS Connect artifact compatibility.

Deploying a z/OS Connect API requester

Before you begin

Before deploying the API requester WAR file, make sure that you have completed the following:

About this task

Deploy your zosConnect-3.0 API requester when you add the API requester WAR into the z/OS Connect Server applications directory.

You can configure z/OS Connect to deploy API requesters when you copy your API requester WAR file as a binary file to a UNIX System Service directory accessible by the z/OS Connect Server; typically the server's application directory. For example, you can either use ${server.config.dir}/apps or ${shared.app.dir}, and define a webApplication element in the server.xml. For more information on the webApplication element for API requesters, see Configuring zosConnect-3.0 to support API requesters.

Important: The contextRoot must be unique across your deployed WAR files within one z/OS Connect Server.

The contextRoot attribute must not be specified on the webApplication element for API requester WAR files. When the API requester is built, the contextRoot value is set in both the WAR file and the generated COBOL copybooks or PL/I include files. These values must match, so the contextRoot value must not be changed when the API requester WAR file is deployed to the z/OS Connect Server. If you want to use a different contextRoot, you can use apiName property when running the API requester Gradle plug-in to do so.

For more information about Gradle plug-in properties and options on apiName, see The API requester Gradle plug-in properties and options.

Procedure

  1. Copy the API requester WAR file to the z/OS Connect Server's application directory.
  2. Configure a matching webApplication element. For more information, see Configuring zosConnect-3.0 to support API requesters.
  3. Start z/OS Connect Server to deploy the API requester.
    Alternatively, to deploy the API requester to a started z/OS Connect Server, issue the following commands in sequence. For more information, see The MODIFY command zosConnect-3.0.
    1. MODIFY <jobname>,REFRESH,APPS
    2. MODIFY <jobname>,REFRESH,CONFIG

Removing API requester

About this task

Remove your zosConnect-3.0 API requester when you remove the API requester WAR file from the z/OS Connect Server applications directory.

Procedure

  1. To remove an API requester, update the server.xml to remove the APIs webApplication element and remove the corresponding WAR file from the z/OS Connect Server applications directory.
  2. To remove the API requester from a started z/OS Connect Server, run the following commands in sequence. For more information, see The MODIFY command zosConnect-3.0. 
    1. MODIFY <jobname>,REFRESH,APPS
    2. MODIFY <jobname>,REFRESH,CONFIG

Updating an API requester

About this task

To update an existing zosConnect-3.0 API requester:

Procedure

  1. Replace the API requester WAR file in z/OS Connect Server application directory.
  2. Optional: Update the matching webApplication element in server.xml.
  3. To update the API requester in a started server, run the following commands in sequence. For more information, see The MODIFY command zosConnect-3.0. 
    1. MODIFY <jobname>,REFRESH,APPS
    2. If the server.xml is updated 
      MODIFY <jobname>,REFRESH,CONFIG