Configuring OMEGAMON Data Connect

OMEGAMON® Data Connect is a Java™ application that can run on or off z/OS®.

Before you begin

You need to know the paths of the following directories:

OMEGAMON Data Connect installation directory. The default installation directory name is kay-110.
Java runtime environment that you plan to use to run OMEGAMON Data Connect: Java 17, 64-bit edition.

Decide the location of your OMEGAMON Data Connect user directory: where you want to keep your site-specific configuration files.

Procedure

Create an OMEGAMON Data Connect user directory.
The user directory will contain your site-specific OMEGAMON Data Connect configuration. The location of the user directory is your choice.

To create a user directory, use the create action of the supplied shell script.
For example, at a shell prompt, change to the bin directory under the OMEGAMON Data Connect installation directory, and then enter the following command, where /var/omdp/prod-a is the user directory that you want to create:
```
ODP_CONNECT_USER_DIR=/var/omdp/prod-a ./connect create
```
Edit the config/connect.yaml configuration file in the user directory to match your site-specific requirements.
The following example configures OMEGAMON Data Connect to send JSON Lines over TCP:
```
connect:
  input:
    tcp:
      enabled: true
      hostname: <connect_host>         # 1
      port: <connect_port>             # 2
  output:
    tcp:
      enabled: true
      sinks:
        logstash: # Your choice of sink name (not a fixed key name)
          enabled: true
          hostname: <logstash_host>    # 3
          port: <logstash_port>        # 4
```
1

Hostname or IP address on which the OMEGAMON Data Connect host listens for data from OMEGAMON Data Broker.
Some typical values:

0.0.0.0

All IPv4 addresses on the local machine.

localhost or 127.0.0.1

Loopback address.

This hostname or IP address must correspond to the hostname or IP address to which OMEGAMON Data Broker sends data, specified by the OMEGAMON Data Broker parameter SINK_HOST.
If you run OMEGAMON Data Connect and OMEGAMON Data Broker on the same z/OS instance (LPAR), then you can specify localhost for both this hostname and the OMEGAMON Data Broker sink hostname.

2

Port on which to listen for data from OMEGAMON Data Broker.
This value must match the OMEGAMON Data Broker parameter SINK_PORT.

3

Destination hostname or IP address. For example, the host running Elastic Logstash.

4

Port on which the destination host is listening for JSON Lines over TCP.

For comprehensive details on configuring OMEGAMON Data Connect, including configuration for other data formats and destinations, see OMEGAMON Data Connect configuration parameters.

Some analytics platforms might require, or provide specific support for, particular types of data. You might choose to filter the output from OMEGAMON Data Connect to send only that data. For information about some analytics platforms, see Integrating analytics platforms with OMEGAMON Data Provider. Otherwise, see the documentation for your analytics platform.
If you want to run OMEGAMON Data Connect on z/OS as a started task, use the sample JCL procedure as a starting point.
1. Copy the sample JCL procedure TKANSAM(KAYCONN) (also supplied as sample/KAYCONN in the OMEGAMON Data Connect installation directory) to your choice of MVS™ PROCLIB library. For example, SYS1.PROCLIB.
2. Edit the values of the symbolic parameters at the start of the PROCLIB(KAYCONN) procedure.
  
  JAVAHOME
  
  The path of the installation directory of Java 17, 64-bit edition. The directory must contain a bin subdirectory that contains the java command.
  
  INSTLDIR
  
  The path of the OMEGAMON Data Connect installation directory.
  
  USERDIR
  
  The path of your OMEGAMON Data Connect user directory.
3. Define a resource profile to control the security of the started task.
  The user that you associate with the started task must have an OMVS segment.
  
  Example RACF® commands:
```
RDEFINE STARTED KAYCONN.* STDATA(USER(OMEGSTC) GROUP(STCGROUP) PRIVILEGED(NO) TRUSTED(NO))
SETROPTS RACLIST(STARTED) REFRESH
```
  Replace the parameter values in this example with values that reflect your site-specific practices for started tasks.
Tip: For ad hoc testing of OMEGAMON Data Connect from a z/OS UNIX® shell, use the sample shell script bin/connect.