Transaction Server event handler configuration for CIFF extract

To automate CIFF extract processing as entries are processed, configure the Transaction Server to alert the Services Framework of specific entry events. CIFF extract tasks cannot be scheduled to run periodically.

The following example XML shows a typical configuration that uses the Transaction Server scheduler to automatically start the CIFF extract task as entries are allocated to batches. A configuration that is named CiffExtractConfiguration must already be defined for the CIFF extract task.

<EVENT>
  <NAME>CIFF Extract Event</NAME>
  <TYPE>EntryUowStateChange</TYPE>
  <EXEC>com.ibm.paydir.ima.txsvr.event.appbridge.EntryLoadedEventHandler</EXEC>
  <PARAMETER name="msgType">TaskInitiation</PARAMETER>
  <PARAMETER name="loaded">TRUE</PARAMETER>
  <PARAMETER name="destinationID">CIFF Extract</PARAMETER>
  <PARAMETER name="jmsQmgrHostname">localhost</PARAMETER>
  <PARAMETER name="jmsQmgrChannel">SYSTEM.DEF.SVRCONN</PARAMETER>
  <PARAMETER name="jmsQmgrPort">1414</PARAMETER>
  <PARAMETER name="jmsClient">true</PARAMETER>
  <PARAMETER name="jmsQmgrName">FTM.QMANAGER</PARAMETER>
  <PARAMETER name="jmsSendQueue">FXH.SERVICESFRAMEWORK.INPUT.QUEUE</PARAMETER>
  <PARAMETER name="jmsReplyQueue">FXH.TRANSSERVER.INPUT.QUEUE</PARAMETER>
  <PARAMETER name="jmsReplyTimeout">2500</PARAMETER>
</EVENT>

This event configuration is given the name "CIFF Extract Event", but you can use any unique event name. The event is started by an event with a type of Entry Loaded. The event handler relays the event to the target queue by using a messaging API message:

com.ibm.paydir.ima.txsvr.event.appbridge.EntryChangeEventHandler

The remaining parameters are used to send a message to a specified message queue on which Services Framework is listening. The following table describes the event parameters.

Table 1. CIFF extract parameters
Parameter	Description	Values from the example
msgType	Messaging API message type ID	Services Framework requires that the value of this parameter is `TaskInitiation`.
destinationID	CIFF extract task configuration name	Use the value specified for the configuration setting during task configuration.
loaded	Entry loaded state must be set before an alert is triggered	Setting this parameter to true indicates that CIFF extracts are not issued until the file is loaded. It filters any condition column changes that might occur during the load process.
jmsQmgrHostname	The hostname where the target JMS event queue manager is listening	URL of the server where the target Services Framework is running.
jmsQmgrChannel	Target server JMS channel name	JMS channel on the target Services Framework server.
jmsQmgrPort	JMS port	JMS port on which the target JMS system is listening.
jmsClient	Target JMS system is a client system	Always true unless Services Framework is running where the main IBM® MQ server is installed.
jmsQmgrName	Target JMS queue manager name	JMS queue manager on the target Services Framework server.
jmsSendQueue	Target JMS queue	The target JMS queue that Services Framework is listening on.
jmsReplyQueue	JMS queue used to request a response	Transaction Server JMS queue where a response is expected. If this parameter is not specified, a response is not needed and the notification is asynchronous.
jmsReplyTimeout	Number of milliseconds the Transaction Server waits for a response	The value of this parameter is ignored if the JMS reply queue is unspecified.

The Transaction Server XML code sample Scheduler_CiffExtractTask.xml can be used as a starting point to set up the event handler. The sample must be modified to show the correct CIFF extract configuration and IBM MQ setup before it is used.