Creating an IMS transaction z/OS Asset

Understand the considerations involved when creating an IMS z/OS Asset.

Before you begin

Ensure that z/OS Connect Designer is running as described in Starting the z/OS Connect Designer with Docker Desktop and importing an OpenAPI definition and that the flow diagram for your API is displayed.

An IMS z/OS Asset describes the formats of the request and response data structures from an IMS, and specific characteristics such as the code page, transid, and transid usage.

See the instructions in Creating a z/OS Asset to add a z/OS Asset in the z/OS Connect Designer and display the Operation flow diagram in the Operation Viewer as shown in Figure 1.

Figure 1. Add z/OS Asset button locations.
Add z/OS Asset button locations.

Procedure

  1. Click Add new z/OS Asset then Next.
    Figure 2. Selecting a new or existing z/OS Asset.
    Selecting a new or existing z/OS Asset.
  2. Click Choose an option to expand the list, and click IMS transaction.
    Figure 3. IMS z/OS Asset mandatory input.
    IMS z/OS Asset mandatory input.
  3. Input the mandatory IMS z/OS Asset information.
    1. Select the Program language.
    2. Input the IMS transaction name.
    3. Select a IMS Connection from available connections. Once complete, click Next.
      For more information on how to connect to IMS, see Configuring connections to IMS.

      The mandatory fields that are needed for the z/OS Asset are complete. If you do not need the optional configuration, click Next and go to step 4.

    Figure 4. Specify IMS connection information.
    An empty IMS Request transaction.
  4. Define the request transaction for your IMS program.
    Figure 5. Select a data structure to import.
    An empty IMS Request transaction.
    1. Click Import data structure button.
    2. Select a file or drag and drop a copybook, COBOL, or PL/I file.
      Figure 6. Choosing a file to import.
      Choosing a file to import.
      Note:

      When you import a COBOL structure, you must add a file extension (.cop, .cob, .ccp, .cpy). Files with extensions .cop, .cob, and .ccp are treated as complete programs. Files with a .cpy extension are treated as a copybook.

      When you import a PL/I structure, you must add a file extension (.pli, .inc). Files with the extension .pli are treated as complete programs. Files with .inc extensions are treated as include files.

    3. Select the data structures that you want to include in your request transaction and click the Add button.
      Figure 7. Selecting data request transaction data structures.
      Selecting data request transaction data structures.
    4. Review your Request transaction then click Next.
      Figure 8. The IMS z/OS Asset Request transaction.
      The IMS z/OS Asset Request transaction.
  5. Define the response transaction for your IMS program.
    Figure 9. IMS transaction response.
    IMS transaction response.
    1. To build your response transaction either:
      • Repeat the same actions as described in Step 6 to build the response transaction structure.
      • Click the Replicate request structure button.
    2. Click Next.
      Figure 10. Populated response transaction.
      Populated response transaction.
  6. Input z/OS Asset name.
    Figure 11. The z/OS Asset name.
    The z/OS Asset name.
  7. Optional: Input z/OS Asset description.
  8. Review the z/OS Asset and click Add.
    Figure 12. Add the z/OS Asset.
    Add the z/OS Asset.

Results

You now have an IMS transaction z/OS Asset for use in your API project.

Figure 13. The newz/OS Asset for use.
The new z/OS Asset for use.