Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »


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

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.

Load the HTAC software to your machine

To download the installation files and transfer them to the host:

  1. Download the HTAC installation package by saving the following attachment to your PC:
  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) 


Unpack the installation files

To 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.V100.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.V100.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.V100.PARMLIB') and press the Enter key - the PDS will be created.

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

You will need approximately 110 tracks of space for the two 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.V100.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

  1. Obtain a license key from HostBridge; it will be supplied to you via email.
  2. Create a member in HTAC.V100.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.

Create the PLT Initialization Module

  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.

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.LIBRARY in your DFHRPL concatenation.
  2. In your CICS startup deck, include a DD statement as follows: //HBPARMS  DD   DSN=HTAC.V100.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
    • MNEXC=ON
    • MNPER=ON
    • MNRES=ON.
  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:

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

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

Now, type in the following HTAC command:

Press the Enter key, and you should see:

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:

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

Press the Enter key.  The following will be displayed:

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:

Finally, enter the following command to reset HTAC:  


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

Pressing Enter again will provide more information:

Pressing Enter again will redisplay the HTAC RESET command.

If at any time you receive a response other than the one indicated in the example output above, check the syntax of the commands that you entered and try again.  If the problem persists, you should contact our support center.


You have now successfully completed the installation of HTAC.  


  • No labels