Adding support for Debug Profile Service API

Managing Debug Profiles

The Debug Profile Service API handles debug profiles differently depending on whether the environment is CICS or non - CICS.

CICS Environments

In CICS environments, debug profiles are stored in a repository owned by the CICS region. This repository can be either:

• A CICS temporary storage queue (TSQ), or
• A VSAM data set allocated to the DD:EQADPFMB.

To use the Debug Profile Service API with CICS, you must determine how it will interact with the target CICS region. Two integration options are available:

1. CICS TCPIPSERVICE

   For this option, you must install a DTCN API instance in each CICS region. The DTCN API is a REST service that interacts with the CICS DTCN Repository Manager to manage debug profiles. To enable it, the CICS system programmers must define and install TCPIPSERVICE and URIMAP definitions and ensure that the z/OS Debugger program library (default EQAW.SEQAMOD) is included in the CICS concatenation. Each region requires its own DTCN API instance configured with a unique TCP/IP port number. Once the CICS setup is complete, Debug Profile Service API can be configured to manage CICS debug profiles by using the DTCN API TCP/IP port number to identify the corresponding CICS region.

2. CICS EXCI

   For this option, Debug Profile Service API can be configured to use the EXCI interface to manage debug profiles as if it were the CICS DTCN Repository Manager that runs within each CICS region. CICS system programmers must define and install CONNECTION and SESSIONS definitions and ensure that the z/OS Debugger program library (default EQAW.SEQAMOD) is included in the CICS concatenation. Each region requires the same EXCI definitions, but unique APPLIDs as specified in the CICS system initialization (SIT) parameters. Once the CICS setup is complete, Debug Profile Service API can be configured to manage debug profiles by using the APPLID to identify the corresponding CICS region.

For both configurations, the Debug Profile Service API relies on a configuration file named dtcn.ports, the Debug Profile Service CICS DTCN configuration file to identify and communicate with target CICS regions. This file contains a list of CICS region names paired with their corresponding port numbers, serving as a lookup table.

To configure the external components, see Defining the CICS TCPIPSERVICE resource or Defining the CICS EXCI CONNECTION and SESSIONS resources.

Once Debug Profile Service API is configured as the single point of entry for managing debug profiles, you can grant permission for selected users to use the Profile-Management UI to manage profiles on behalf of other users. For example, this allows them to clean up stale debug profiles or review other user's profiles through a user-friendly interface.

To authorize users to access Profile-Management UI, see Defining who can create, modify, or delete DTCN profiles. For instructions about navigating the Profile-Management UI, see Managing profiles with z/OS Debugger Profile Management.

For the API documentation, use the DTCN Profile (CICS) API via the internal Swagger UI URL to verify your setup. For more information, see Debug Profile Service diagnostics.

Non-CICS Environments

For non-CICS, debug profiles are stored in EQAUOPTS data sets. Debug Profile Service API manipulates (creates, deletes, and reads) the data sets directly based on a pattern defined in the eqaprof.env configuration file.

For the API documentation, use the DTSP Profile (non-CICS) API via the internal Swagger UI URL to verify your setup. For more information, see Debug Profile Service diagnostics.