Bookshelf Home | Contents | Index | PDF |
Integration Platform Technologies: Siebel eBusiness Application Integration Volume ll > Siebel Virtual Business Components > Custom Business Service Methods > Business Services Methods and Their Property SetsThe 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. DeleteThe Delete method is called when a record is deleted. Figure 36 illustrates the property set for the Delete input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"> Figure 37 illustrates the property set for Delete output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Error ReturnFigure 36 illustrates the property set for the Error Return, when an error is detected. The illustration is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Error_spcText="Name must not be empty"/> InitThe 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 39 illustrates the property set for Init input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8"?> <?Siebel-Property-Set EscapeNames="true"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"/> Figure 40 illustrates the property set for Init output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> InsertThe Insert method is called when a New Record is committed. Figure 41 illustrates the property set for Insert input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"> Figure 42 illustrates the property set for Insert output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> PreInsertThe PreInsert method is called when a New Record operation is performed. It supplies default values. Figure 43 illustrates the property set for PreInsert input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8"?> <?Siebel-Property-Set EscapeNames="true"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"/> Figure 44 illustrates the property set for PreInsert output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> <PropertySet Location="San Jose" /> QueryThe 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 46 illustrates the property set for Query input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> search-string="([Phone] IS NOT NULL) AND ([AccountId] = "1-6")" Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"> <PropertySet AccountId="1-6" /> <node node-type="Binary Operator">AND <node node-type="Unary Operator">IS NOT NULL <node node-type="Identifier">Phone</node> <node node-type="Binary Operator">= <node node-ype="Identifier">AccountId</node> <node value-type="TEXT" node-type="Constant">1-6</node> <sort field="Location">ASCENDING</sort> <sort field="Name">DESCENDING</sort> Figure 47 illustrates the property set for Query output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> UpdateThe Update method is called when a record is modified. Figure 48 illustrates the property set for Update input and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"> Field_spcValue="(408)234-1029" /> Figure 49 illustrates the property set for the Update output and is followed by its XML representation. <?xml version="1.0" encoding="UTF-8" ?> |
Integration Platform Technologies: Siebel eBusiness Application Integration Volume ll |