Scribd
Upload
119 views

Integrationframework PDF

The Integration Framework Service handles transformations and event delivery to middleware. It can be invoked via JBC, C++, and Java APIs. The service contains methods for finding, polling, and transforming events by flow name and criteria. It also has methods for getting transaction IDs and marking events as delivered.

Uploaded by

Mohamed Amin Messaoud
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
119 views

Integrationframework PDF

The Integration Framework Service handles transformations and event delivery to middleware. It can be invoked via JBC, C++, and Java APIs. The service contains methods for finding, polling, and transforming events by flow name and criteria. It also has methods for getting transaction IDs and marking events as delivered.

Uploaded by

Mohamed Amin Messaoud
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 7

Introduction

Integration Framework Service is used by to perform event delivery to a middleware and to perform
transformations
Overview
Integration Framework Service handles the following the high-level operations:

 Transformations

 Event Delivery through middleware


Invoking Framework Service Operations
Framework Service is available as a T24 component and can be invoked using the following
interfaces:

 JBC API will be available to use by other T24 components

 C++ API will be available to use by 3rd party systems with C++ supported technologies.

 Java API will be available to use by 3rd party systems with Java supported technologies.

Note: Refer "Deploying a component Service” User Guide, to know about the various ways in which a
service could be deployed. This user guide deals with the configuration of Framework Service as Web
Service.
Framework Service Methods
The following table lists the various Framework Service Methods:

findEventsByFlow This method is used find the events based on the flow name.

pollEventsByFlow This method is used poll events from based on the flow name

pollEventsByCriteria This method is used poll events from based on the provided
criteria

pollLatestEventsByCriteri This method is used poll events from based on the provided
a criteria that are generated after the timestamp provided as input

getTransactionId This method is get the transaction ID for which the event will be
genetated for a TSA Service exit point.

setEventsDelivered This method marks the events that are delivered as delivered

transform This method constructs the event XML from the data
Framework Service Method Explained:
findEventsByFlow

This method is used find the events based on the flow name.

Parameter Type Description Directio Forma


Name n t

flowName String Holds the name of the flow IN


that is to be searched

eventMessages EventMessage Holds the list of event that OUT


s belongs to the flowName

pollEventsByFlow

This method is used poll events from based on the flow name

Parameter Type Description Directio Forma


Name n t

flowName String Holds the name of the flow IN


that is to be searched

eventMessages EventMessage Holds the list of event that OUT


s belongs to the flowName

pollEventsByCriteria

This method is used poll events from based on the provided criteria

Parameter Type Description Directio Forma


Name n t

flowName String Holds the name of the flow IN


that is to be searched

eventMessages EventMessage Holds the list of event that OUT


s belongs to the flowName
pollLatestEventsByCriteria

This method is used poll events from based on the provided criteria that are generated after the
timestamp provided as input

Parameter Type Description Directio Forma


Name n t

flowName String Holds the name of the flow that is to IN


be searched

latestByTimestamp String Holds the Timestamp IN

eventMessages EventMessage Holds the list of event that belongs OUT


s to the flowName and created after
the latestByTimestamp

getTransactionId

This is a default implementation to the Integration Framework call-back which provides an option for
implementations to override the key to use in the event generation during the TSA service exit
points. This implementation is to return the incoming key as it is - not providing any additional
functionality.

Parameter Type Description Directio Forma


Name n t

flowBaseData FlowBaseData Holds the flow name and flow IN


source

serviceContext ServiceContex Holds the details about the IN


t TSA job, the processing ID,
Date and the Company ID

transactionId TransactionId New key based on which IF OUT


generated events

setEventsDelivered

This method marks the events that are delivered as delivered


Parameter Name Type Description Directio Forma
n t

eventMessageId Strin List of message ID’s that are to be IN


s g marked as delivered

Transform

This is a default implementation to the Integration Framework call-back which provides an option for
implementations to apply any transformation to have the event building further customized. It is
expected that the implementations would make use of the incoming data to 1) filter any unwanted
events 2) modify the event data to get a customized event XML built or 3) provide an event XML
document completely built outside which integration framework would simply take it for delivery.

This default implementation would return the "TransformResult>transformStatus" to be


"NO_TRANSFORM" to indicate that there is no transform activity performed so that integration
framework would go ahead to build the event XML.

Parameter Name Type Description Directio Forma


n t

flowMetadata flowMetadata Holds the details about IN


the flow

transactionContex TransactionContex Holds the transaction INOUT


t t data and the event
common data

transformResult TransformResult Holds the transform OUT


status and the
transformed event

You might also like