Integration Platform Technologies: Siebel Enterprise Application Integration > EAI Siebel Adapter Business Service >

Enabling Effective Dating on Fields

This topic explains how effective dating works on fields. It contains the following topics:

• Configuring Integration Components for Effective Dating on Fields
• How the XML Converter Reads Effective Dating Data from Fields
• WSDL Schema Generation for Effective Dating on Fields

Configuring Integration Components for Effective Dating on Fields

You can enable effective dating on a field in an existing integration object if the corresponding field in the business component is effective dating-enabled. You enable fields for effective dating through the Siebel Web Client administration Effective Dating screen.

To enable effective dating on fields

1. In the Siebel Web Client, navigate to Administration - Effective Dating, then Field.
2. In the Effective Dating Buscomp list, select the required business component.

   The list displays the fields already enabled for ED.

3. If you want enable effective dating field not present in this list, click New, then in the Field field click the Select button.
4. In the Business Component Fields window select the required field, then click OK.

   This enables the fields for ED.

You use Siebel Tools to synchronize the object from your current repository, with its underlying business object in the Siebel database which contains the new EDEnabled user property. For more information on synchronizing integration objects, see Synchronizing Integration Objects.

To enable effective dating on an integration object

1. In Siebel Tools, select the integration object you want to enable for effective dating.
2. Click the Synchronize button in the Integration Objects list.

   The Integration Object Synchronize wizard appears.

3. Click the plus symbol to display all the related integration components.
4. Uncheck the boxes beside the objects and components you do not want to include in the synchronization of your Siebel integration object.
5. Locate the integration component containing the effective dating-enabled fields and drill down on it.
6. Click the plus symbol to display all the user properties of the field.
7. Locate the EDEnabled user property from the list and add it to the repository side.
8. Review the summary, and if changes are needed, click Back and make the needed changes.
9. If no changes are needed, click Finish to synchronize the Siebel integration object and the Siebel business object.

How the XML Converter Reads Effective Dating Data from Fields

The XML converter reads effective dating attributes contained in an XML file, maps them to a property set, and converts the property set to an integration object instance by embedding the EDStartDate and EDEndDate attributes inside the field name.

For example: If a SOAP request contains the following query for an effective dating field:

<acc:EDListOfFirstName>

<acc:FirstName EDStartDate="04/01/2012" EDEndDate=">James</acc:FirstName>

</acc:EDListOfFirstName>

The data will be converted into a child property set of the integration component instance as follows:

c[0] CCFPropertySet@1DA79960 p#0 c#1 type="ListOfRelated Contact" vt=0 value="

{

c[0] CCFPropertySet@1D9FD870 p#1 c#2 type="Related Contact" vt=0 value="

{

p["Contact Id"] = "Contact1";

c[0] CCFPropertySet@1FD92BB0 p#0 c#1 type="EDListOfFirst Name" vt=0 value="

{

c[0] CCFPropertySet@13258470 p#2 c#0 type="First Name" vt=3 value="James"

{

["EDEndDate"] = ";

["EDStartDate"] = "04/25/2012";

}

}

}

}

The dates are now embedded into the field name.

WSDL Schema Generation for Effective Dating on Fields

Effective dating requires two complex type attributes StartDate and EndDate for each effective dating-enabled field. In the following schema example the location field is enabled for effective dating, as shown by the two additional attributes EDStartDate and EDEndDate. Historical data can be retrieved by setting the cardinality of the effective dating-enabled XSD element to unbounded.

WSDL Schema Example

<xsd:complexType name="RelatedContact">

<xsd:sequence>

<xsd:element name="ContactId" maxOccurs="1" minOccurs="0" type="xsd:string"/>

<xsd:element name="EDListOfFirstName" maxOccurs="1" minOccurs="0" type="xsdLocal1:EDListOfFirstName"/>

<xsd:element name="ContactIntegrationId" maxOccurs="1" minOccurs="0" type="xsd:string"/>

<xsd:element name="EDListOfLastName" maxOccurs="1" minOccurs="0" type="xsdLocal1:EDListOfLastName"/>

. . . .

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="EDListOfFirstName">

<xsd:sequence>

<xsd:element name="FirstName" maxOccurs="unbounded" minOccurs="0" type="xsdLocal1:FirstName"/>

</xsd:sequence>

</xsd:complexType>

<xsd:complexType name="FirstName">

<xsd:simpleContent>

<xsd:extension base="xsd:string">

<xsd:attribute name="EDStartDate" type="xsd:string"/>

<xsd:attribute name="EDEndDate" type="xsd:string"/>

</xsd:extension>

</xsd:simpleContent>

</xsd:complexType>

SOAP Query Example

The previous WSDL schema example allows you to generate the following SOAP query:

<ElementName EDStartDate=dd1/mm1/yyyy1, EDEndDate = dd2/mm2/yyy2>value</ElementName>

For example:

<acc:RelatedContact>

<acc:ContactId>88-30ARL</acc:ContactId>

<acc:EDListOfFirstName>

<acc:FirstName EDStartDate="04/01/2012" EDEndDate=">James</acc:FirstName>

</acc:EDListOfFirstName>

<acc:EDListOfLastName>

<acc:LastName EDStartDate="04/01/2012" EDEndDate=">Bond</acc:LastName>

</acc:EDListOfLastName>

</acc:RelatedContact>

Similarly you can perform insert, update, and synchronize operations on data using the WSDL Schema Example.