Bookshelf Home | Contents | Index | Search | PDF

Siebel Financial Services Connector for VCML Guide > VCML Connector Configuration >

Integration Objects

---

Integration objects are the data containers used within the workflow environment. They represent the data structure of either a Siebel business object or an external application's data object. Integration objects are flexible structures and can be used in multiple ways within the architecture. Table 25 describes how integration objects are used.

Table 25. Integration Object Types and Their Usage

Integration Object Type	Identification Criteria	Example	Purpose
Internal Integration Object	Base Object Type = Siebel Business Object	RequestClaimStatusDate	Represent the structure of the Siebel business object used as a data source for the message.
External Integration Object	Base Object Type = XML	Health_Care_Claim__Professional_RQ	Represent the structure of the XML message.
Dispatcher map integration object	Only contains a list of integration object user properties	VCMLDispMap	Store information used by the FINS VCML XML Dispatcher that correlates internal integration objects, external integration objects, and data transformation maps.
Envelope integration object	Contains the top-level tag in a VCML message (Interchange)	VCMLEnv	Represent the structure of the outermost levels of the VCML message.

Different integration objects can be created and modified with different tools. Table 26 lists the methods provided within the Siebel Financial Services application to create and maintain these integration objects.

Table 26. Integration Object Types and Methods to Create Them

Integration Object Type	How to Create
External	Use the FINS VCML Wizard Service.
Internal	Use the FINS VCML Wizard Service or EAI Siebel Wizard.
Dispatcher Map	Dispatcher maps are implicitly updated by the FINS VCML Wizard Service.
Envelope	Envelopes are optionally created by the FINS VCML Wizard Service.

Internal Integration Objects

Internal integration objects can be created in two ways—by the FINS VCML Wizard Service or by the EAI Siebel Wizard. Both methods produce the same internal integration object.

The FINS VCML Wizard Service has the advantage of associating the internal integration object with its corresponding external integration in the dispatcher map.

If you choose to create your internal integration objects using the EAI Siebel Wizard or use existing internal integration objects, you need to manually update the dispatcher map to associate the internal integration object and the correct external integration object.

Table 27 lists the internal integration objects that are delivered with the Siebel Financial Services Connector for VCML.

Table 27. Internal Integration Object Types

Integration Object Name	Description
RequestClaimStatusDate	Integration object that is a subset of the Siebel business object FINS Health Provider used for the VCML XML message RequestClaimStatusDate.
RqClaimsAdjudiction	Integration object that is a subset of the Siebel business object FINS Health Provider used for the VCML XML message Request ClaimAdjudication.

External Integration Objects

External integration objects in VCML format can be generated by the FINS VCML Wizard Service. This Wizard reads the VCML DTD and creates a corresponding external integration object that matches the structure of the message body of the selected message. These integration objects only represent the message body part of the VCML message. The header, or common part of the VCML message, is stored in the envelope integration object.

Table 28 lists the external integration objects that are delivered with the Siebel Financial Services Connector for VCML.

Table 28. External Integration Object Types

Integration Object Name	Description
Health_Care_Claim__Professional_RQ	Integration object that matches the structure of a VCML request. Generated with the FINS VCML Wizard Service.
Health_Care_Claim__Professional_RS	Integration object that matches the structure of a VCML response. Generated with the FINS VCML Wizard Service.

Dispatcher Map Integration Objects

Dispatcher map integration objects contain a lookup table used by the dispatcher that associates internal integration objects, external integration objects, and data transformation maps. This lookup table is stored in the user property section of the dispatcher map integration object.

The VCMLDispMap dispatcher map is the only dispatcher map integration object in the Siebel Financial Services Connector for VCML.

The dispatcher map is used by the FINS VCML XML Dispatcher. The dispatcher map is an integration object that provides a rule set for handling incoming VCML messages. The dispatcher map is created and updated by the FINS VCML Wizard Service during the process of creating external and internal integration objects.

The map contains information that associates message instances with the appropriate internal and external integration objects for incoming and outgoing messages. It associates each incoming or outgoing message with the Siebel Financial Services Connector for VCML elements that are necessary to translate it into Siebel data.

The map contains DTE map names, the internal integration object names, the external integration object names, and FINS VCML XML Transaction Manager business service operations. These elements make up the translation scheme for the message instance. The dispatcher map allows the dispatcher to associate the proper translation scheme with each message instance. The mapping information is stored in the user property of the dispatcher map integration object. Table 29 describes the sample dispatcher map entry, and descriptions of the records.

Table 29. Sample Dispatcher Map

User Property	Value	Description
Name	Interchange/Division/Health_Care_Claim__Professional_RQ	Each name separated by a slash identifies a separate element in the XML document. This dispatcher map entry applies to the <Health_Care_Claim__Professional_RQ> tag that is a child of the <Division> tag, which in turn is a tag of the <Interchange> tag.
Value	Interchange/Division/Health_Care_Claim__Professional; Health_Care_Claim__Professional_ERqIRqMapIn; Health_Care_Claim__Professional_IRsERsMapOut; Health_Care_Claim__Professional_RQ; RqClaimsAdjudication; SAUpsert;	Each of the six value components are detailed in Table 30.

Table 30 describes the components of the Value field in a dispatch map entry.

Table 30. Components of the Value Field in a Dispatcher Map

Number	Value Component	Description
1	Interchange/Division/Health_Care_Claim__Professional	The VCML message, not used by the dispatcher.
2	Health_Care_Claim__Professional_ERqIRqMapIn	The name of the data transformation map to use for requests from external systems. The generated mnemonics have the following meaning: ERq = External Request as the source IRq = Internal Request as the destination MapIn = incoming map
3	Health_Care_Claim__Professional_IRsERsMapOut	The name of the data transformation map to use for generating responses to queries from external systems. The generated mnemonics have the following meaning: IRs = Internal response as the source ERs = External response as the destination MapOut = Outgoing map.
4	Health_Care_Claim__Professional_RQ	The external integration object to use for the message body.
5	RqClaimsAdjudication	The internal integration object to use for queries and updates to Siebel.
6	SAUpsert	The action to perform on the FINS VCML XML FINS VCML XML Transaction Manager business service. This component must match a user property on that business service.

Envelope Integration Object

An envelope integration object provides the envelope and header information needed by the VCML XML hierarchy.

A typical VCML envelope integration object contains the following four parts:

<ISA desc = "Integration Control Header">

<IEA desc = "Integration Control Trailer">

<GS desc = "Functional Group Header">

<GE desc = "Functional Group Trailer">

Where each of the parts contains a list of elements that provides detailed header and trailer information.

Bookshelf Home | Contents | Index | Search | PDF