Bookshelf v7.5: Business Services Methods and Their Property Sets

Integration Platform Technologies: Siebel eBusiness Application Integration Volume II > 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 virtual business component 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 example to simplify them.

Delete

The Delete method is called when a record is deleted. Figure 32 illustrates the property set for the Delete input and is followed by its XML representation.

Figure 32.  Delete Input Property Set

<?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 and is followed by its XML representation.

Figure 33.  Delete Output Property Set

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

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

<PropertySet />

Error Return

Figure 32 illustrates the property set for the Error Return, when an error is detected. The illustration is followed by its XML representation.

Figure 34.  Error Return Property Set

<?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 virtual business component is first instantiated. It initializes the virtual business component. It expects to receive the list of fields supported by the external system. Figure 35 illustrates the property set for Init input and is followed by its XML representation.

Figure 35.  Init Input Property Set

<?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 and is followed by its XML representation.

Figure 36.  Init Output Property Set

<?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 and is followed by its XML representation.

Figure 37.  Insert Input Property Set

<?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 and is followed by its XML representation.

Figure 38.  Insert Output Property Set

<?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 and is followed by its XML representation.

Figure 39.  PreInsert Input Property Set

<?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 and is followed by its XML representation.

Figure 40.  PreInsert Output Property Set

<?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 virtual business component. 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 will contain a list of field names—field value pairs representing the values of each field for that particular record. Figure 42 illustrates the property set for Query input and is followed by its XML representation.

Figure 41.  Query Input Property Set (Part 1)

Figure 42.  Query Input Property Set (Part 2)

<?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-ype="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 and is followed by its XML representation.

Figure 43.  Query Output Property Set

<?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 and is followed by its XML representation.

Figure 44.  Update Input Property Set

<?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="Max Adams" />

   <PropertySet

      Field_spcName="Phone"

      Changed="true"

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

   <PropertySet

      Field_spcName="Location"

      Changed="true"

      Field_spcValue="San Jose" />

   <PropertySet

      Field_spcName="AccessId"

      Changed="false"

      Field_spcValue="146" />

</PropertySet>

Figure 45 illustrates the property set for the Update output and is followed by its XML representation.

Figure 45.  Update Output Property Set

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

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

<PropertySet

   <PropertySet

      Phone=="(408)234-1029"

      Location="San Jose" />

</PropertySet>

Integration Platform Technologies: Siebel eBusiness Application Integration Volume II
Published: 18 July 2003