Configuring Z APM Connect Base in default mode

As product installer, by using the default configuration process, you need to configure a default environment for Z APM Connect Base on your z/OS® systems.

Procedure

Complete the following steps to configure Z APM Connect Base:

  1. Create and customize the Base started task (STC) JCL.
    1. Copy the SAGMSAM member AGMAPROC to a PDS in your z/OS PROCLIB concatenation. If AGMAPROC is not appropriate, you can rename this PROC to suit your installation standards.
    2. Modify the JCL of AGMAPROC to point to your IBM Z® APM Connect data sets. Change the &HLQ JCL parameter in the AGMAPROC JCL to match the high-level qualifier of your IBM Z APM Connect target libraries.
    3. Ensure that the user ID that is associated with this AGMAPROC STC has READ access to all the IBM Z APM Connect data sets, and an OMVS segment. The OMVS segment allows this STC to use UNIX systems services.
    4. Optional: If you plan to monitor transactions flowing into CICS Transaction Server from IBM MQ, ensure that the user ID associated with the AGMAPROC STC has READ access to the resources of each IBM MQ subsystem that you want to monitor.
      Use the following RACF command to grant the user ID the read access to the profiles of each IBM MQ queue manager:
      PERMIT <MQ_QMNAME>.BATCH CLASS(MQCONN) ID(<USER_ID>) ACCESS(READ)
      For example, for queue manager MQP1, and started task user ID ZAPMUSER, use this RACF command:
      PERMIT MQP1.BATCH CLASS(MQCONN) ID(ZAPMUSER) ACCESS(READ)
  2. Review and customize the SAGMSAM member AGMAPARM, which is pointed to by the AGMAPROC JCL.
    Update the TTServerString parameter to point to the IP address and port number of the Z APM Connect Distributed Gateway. The value must be in the form of tcp:ip_address:port.
    Note:
    • If Z APM Connect DG is installed in OpenShift clusters, ip_address must match the value set for advertisedHostname in transactionProcessor section of the Distributed Gateway values.yaml file; port must be set to 443 to connect properly.
      For example,
      TTServerString=tcp:ingress.apps:443
    • If Z APM Connect DG is installed on a Linux Machine with Docker standalone, ip_address is the IP address of Z APM Connect DG; port must be set to 30455 to connect properly.
      For example,
      TTServerString=tcp:9.XX.XX.XXX:30455
    Attention: If the TTServerString=tcp:<hostname>:<port> statement exceeds 80 characters, allocate the AGMAPARM dataset with RECFM=VB (Record format=variable block) and ensure that the LRECL (Record Length) is greater than the total character count required. This will allow the statement to fit on a single line.
  3. If CICS® transactions are monitored by the CICS-MQ adapter, review and customize the SAGMSAM member AGMACMDS, which is pointed to by the AGMAPROC JCL.
    Ensure that each IBM® MQ subsystem to be monitored has one AGMQ INIT statement. Uncomment and update the AGMQ INIT statements.
    Note: Up to 10 IBM MQ regions can be monitored by a single Z APM Connect Base started task. If you plan on monitoring more than 10 IBM MQ regions, you need an extra Z APM Connect Base started task by using a unique SSNM value. For more information, see Creating a second or subsequent Base STC.
  4. If IMS Db2 backend detail information is desired, review and customize the SAGMSAM member AGMACMDS, which is pointed to by the AGMAPROC JCL.
    Ensure that for each IMS subsystem for which Db2 backend detail information is desired, there is a AGMI SQLINFO statement. Uncomment and update the AGMI SQLINFO statements. SQLINFO is OFF by default.
  5. Add SAGMMOD and SAGMMODP to your z/OS APF list.
  6. If IBM MQ is stopped or restarted for any reason, you need to either recycle the Base address space or recycle the MQ subsystem by issuing the AGMQ INIT dispatcher command.
    Note: AGMQ TERM command needs to be issued to clear obsolete entry in subsystem communication table's extension. Otherwise the table will fill up over time and cause Z APM Connect to issue an AGMQ0034E error. See command details in the reference section: Base operation.
    • Before recycling the Z APM Connect Base, issue the AGMQ TERM command for all MQ subsystems connected to the Base.
    • Before recycling the MQ subsystem, issue the AGMQ TERM command for each MQ subsystem to be recycled.

What to do next

Validate that your IBM Z APM Connect Base is successfully installed and configured. For more information, see Validating Z APM Connect Base installation and configuration.