Getting started checklists
z/OS Connect Designer getting started checklist
(Meet in the middle
)
zosConnect-3.0Containers
There are some z/OS Connect Designer getting started
tutorials and accompanying videos. For more information on the Getting Started tutorials, see Creating a subsystem z/OS Connect API provider project and for the associated videos to use alongside the
tutorials, see 
z/OS Connect Designer Tutorial: Introduction to the z/OS Connect Designer.
API provider zosConnect-3.0 getting started
checklist (API-first
)
zosConnect-3.0Started task
| API provider getting started checklist |
|---|
| Generating the artifacts for an API provider |
| Developing z/OS applications to implement an API |
| Configuring connections to subsystems |
API provider zosConnect-2.0 getting started checklist
zosConnect-2.0 Started task
Follow the Quick Start scenarios to quickly configure an end-to-end solution with the z/OS Connect zosConnect-2.0 feature. For more information about the API provider quick start scenarios, see Quick start scenarios with IBM z/OS Connect zosConnect-2.0
IBM z/OS Connect development tools for Visual Studio Code getting started checklist
zosConnect-3.0
The z/OS Connect development tools for Visual Studio Code provides features to develop z/OS Connect API provider and API requester project artifacts from an existing OpenAPI 2.0 document or OpenAPI 3.0 document.
For z/OS Connect API provider projects, it generates the request and response structures.
For z/OS Connect API requester projects, it generates the API information file and the request and response structures.
The IBM z/OS Connect development tools for Visual Studio Code extension doesn't generate the WAR file. Use Gradle to build the API provider and the API requester WAR files for the zosConnect-3.0 feature, as seen in Building IBM z/OS Connect APIs with Gradle in the following getting started checklist.
| IBM z/OS Connect development tools for Visual Studio Code extension zosConnect-3.0 |
|---|
| Installing the IBM z/OS Connect development tools for Visual Studio Code extension |
| Optional: Using Gradle in an offline (airgapped) environment
If in an airgapped (disconnected) environment, download the Gradle plug-in. |
| API provider: Using the IBM z/OS Connect development tools for Visual Studio Code for an API provider project
API requester: Using the IBM z/OS Connect development tools for Visual Studio Code for an API requester project. |
| Building an API requester WAR file |
| Deploying an API requester WAR file |
Developing API requesters zosConnect-3.0 getting started checklist
zosConnect-3.0Started task
The following checklist describes how to develop an API requester from an OpenAPI 2.0 document or an OpenAPI 3.0 document for deployment to a z/OS Connect Server by using the zosConnect-2.0 feature or the zosConnect-3.0 feature.
For guidance on whether to use zosConnect-2.0 or zosConnect-3.0 for your API requester, see Developing an API requester.
You can choose one of two options to generate your language structures:
- The API requester Gradle plug-in. For more information about the API requester Gradle plug-in, see What are the z/OS Connect Gradle plug-ins?
- The IBM z/OS Connect development tools for Visual Studio Code (VSC) extension. For more information about the VSC extension, see What is the IBM z/OS Connect development tools for Visual Studio Code extension?
| Developing API requesters zosConnect-3.0 |
|---|
Step 1. Generate the API requester language structures. Choose one of the following:
|
| Step 2. Develop the z/OS application to call the API, including error handling, by using IBM z/OS Connect development tools for Visual Studio Code or an IDE of your choice: |
| Step 3. Configure a z/OS Connect Server for API requester Configuring a connection from IBM z/OS Connect to the API endpoint: |
| Step 4: Build the API requester WAR file: Building an API requester WAR file |
| Step 5: Deploy the API requester WAR file to the z/OS Connect Server applications directory: Deploying an API requester WAR file |
| Step 6: Test the z/OS applications for API calls: Testing z/OS applications for API calls |
| Step 7: How to manage your API requester project: How to manage API requesters |
Developing API requesters zosConnect-2.0 getting started checklist
zosConnect-2.0 Started task
To generate project artifacts for an API requester based on an OpenAPI 2.0 document. From 3.0.99, if the API requester is generated from an OpenAPI 2.0 document consider using the zosConnect-3.0 feature. For more information, see Developing an API requester.
Follow the Quick Start Scenarios to quickly configure an end-to-end solution with the z/OS Connect zosConnect-2.0 feature. For more information about the API provider quick start scenarios, see Calling an API from a System of Record (SoR)
z/OS Connect Server getting started checklist
zosConnect-2.0 zosConnect-3.0 Started task
To install z/OS Connect Server by using SMP/E, the
following getting started checklist gets you started for the z/OS Connect
zosConnect-2.0 feature and the z/OS Connect
zosConnect-3.0 feature.
The postinstallation steps to create a z/OS Connect Server and to modify a z/OS Connect Server vary depending on which z/OS Connect feature you are using. Follow the create and modify steps for the version of the z/OS Connect base feature you are using.
| z/OS Connect Server getting started checklist |
|---|
| Installing IBM z/OS Connect with SMP/E |
| Creating an IBM z/OS Connect Server |
| Starting and stopping the IBM z/OS Connect Servers |
| Stopping and starting connections |
|
zosConnect-2.0 The MODIFY command zosConnect-2.0 zosConnect-3.0 The MODIFY command zosConnect-3.0 |
z/OS Connect Server with Podman - Installing and uninstalling checklist
zosConnect-3.0Containers
z/OS Connect Server with Red Hat OpenShift - online installation checklist
zosConnect-3.0Containers
z/OS Connect Server with Red Hat OpenShift - offline installation checklist
zosConnect-3.0Containers