Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

IntroductionIntroduction 

The following article will instruct you how to install version 1.11 of the Transaction Analytics Convert Connector (HTAC) for use with the Splunk server and collector.

...

Note
This product currently requires you to be running CICS TS 4.2 or later.   Contact our support center if you want to run HTAC using a release of CICS prior to 4.2.
Note

If you are planning to use HTAC with CTG, you will need either CICS TS 5.2 or later, or CICS TS 5.1 with APAR PM78624 applied.

Load the HTAC software to your machine

...

  1. Download the HTAC installation package by saving the following attachment to your PC:HTAC htac_Installv111.zip
  2. Unzip the installation package to a directory on your desktop.
  3. Transfer the unzipped files to the host using FTP as follows:


File Name On Desktop

File Name on Host (or create your own names)

Transfer Type

Record Format (RECFM)

Record Length (LRECL)

Block Size (BLKSIZE)

Space Needed (in tracks) 

HTAC
htac_v111_
JCL
jcl.xmtHTAC.XMITJCLbinaryFB800
5
10
HTAC
htac_v111_
LIBRARY
library.xmtHTAC.XMITLOADbinaryFB800
100HTAC_PARMLIB
300
htac_v111_parmlib.xmtHTAC.XMITPARMbinaryFB8005
htac_v111_source.xmtHTAC.
XMITPARM
XMITSOURbinaryFB8005


Unpack the installation files

...

  1. From the TSO option 6 panel, issue the following command:  TSO RECEIVE INDSNAME('HTAC.XMITJCL') and press the Enter key.
  2. When prompted for restore options, enter DSNAME('HTAC.V100V111.JCL') and press the Enter key - the PDS will be created.
  3. From the TSO option 6 panel, issue the following command:  TSO RECEIVE INDSNAME('HTAC.XMITLOAD') and press the Enter key.
  4. When prompted for restore options, enter DSNAME('HTAC.V100V111.LIBRARY') and press the Enter key - the library will be created.
  5. From the TSO option 6 panel, issue the following command:  TSO RECEIVE INDSNAME('HTAC.XMITPARM') and press the Enter key.
  6. When prompted for restore options, enter DSNAME('HTAC.V100V111.PARMLIB') and press the Enter key - the PDS will be created.
  7. From the TSO option 6 panel, issue the following command:  TSO RECEIVE INDSNAME('HTAC.XMITSOUR') and press the Enter key.
  8. When prompted for restore options, enter DSNAME('HTAC.V111.SOURCE') and press the Enter key - the PDS will be created. 


Note

The names of the input and output files can be changed to conform to your naming standards.

Note

You will need approximately 110 320 tracks of space for the two three PDS's and one library created above.  You do not have to preallocate the space: the RECEIVE command will do it for you.

...

Perform RDO Updates For Your Target CICS

  1. Edit the job HTAC.V100V111.JCL(RDOHTAC), changing the JOB card and RDO definitions to conform to your installation standards (see the comments in the DFHCSDUP control cards).
  2. Submit the job; a return code of zero indicates a successful execution.  If you receive a return code of other than zero, contact our support center.

Install Your HTAC License Key

If you do not have HostBridge previously installed

  1. Obtain a license key from HostBridge Technology; it will be supplied to you via email.
  2. Create a member in HTAC.V100V111.PARMLIB named HBR@LICN and insert the license key into it (there should be only one line in the member which contains the license key, starting in column 1).
  3. Save the member.

If you have previously installed HostBridge

  1. Obtain a license key from HostBridge Technology; it will be supplied to you via email.
  2. Insert the license key at the top of your existing HostBridge HBR@LICN PARMLIB member.
  3. Save the member.

Create the PLT Initialization ModuleModule 

  1. Include a reference to module HBOPINIT in your PLT initialization (second phase).  
  2. (Re)assemble the PLT initialization module and linkedit it into a library that your CICS will have access to.

Create the PLT Shutdown Module

  1. Include a reference to module HBOPTERM in your PLT shutdown. 
  2. (Re)assemble the PLT shutdown module and linkedit it into a library that your CICS will have access to.

Update Your Target CICS Startup JCL and System Initialization Table (SIT) and Recycle CICS

  1. In your CICS startup deck, include the library HTAC.

    V100

    V111.LIBRARY in your DFHRPL concatenation.  

    Note

    If you already have HostBridge installed, the library should be included after the existing reference to the HostBridge library in the DFHRPL concatenation.

  2. In your CICS startup deck, include a DD statement as follows: //HBPARMS  DD   DSN=HTAC.V100V111.PARMLIB,DISP=SHR; this PARMLIB will provide HTAC with access to your license key and initiallization member.. 
  3. In your CICS startup deck, include a DD statement as follows: //HBSTART  DD  SYSOUT=*; this will allow for the display of HTAC trace entries if required.
  4. In your SIT, ensure that you are running CICS monitoring.  Sample entries are: 
    • MCT=xx (where xx is the suffix for the assembled monitoring control table)
    • MN=ON
    • MNCONV=YES
    • MNEXC=ON
    • MNPER=ON
    • MNRES=ON .(optional; you can use the default of OFF) 
  5. In your SIT, ensure that you are pointing to a PLT initialization module that contains a reference to module HBOPINIT (PLTPI=xx)..  
  6. Recycle your target CICS.

Run the Installation Verification Procedure

From a cleared CICS screen, type in the transaction HTAC and press the Enter key.  You should see:

Image Removed

This will give you a list of all valid HTAC commands.

When you press the Enter key, the following will be displayed:

Image Removed

Now, type in the following HTAC command:

Image Removed

...

When you type in HTAC  HELP, followed by a command name, you will display a description of how the command works.

Pressing the Enter key again will take you back to the prior screen:

Image Removed

Now we will start two emitters using TCP as a communication protocol (other choices are UDP and HTTP) by issuing the following command:

Image Removed

...

At this point two emitters will be running, and will contain information obtained from the CICS Monitor, organized in JSON format.  This information can then be interrogated by the Splunk client.  Here is a sample of what the JSON document will look like: HTAC_Sample_Output.JSON

Press the Enter key again to see the prior screen:

...

HTAC RESET

and press the enter key.  You will see the following:

Image Removed

Pressing Enter again will provide more information:

Image Removed

Pressing Enter again will redisplay the HTAC RESET command.

...

  1. In your SIT, ensure that you are pointing to a PLT shutdown module that contains a reference to module HBOPTERM (PLTSD=xx).
  2. Recycle your target CICS.

Execute the Transaction Analytics Connector Installation Verification Procedure (IVP)

To execute the Installation Verification Procedure, follow the instructions here.

Conclusion 

You have now successfully completed the installation of HTAC.