How to: Add OMEGAMON Data Provider to a runtime environment

Edit online

This topic describes how to add OMEGAMON® Data Provider to an existing runtime environment using Configuration Manager.

Before you begin

You can add IBM Z® OMEGAMON Data Provider to an existing runtime environment by manually adding required parameters to your configuration, if the parameters are not present in the runtime environment definition (RTEDEF) library.

Important: If you are creating a new runtime environment, Configuration Manager includes the OMEGAMON Data Provider parameters automatically, and you do not need to perform this task.

Before you begin, you need to know the SMP/E target locations where OMEGAMON Data Provider is installed. In particular, you must know the z/OS® UNIX® System Services directory path specified by the SMP/E DDDEF TKAYHFS. The default path is /usr/lpp/omdp. For more information, see Installing OMEGAMON Data Provider.

About this task

To add OMEGAMON Data Provider to an existing runtime environment, you perform the following actions:
  • Add required parameters to members rte_name and GBL$PARM (or GBL$lpar) in the runtime environment definition (RTEDEF) library.
    You must set the following required parameters:
    CONFIGURE_ODP_KAY
    Enables or disables OMEGAMON Data Provider configuration for the runtime environment
    GBL_USS_TKAYHFS_PATH
    Sets the path to the z/OS UNIX System Services directory that the SMP/E installation jobs define using the ddname TKAYHFS
  • For parameters that are specific to OMEGAMON Data Provider, create new member KAY$PARM (or KAY$lpar) in the existing RTEDEF library.
    You can optionally set the following parameters:
    For OMEGAMON Data Broker:
    KAY_BROKER_MEMBER
    Sets the two-character value for the KAYSIPnn member name and the OMEGAMON Data Broker procedure MEM=nn parameter value
    KAY_BROKER_NAME
    Sets the OMEGAMON Data Broker name, which must match the name specified in the KAYOPEN member
    KAY_BROKER_STC
    Sets the OMEGAMON Data Broker procedure name
    For OMEGAMON Data Connect:
    KAY_CONNECT_JAVA_HOME
    Sets the path to the Java 17 installation directory
    Note: Other Java versions are not supported.
    KAY_CONNECT_STC
    Sets the OMEGAMON Data Connect procedure name

Use the following procedure to add OMEGAMON Data Provider to your existing runtime environment.

Procedure

  1. In the RTEDEF library, edit member rte_name and add parameter CONFIGURE_ODP_KAY with the value Y.
  2. In the RTEDEF library, edit member GBL$PARM (or GBL$lpar) and add parameter GBL_USS_TKAYHFS_PATH with the value set to the path of the z/OS UNIX System Services directory that the SMP/E installation jobs define using the ddname TKAYHFS.
  3. (Optional) In the RTEDEF library, create member KAY$PARM (or KAY$lpar), if necessary, where you can set the following product-specific parameters:
    • KAY_BROKER_MEMBER
    • KAY_BROKER_NAME
    • KAY_BROKER_STC
    • KAY_CONNECT_JAVA_HOME
    • KAY_CONNECT_STC
    For example, after you create member KAY$PARM, add the KAY_CONNECT_JAVA_HOME parameter with a value that points to the Java 17 directory, as follows: 
    KAY_CONNECT_JAVA_HOME  "/path/to/Java/J17.0_64"
  4. Run the GENERATE action to finalize the runtime environment configuration.

Results

The GENERATE action performs the following actions:
  • Creates the following OMEGAMON Data Provider procedures in library GBL_DSN_SYS1_PROCLIB, which is (by default) rte_plib_hilev.SYS1.PROCLIB:
    • OMEGAMON Data Connect procedure OMEGODC
    • OMEGAMON Data Broker procedure OMEGODB
  • Copies member KAYOPEN to runtime library rte_hilev.rte_name.RKANPARU
    Note: Member KAYOPEN is copied only once and is never replaced.
  • Copies member KAYSIP00 to global source library %GBL_DSN_GLOBAL_SOURCE_LIB%, which is (by default) rte_hilev.rte_name.RKANPARU
    Note: Member KAYSIP00 is copied only once and is never replaced.
  • Creates the following z/OS UNIX directories for the runtime environment:
    OMEGAMON Data Connect user directory
    • rte_uss_rtedir/rte_name/kay/user/config, which contains connect.yaml samples
    • rte_uss_rtedir/rte_name/kay/user/extensions, an empty directory that is ready for optional OMEGAMON Data Provider extensions
    OMEGAMON Data Connect installation directory
    • For full runtime environments (RTE_TYPE parameter is set to FULL), Configuration Manager extracts the KAY11PAX archive to directory rte_uss_rtedir/rte_name/kay/kay-110/

What to do next

After the Configuration Manager process completes, review Getting started with OMEGAMON Data Provider to perform other necessary steps.

To stream status information from the Tivoli Enterprise Monitoring Server to OMEGAMON Data Provider, see (Optional) Configure situation status streaming.