HTAC Parameters

There are a number of parameters that can be set using the HTAC SET command.  These parameters are used to control the behavior of the HTAC emitters and to provide information in the event of a failure.  

The initial values of the parameters can be established in the HBO@INIT member in the PDS referred to in the HBPARMS DD statement in your CICS startup deck.

There are several coding conventions that are common to all PARMLIB members:

  • An asterisk in column one of a record
  • // in columns 1-2 of a record
  • #INCLUDE= in columns 1-9 of a record 

  These conventions are described here.

The parameters that do not define emitted data restriction are:

  • BMSGLUE=(Y/N) - Determines whether or not the BMS global user exit (GLUE) will be enabled.  Specifying Y means that the exit is enabled, and N means that the exit will not be enabled.  If the exit is enabled, information including mapset name, map name, and the program executing the RECEIVE MAP and/or SEND MAP will be captured and included in SMF 110 records in the OADATA2 and OADATA3 fields.  The default is N.
  • COLGLUE=(Y/N) - Determines whether or not the HTAC collector global user exit (GLUE) will be enabled.  Specifying Y means that the exit is enabled, and N means that the exit will not be enabled.  The default is Y.
  • CLIMIT=n - The maximum number of events queued by the collector for started emitters.  The default is 1000; the maximum is 32767.  Note:  If you see that events are being dropped by the emitter in your HTAC log (in HBSTART sysout for your region), you can and should increase your CLIMIT specification in increments of 2000 until you no longer see the messages.  There will be a cost of 128k in zOS storage below the bar for every CLIMIT increase (so an increment of 2000 would equal 2000x128k zos storage increase). This does NOT increase CICS EDSA or DSA storage usage.
  • ECOND=(Y/N) - Determines whether or not spaces or zeros are eliminated from the emitted JSON data.  Specifying Y means that the data is excluded.  Specifying N means that the data is included.  The default is Y.
  • EFORMAT=value - Specifies the emitted print format.  This parameter will only be processed if EMETHOD is equal to PRNT.  Valid values are HTTP or spaces.  The default is spaces.  Note:  This parameter has been deprecated and will no longer work as of release 1.19 of HTAC.
  • EHOST=valid-ip-address - Specifies the IP address of the Splunk server that is receiving emitted data.  This parameter will only be processed if EMETHOD is equal to TCP or UDP.
  • ELIMIT=n - Specifies the maximum number of emitters to be started at any one time.  Valid values are 1-16.  The default is 8.
  • EMETHOD=(HTTP/TCP/UDP/PRNT/SUMY/TDQ) - Sets the communication protocol for the emitter.  The default is SUMY.  Note:  EMETHOD=PRNT has been deprecated and will no longer work as of release 1.19 of HTAC; the EPRINT parameter (see below) should be used instead. 
  • EMODE=(C/S/*) - Defines the emitter mode as client or server.  Specifying C indicates that a region is a client and will ship emitted data to a region specified with the ESERVER parameter.  Specifying S indicates that the region is a server region and is responsible for sending emitted data to an outside receiver (such as Splunk); this also requires that an HBz manager be up and running, and associated with the server region.  Specifying * indicates that the region is a standalone server region that can send emitted data to an outside receiver, but does not require the HBz manager.  The default is *.
  • ENABLE=(Y/N) - Determines whether or not an ENABLE will automatically be performed when doing an initialization.  Specifying Y will cause an enable to be automatically performed.  Specifying N will prevent an automatic enable from being performed.  The default is Y.
  • EPATH=value - Defines an emitter path value.  The default is spaces.
  • EPORT=port-number - Specifies the port number on the Splunk server that is associated with the EHOST parameter above.  This parameter will only be processed if EMETHOD is equal to TCP or UDP.
  • EPRINT=(Y/N) - Specifies that a copy of the emitted JSON will be written in the CICS log.  Specifying Y means that the data is printed in the log.  Specifying N means that the data is not printed in the log.  The default is N.
  • EQLIMIT=n - Specifies the available queue limit used by the emitter.  Valid values are 1000 - 262144.  The default is 10000.
  • ESERVER=n - Defines a one to eight character name of the applid of the server region that the specifying client region will send emitted data to for processing.  This parameter will only be processed if EMODE=C.
  • ESTART=value - Defines the number of emitters to be started automatically when ENABLE=Y is specified.  Valid values range between 0 and the value of the ELIMIT parameter.  The default is 1.
  • ESTRTPCT=nn - Specifies the busy percentage over which, when reached, an additional emitter will be started.  Valid values are 1 to 100.  The default is 80 percent.
  • ESTOPPCT=nn - Specifies the busy percentage under which, when reached, an active emitter will be stopped.  Valid values are 1 to 100.  The default is 20 percent.
  • ETOKEN=token-string - Specifies an HTTP connection authorization token for a Splunk connection.  This parameter will only be processed if EMETHOD is equal to HTTP.
  • ETRANID=value - Specifies the four character name of the mirror image transaction used by HTAC.  The default is HEMI.
  • EURIMAP=urimap-name - Specifies the CICS URIMAP definition that is used to determine where emitted data is to be sent.  This parameter will only be processed if EMETHOD is equal to HTTP.
  • EVLOG=(0,1,2) - Specifies the level of extractor event logging.  Specifying 0 means no logging, 1 means minimal logging, and 2 means full logging.  The default is 0.    
  • HEXTRUE=(Y/N) - Deprecated; see TASKTRUE below.
  • MANAGER=value - Defines the name of an HBz manager that is associated with the region; it is specified if the region is defined as a non-standalone server region (EMODE=S).  The default value is HBZMGR01. 
  • MOBILE=(Y/N) - Determines whether or not mobile access is allowed.  The default is N.
  • OHEADER=(C/U) - Determines whether or not correlation information is to be added to the JSON document that is emitted. Specifying C means that the header information is added only if an x-req-id header is present in the input.  Specifying U means that the header information is unconditionally added.  The default is C.
  • RPTITVL=n - Specifies the number of minutes between each activity level assessment/message.  Valid values are 1-60.  The default is 5.
  • STATS=(0,1,2) - Determines the quantity and type of statistics information generated by the TAC.  Specifying 0 means no statistics, 1 means minimal statistics, and 2 means full statistics.  The default is 0. 
  • TASKTRUE=(Y/N) - Determines whether or not the HTTP Extractor exit will be enabled.  Specifying Y means that the exit is enabled, and N means that the exit will not be enabled.  The default is Y.
  • TERMAID=(Y/N) - Deprecated as of HTAC release 1.14; see TERMTXN below.
  • TERMEOT=(Y/N) - Forces the task TRUE to be called at end of task.  The default is N. 
  • TERMTXN=(Y/N) - Sets the terminal process flag.  The default is Y.  
  • TIMEPREC=(3/6) - Determines the Unix time precision value.  The default is 3.
  • TRACE=(0/1/2) - Determines the level of tracing activity for the TAC tasks.  Specifying 0 means no tracing, 1 means minimal tracing, and 2 means full tracing.  The default is 0.
  • TRUELWA=(Y/N) - Determines whether or not a TRUE local work area is in use.  Specifying Y means that the LWA is in use.  Specifying N means that the LWA is not in use.  The default is Y.  Note:  TRUELWA=N should not be specified unless instructed to do so by HostBridge technical support.
  • WEBGLUE=(Y/N) - Determines whether or not the web global user exit (GLUE) will be enabled.  Specifying Y means that the exit is enabled, and N means that the exit will not be enabled.  The default is N.

The parameters that define emitted data restriction are:

  • DFHCBTS=(Y/N) - Determines whether or not the DFHCBTS data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is N.
  • DFHCHNL=(Y/N) - Determines whether or not the DFHCHNL data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHCICS=(Y/N) - Determines whether or not the DFHCICS data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHCICS_AD=(Y/N) - Determines whether or not the DFHCICS_AD data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHCPUT_DETAIL=(Y/N) - Determines whether or not the DFHCPUT_DETAIL data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y
  • DFHDATA=(Y/N) - Determines whether or not the DFHDATA data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHDEST=(Y/N) - Determines whether or not the DFHDEST data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHDISP_DETAIL=(Y/N) - Determines whether or not the DFHDISP_DETAIL data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHDOCH=(Y/N) - Determines whether or not the DFHDOCH data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHEXEC_DETAIL=(Y/N) - Determines whether or not the DFHEXEC_DETAIL data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHFEPI=(Y/N) - Determines whether or not the DFHFEPI data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is N.
  • DFHFILE=(Y/N) - Determines whether or not the DFHFILE data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHJOUR=(Y/N) - Determines whether or not the DFHJOUR data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHMAPP=(Y/N) - Determines whether or not the DFHMAPP data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHMISC_DETAIL=(Y/N) - Determines whether or not the DFHMISC data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHPROG=(Y/N) - Determines whether or not the DFHPROG data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHRMI=(Y/N) - Determines whether or not the DFHRMI data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSOCK=(Y/N) - Determines whether or not the DFHSOCK data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR=(Y/N) - Determines whether or not the DFHSTOR data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR_AMT=(Y/N) - Determines whether or not the DFHSTOR_AMT data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR_HWM=(Y/N) - Determines whether or not the DFHSTOR_HWM data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR_OCC=(Y/N) - Determines whether or not the DFHSTOR_OCC data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR_PC=(Y/N) - Determines whether or not the DFHSTOR_PC data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSTOR_REQ=(Y/N) - Determines whether or not the DFHSTOR_REQ data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSUSP_DETAIL=(Y/N) - Determines whether or not the DFHSUSP_DETAIL data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHSYNC=(Y/N) - Determines whether or not the DFHSYNC data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHTASK_AC=(Y/N) - Determines whether or not the DFHTASK_AC data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is N.
  • DFHTASK_JWM=(Y/N) - Determines whether or not the DFHTASK_JWM data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHTEMP=(Y/N) - Determines whether or not the DFHTEMP data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHTERM=(Y/N) - Determines whether or not the DFHTERM data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.
  • DFHTERM_IO=(Y/N) - Determines whether or not the subset of the DFHTERM data group that reports data counts is included in the emitted data even if DFHTRM=Y is specified.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.  
  • DFHWEBB=(Y/N) - Determines whether or not the DFHWEBB data group is included in the emitted data.  Specifying Y means that the data is included.  Specifying N means that the data is excluded.  The default is Y.


For a list of individual fields that are included in each data group, click here.