After you install the z/OS Connect EE runtime, you’ll want to set up, configure, and start your first z/OS Connect EE server.
Check that you have the appropriate z/OS security permissions before continuing.
1. Create a server
Navigate to the <install_path>/bin
directory and issue the command:
zosconnect create <server name> --template=zosconnect:default
This creates a directory in /var/zosconnect/servers/<server name>
with a server.xml
file in it. This file will be used later to configure the server.
2. Define the server as a started task
Your z/OS Connect EE server needs to run as a started task. Sample JCL is provided for you to copy to your PROCLIB library and customize for your environment. The sample is located in the following location:
installation_hlq.SBAQSAMP(BAQSTRT)
Customize the JCL for your environment. Make sure you specify the install path and the Java home directory:
SET ZCONHOME= <install_path>
JAVA_HOME= <path to your 64-bit IBM Java SDK>
To start the server as a started task, your z/OS security administrator will need to associate the started task procedure name with a user ID that will own the job. If using RACF, the SAF command will be something like:
RDEF STARTED BAQSTRT.* UACC(NONE) STDATA(USER(<userid>) GROUP(<group>) PRIVILIGED(NO) TRUSTED(NO) TRACE(YES))
3. Configure the server
Open the server.xml
file for your server and add the following line of code:
<httpEndpoint id="defaultHttpEndpoint"
host="*"
httpPort="9080"
httpsPort="9443">
The host="*"
is needed so browsers can access the Liberty z/OS server on any virtual host, not just localhost. Make sure that the 9080 port is available to use for HTTP requests. If not, change it to be unique for your environment.
4. Configure the Liberty Angel (optional)
Some functions of z/OS Connect EE require a Liberty Angel process to access z/OS authorized services, such as:
- System Authorization Facility (SAF)
- Workload Manager (WLM)
- WebSphere® Optimized Local Adapters (WOLA)
- Resource Recovery Services (RRS)
- z/OS Dump
If you want to use an existing Angel process:
You may already have an Angel process if you have z/OSMF started, or created one for another purpose. If you re-use the existing Angel process, configure the Angel JCL start procedure to point to the z/OS Connect EE Installation path and restart the Angel.
SET ROOT = 'usr/lpp/IBM/zosconnect/v3r0/wlp/'
If you want to create and start an Angel process:
- Define your SAF definitions
- Copy the sample Angel JCL from
installation_hlq.SBAQSAMP(BAQZANGL)
- Rename the proc so it matches the STARTED procedure you created for the Angel
- Customize the
SET ROOT=
value so it reflects the install location for z/OS Connect EE, including the /wlp
sub-directory.
5. Starting the Server
Issue the command in the System Command Extension window in SDSF:
/S BAQSTRT,PARMS='<your server name> --clean'
6. Verify the installation
After you start your server, check your logs for the following indicators of success:
CWWKB0103I: Authorized service group <span class="highlight-inline">LOCALCOM is available</span>.
CWWKB0103I: Authorized service group <span class="highlight-inline">WOLA is available</span>.
CWWKB0104I: Authorized service group PRODMGR is not available.
The “Authorized service group” messages indicate the success of the server to access the Angel
process with the SERVER profiles you created. For WOLA, you want LOCALCOM and WOLA to show as “is available.”
CWWKO0219I: TCP Channel defaultHttpEndpoint has been started and is now listening for requests on host * (IPv6) port <span class="highlight-inline">[my_HTTP_port]
You should see your HTTP port show up in this message.
CWWKF0012I: The server installed the following features: [servlet-3.1, ssl-1.0, jndi-1.0, json-1.0, <span class="highlight-inline">zosconnect:zosConnect-2.0</span>, distributedMap-1.0, appSecurity-2.0, jaxrsClient-2.0].
You should see zosconnect:zosConnect-2.0
in the installed features.
SRVE0169I: Loading Web Module: z/OS Connect.
The z/OS Connect web module should load.
CWWKT0016I: Web application available (default_host): http://<my_host>:<my_port>/
The web application of z/OS Connect will then be available on the host and port of your server.
7. Next steps
Now that you’ve successfully started and configured your z/OS Connect EE server, you’re ready to start API enabling your z/OS assets! Check out the scenarios in the documentation for detailed instructions on exposing your first CICS service as an API or for IMS assets, try exposing an IMS service as an API.