Integration Platform Technologies: Siebel Enterprise Application Integration > Siebel Virtual Business Components > Custom Business Service Methods >

Business Services Methods and Their Property Sets

The following examples display each method's input and output property sets for a VBC Contact that displays simple contact information for a given account. These examples are based on the example in the Custom Business Service Example.

NOTE:  All the optional parameters have been omitted from these examples to simplify them.

Delete

The Delete method is called when a record is deleted. Figure 32 illustrates the property set for the Delete input.

Figure 32. Delete Input Property Set

The following is the XML representation of the property set shown in Figure 32:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact">

<PropertySet

AccountId="1-6"

Name="Max Adams"

Phone="(408)234-1029"

Location="San Jose"

AccessId="146" />

</PropertySet>

Figure 33 illustrates the property set for Delete output.

Figure 33. Delete Output Property Set

The following is the XML representation of the property set shown in Figure 33:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet />

Error Return

Figure 34 illustrates the property set for the Error Return, when an error is detected.

Figure 34. Error Return Property Set

The following is the XML representation of the property set shown in Figure 34:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet>

<Status Status="4"

Error_spcField="Name"

Error_spcText="Name must not be empty"/>

</PropertySet>

Init

The Init method is called when the VBC is first instantiated. It initializes the VBC. It expects to receive the list of fields supported by the external system.

NOTE:  When a field is not initialized in the Init method of the VBC, the Update method is not fired when the field gets updated.

Figure 35 illustrates the property set for Init input.

Figure 35. Init Input Property Set

The following is the XML representation of the property set shown in Figure 35:

<?xml version="1.0" encoding="UTF-8"?>

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

<PropertySet

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact"/>

Figure 36 illustrates the property set for Init output.

Figure 36. Init Output Property Set

The following is the XML representation of the property set shown in Figure 36:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

AccountId=""

Name=""

Phone=""

Location=""

AccessId="" />

Insert

The Insert method is called when a New Record is committed. Figure 37 illustrates the property set for Insert input.

Figure 37. Insert Input Property Set

The following is the XML representation of the property set shown in Figure 37:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact">

<PropertySet

AccountId="1-6"

Name="Max Adams"

Phone="(398)765-1290"

Location="Troy"

AccessId="" />

</PropertySet>

Figure 38 illustrates the property set for Insert output.

Figure 38. Insert Output Property Set

The following is the XML representation of the property set shown in Figure 38:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

<PropertySet

AccountId="1-6"

Name="Max Adams"

Phone="(398)765-1290"

Location="Troy"

AccessId="146" />

</PropertySet>

PreInsert

The PreInsert method is called when a New Record operation is performed. It supplies default values. Figure 39 illustrates the property set for PreInsert input.

Figure 39. PreInsert Input Property Set

The following is the XML representation of the property set shown in Figure 39:

<?xml version="1.0" encoding="UTF-8"?>

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

<PropertySet

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact"/>

Figure 40 illustrates the property set for PreInsert output.

Figure 40. PreInsert Output Property Set

The following is the XML representation of the property set shown in Figure 40:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet>

<PropertySet Location="San Jose" />

</PropertySet>

Query

The Query method is called when a search is performed. The Query method must be supported by every VBC. Each record that matches the query is represented as a property set. For example, if 5 records match the query, there will be 5 child property sets. Each property set contains a list of field names—field value pairs representing the values of each field for that particular record. Figure 41 and Figure 42 illustrate the property set for Query input.

Figure 41. Query Input Property Set (Part 1)

Figure 42. Query Input Property Set (Part 2)

The following is the XML representation of the property set shown in Figure 41 and Figure 42:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

max-rows="6"

search-string="([Phone] IS NOT NULL) AND ([AccountId] = "1-6")"

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact">

<PropertySet AccountId="1-6" />

<search-spec>

  <node node-type="Binary Operator">AND

  <node node-type="Unary Operator">IS NOT NULL

  <node node-type="Identifier">Phone</node>

    </node>

    <node node-type="Binary Operator">=

    <node node-type="Identifier">AccountId</node>

    <node value-type="TEXT" node-type="Constant">1-6</node>

    </node>

  </node>

</search-spec>

<sort-spec>

  <sort field="Location">ASCENDING</sort>

  <sort field="Name">DESCENDING</sort>

</sort-spec>

</PropertySet>

Figure 43 illustrates the property set for Query output.

Figure 43. Query Output Property Set

The following is the XML representation of the property set shown in Figure 43:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet>

<PropertySet

AccountId="1-6"

Name="Sara Chen"

Phone="(415)298-7890"

Location="San Francisco"

AccessId="128" />

<PropertySet

AccountId="1-6"

Name="Eric Brown"

Phone="(650)123-1000"

Location="Palo Alto"

AccessId="129" />

</PropertySet>

Update

The Update method is called when a record is modified. Figure 44 illustrates the property set for Update input.

Figure 44. Update Input Property Set

The following is the XML representation of the property set shown in Figure 44:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

Business_spcComponent_spcId="1"

Business_spcComponent_spcName="Contact">

<PropertySet

Field_spcName="AccountId"

Changed="false"

Field_spcValue="1-6"/>

<PropertySet

Field_spcName="Name"

Changed="false"

Field_spcValue="MaxAdams"/>

<PropertySet

Field_spcName="Phone"

Changed="true"

Field_spcValue="(408)234-1029"/>

<PropertySet

Field_spcName="Location"

Changed="true"

Field_spcValue="SanJose"/>

<PropertySet

Field_spcName="AccessId"

Changed="false"

Field_spcValue="146" />

</PropertySet>

Figure 45 illustrates the property set for the Update output.

Figure 45. Update Output Property Set

The following is the XML representation of the property set shown in Figure 45:

<?xml version="1.0" encoding="UTF-8" ?>

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

<PropertySet

<PropertySet

Phone=="(408)234-1029"

Location="San Jose" />

</PropertySet>