Create the CICS tutorial workspace using Docker Desktop

Use Docker Desktop to create a workspace for the CICS® tutorial.

Before you begin

Make sure that the following prerequisite tasks are complete:
  1. Prepare the sample CICS application
  2. Downloading the CICS API project sample
  3. Downloading the z/OS Connect Designer image
Note: You need a Docker runtime version 19.0.3 or later running on your workstation to run the z/OS Connect Designer tool.
Note: Throughout this tutorial, the tagged version of the z/OS Connect Designer image is You might have a later version. However, it works the same.

About this task

This topic is applicable to: Content applicable to
application developers

Create the directories and files on your workstation that you need to create a z/OS Connect API project in z/OS Connect Designer.


  1. Create a project workspace directory.
    At the command prompt on your workstation, change to the directory where you want to create your z/OS Connect API project.
    Note: You can create the project workspace in any directory. For this tutorial, create the project workspace in the Desktop directory if you are using a Mac or the root directory if you are using Windows.
    1. Enter the following command.
      For Windows, enter cd /.
      For MacOS, enter cd ~/Desktop.
    2. Enter the following command to create a project workspace directory called ZCWorkspace.
      mkdir ZCWorkspace
    3. Enter the following command to change to that directory:
      cd ZCWorkspace
    4. In the ZCWorkspace directory, create the subdirectories for the API project. These subdirectories are used for Liberty server configuration files.
      For Windows, enter the following command:
      mkdir CatalogManagerApi\src\main\liberty\config

      For MacOS, enter the following command:
      mkdir -p CatalogManagerApi/src/main/liberty/config
    5. In the ZCWorkspace directory, create the logs and certs subdirectories.
      Enter the following commands:
      mkdir logs
      Note: Creating the /certs directory is only required if your connection CICS uses certificates. This tutorial covers Basic Authentication with an IPIC connection. For other security configuration, see Configuring an IPIC connection to CICS.
      mkdir certs
  2. Verify that the z/OS Connect Designer image is loaded.
    Run the following command to list the available docker images on your workstation.
    docker image ls
    The following output shows that the z/OS Connect Designer image is now available.
    REPOSITORY                                  TAG                             IMAGE ID        CREATED        SIZE         3.0.75                          ffba75f49b73    7 hours ago    1.52GB
    Note: The creation timestamp shows when the image itself was first created, not when it was loaded onto your workstation.

  3. Create the docker-compose.yaml file.
    Open a new file in your text editor. Copy the contents in Figure 1 and save the file as docker-compose.yaml in the ZCWorkspace directory. Keep the file in the editor for the next step.
    Figure 1. Contents of docker-compose.yaml file
    version: "3.2"
                - CICS_USER=<cicsUsername>
                - CICS_PASSWORD=<cicsPassword>
                - CICS_HOST=<cicsHost>
                - CICS_PORT=<cicsPort>
                - HTTP_PORT=9080
                - "9443:9443"
                - "9080:9080"
                - ./CatalogManagerApi:/workspace/project
                - ./logs/:/logs/
                - ./certs:/config/resources/security/:ro

  4. Add your CICS credentials to the docker-compose.yaml file.
    The file contains the environment array. This array contains environment variables that can be passed into the container at run time.

    Edit the docker-compose.yaml file as follows:

    1. Replace <cicsUsername> with your username for connecting to CICS.
    2. Encrypt your password for connecting to CICS.
      Enter the following command, replacing <myPassword> with your own password:
      docker run --rm securityUtility encode <myPassword> --encoding=aes

      The output looks something like this:


      Replace <cicsPassword> in the docker-compose.yaml file with the encrypted password.

    3. Replace <cicsHost> with your hostname for the CICS region that you are connecting to.
    4. Replace <cicsPort> with the port number of the IPIC TCPIPService for the CICS region.

    Figure 1 shows the updated docker-compose.yaml file.
    Figure 2. A completed docker-compose.yaml file

    version: "3.2"
                - CICS_USER=userName
                - CICS_PASSWORD={aes}APu1HaGpBzYbH+g8xVbuqUgJPz1ydNS9VbpAq1hstGdF
                - CICS_HOST=myhost
                - CICS_PORT=myport
                - HTTP_PORT=9080
                - "9443:9443"
                - "9080:9080"
                - ./CatalogManagerApi:/workspace/project
                - ./logs/:/logs/
                - ./certs:/config/resources/security/:ro

    At run time, these environment variables are used to create a CICS IPIC Connection.

  5. Save and close the docker-compose.yaml file.
  6. Verify the structure of the files on your workstation in your project workspace directory.
    On the command line, enter dir for Windows or ls for Mac. Verify that the new files and directories are listed correctly. The following screen image shows the expected project structure.
    |-- /certs
    |-- /logs
    |-- /CatalogManagerApi/src/main/liberty/config
    |-- docker-compose.yaml


You successfully created the project workspace for a z/OS Connect API project.

What to do next

In the next task, you configure a connection to the CICS region where your Catalog Manager Application is hosted. Configure IPIC connections to CICS with Docker Desktop and Basic Authentication