Temporary storage queue (TSQ) EP adapter

You can use the temporary storage queue (TSQ) EP adapter to emit events to any consumer that can read the event from the TS queue.

You also can use this EP adapter for the following tasks:
  • Processing event data from temporary storage records.
  • Developing and testing event specifications.
  • Testing whether events are captured when expected and whether they contain the expected data items.

The TSQ EP adapter puts CICS events on the temporary storage queue that is specified in the EP adapter specification.

The TSQ EP adapter supports the following formats:
The following table shows the emission and transactional modes that the TSQ EP adapter supports. The letter x indicates a supported combination of modes.
Table 1. TSQ EP adapter emission and transactional modes
Event processing adapter Emission mode Transactional mode Notes
SYNC ASYNC TRANS NONTRANS
TSQ x   x   For synchronous event emission, the TS queue must be recoverable for transactional events and unrecoverable for non-transactional events. The TSQ EP adapter is generally used for testing and debugging, not production.
x     x
  x x  
  x   x
The following table shows the properties of the TSQ EP adapter.
Table 2. Temporary storage queue (TSQ) EP adapter properties
Data Element Description
Queue name The name of the TS queue to which you want the TSQ EP adapter to send events.
CICS system ID | blank (default) The CICS system ID of the TS queue to which the event is to be written. The default is to leave this field blank for the local system ID.
Use auxiliary temporary storage A check box to select the use of auxiliary temporary storage.

You specify business events and the CICS EP adapters that they use by using the CICS event binding editor. For more information about adapter properties and supported formats, see Specifying EP adapter and dispatcher information.

The DFHECEAT program name and CEPT default transaction are defined for you by CICS.

A logical event contains context and formatted captured data values. The logical event is written to a single temporary storage queue record.

Main temporary storage is typically used if small amounts of data are to be stored, the data is needed for only short periods of time, and the data does not need to be recoverable. Main temporary storage data is in 64-bit (above-the-bar) storage.

Auxiliary temporary storage is typically used if large volumes of data are to be stored, the data is needed for extended periods of time, and the data is to be maintained from one CICS run to the next. Auxiliary temporary storage queue data is held on the CICS-managed VSAM Entry-Sequenced Data Set (ESDS) DFHTEMP and uses 31-bit storage. It can be defined as a recoverable CICS resource.

The queue can be defined as recoverable because event processing does not delete the queue record after writing it.

If you use a temporary data set when writing the temporary storage records and the data set becomes full, CICS suspends the EP adapter until space becomes available.

The TSQ EP adapter writes the TS queue record with the NOSUSPEND option to prevent the suspension of either the dispatcher task or the adapter task when a user ID is specified for the adapter task.

If the default value of AUXILIARY is used, data is written to DFHTEMP. When MAIN is specified, data is written to main temporary storage. Either value can be overridden by a TSMODEL or temporary storage pool.

The event data comes from containers each with a maximum data length of 2097152 KB. Temporary storage queues support 32763 bytes of data per record; events that exceed this record length are truncated. The TSQ EP adapter supports 16-byte queue names and writes 1 TS queue record per event.