Start of change

Adding support for Debug Profile Service

Debug Profile Service consists of a server and REST APIs that use the HTTP protocol to provide RESTful services to a set of resources related to managing debug profiles and IMS Isolation.

The server runs on z/OS, and uses IBM z/OS Liberty Embedded as the web server.

The following REST APIs are provided with Debug Profile Service:
  • Debug Profile Service API (DPS API) is a REST API that runs on z/OS to manage debug profiles in both CICS and non-CICS environments (handles batch, IMS, Db2® stored procedure profiles stored in EQAUOPTS data sets).
  • IMS Transaction Isolation Service API (IMS ISO API) is a REST API that runs on z/OS that allows users to isolate IMS transactions for debugging. It is similar to the Batch Interface of IMS Transaction Isolation Facility of z/OS Debugger, which invokes the program EQANIPSB to perform IMS Transaction Isolation functions.
  • Authentication Service API (AUTH API) is a REST API that runs on z/OS to authenticate mainframe user credentials. The following authentication methods are supported: Internally, all Debug Profile Service REST APIs use the same authentication method to perform authentication functions.
Figure 1. Debug Profile Service
Debug Profile Service

To enable the RESTful services, you need to configure the server and APIs, and then restart the server.

Notes:
  • Debug Profile Service requires 64-bit Java 8, 11, or 17 (with IBM z/OS Liberty Embedded 23.0.0.12 or later). After installation, you need to configure z/OS to run Java applications.
  • Debug Profile Service is hosted on the IBM z/OS Liberty Embedded application server and is compatible with the default IBM z/OS Liberty Embedded installation on your z/OS system. You do not need to install or modify the existing IBM z/OS Liberty Embedded application server to accommodate the Debug Profile Service, but you need to refresh the eqaprof.env to include environment variable liberty_dir.
  • To enable all the features in the z/OS Debugger Profiles view with Eclipse, you need to install, configure and start z/OS Explorer 3.2.0.13 or later and Debug Profile Service. For CICS, also see the instructions in Activating the TCP/IP Socket Interface for CICS.
End of change