Integration Platform Technologies: Siebel Enterprise Application Integration > Integration Objects > About Integration Component Keys >

Status Keys

It is useful to know the status of your integrations. For example, if you are sending an order request, you might want to know the ID of the Order created so that you can query on the order in the future. You can set the StatusObject method argument of the EAI Siebel Adapter business service to true to return an integration object instance as a status object.

The status returned is defined in the Integration Component using Status Keys. A Status Key is an Integration Component key of the type Status Key. Fields defined as part of the Status Key are included in the returned StatusObject.

If a Status Key is not defined for the Integration Component then neither the component nor any of its children are included in the returned object:

• To include descendants of an Integration Component without including any of its fields in the returned status object, specify an empty Status Key.
• To include information about which one of the update, insert, or delete operations was performed during an upsert request or synchronize request, include a field named Operation in the Status Key.

Status Key Examples

For example, the AccountAshish integration object has an Account integration component with an integration component key called StatusKeyAshish, with the integration component key fields AshishName, AshishId, and AshishHomePage (Figure 15).

Figure 15. Status Key

Example with No StatusObject

When no StatusObject business service method argument is defined, as in this input XML file for an upsert operation using the EAI Siebel Adapter business service

<?Siebel-Property-Set EscapeNames="true"?>

<PropertySet>

<SiebelMessage MessageId="42-1PGR" IntObjectName="AccountAshish" MessageType="Integration Object" IntObjectFormat="Siebel Hierarchical">

<ListOfAccountAshish>

<Account Main_spcPhone_spcNumber="+33123456789" Primary_spcOrganization="Default Organization" Home_spcPage="mycompany.com" Location="France" Name="Ashish 9 Telecom"/>

</ListOfAccountAshish>

</SiebelMessage>

</PropertySet>

all of the fields in the integration component are returned:

<?Siebel-Property-Set EscapeNames="true"?>

<PropertySet ErrorContextIntComp="" ErrorContextSearchSpec="" OMErrorCode="" PrimaryRowId="42-C739Q" OMErrorSymbol="" ErrorCode="0x0" ErrorSymbol="">

<SiebelMessage MessageId="42-1PGR" MessageType="Integration Object" IntObjectName="AccountAshish" IntObjectFormat="Siebel Hierarchical">

<ListOfAccountAshish>

<Account Main_spcPhone_spcNumber="+33123456789" Primary_spcOrganization="Default Organization" Home_spcPage="mycompany.com" Location="France" Name="Ashish 9 Telecom"/>

</ListOfAccountAshish>

</SiebelMessage>

</PropertySet>

Example with StatusObject

When the StatusObject method argument is set to true, as in this input XML file:

<?Siebel-Property-Set EscapeNames="true"?>

<PropertySet StatusObject="true">

<SiebelMessage MessageId="42-1PGR" IntObjectName="AccountAshish" MessageType="Integration Object" IntObjectFormat="Siebel Hierarchical">

<ListOfAccountAshish>

<Account Main_spcPhone_spcNumber="+33123456789" Primary_spcOrganization="Default Organization" Home_spcPage="mycompany.com" Location="France" Name="Ashish 9 Telecom"/>

</ListOfAccountAshish>

</SiebelMessage>

</PropertySet>

only the fields in the status key are returned:

<?Siebel-Property-Set EscapeNames="true"?>

<PropertySet ErrorContextIntComp="" ErrorContextSearchSpec="" OMErrorCode="" PrimaryRowId="42-C739Q" OMErrorSymbol="" ErrorCode="0x0" ErrorSymbol="">

<SiebelMessage MessageId="42-1PGR" MessageType="Integration Object" IntObjectName="AccountAshish" IntObjectFormat="Siebel Hierarchical">

<ListOfAccountAshish>

<Account Id="42-C739Q" Home_spcPage="mycompany.com" Name="Ashish 9 Telecom"/>

</ListOfAccountAshish>

</SiebelMessage>

</PropertySet>

For more information on the EAI Siebel Adapter business service, see EAI Siebel Adapter Business Service.