Bookshelf Home | Contents | Index | PDF |
Integration Platform Technologies: Siebel Enterprise Application Integration > 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 VBC Contact that displays simple contact information for a given account. These examples are based on the example in the Custom Business Service Examples. The output property set of the Insert and Update methods for VBC does not affect the data in the business component, unlike the Query method, which uses the output property set to populate the business component. The output property set for Insert and Update is used to indicate that what fields or record has been changed. NOTE: All the optional parameters have been omitted from these examples to simplify them. Delete MethodThe Delete method is called when a record is deleted. Figure 36 illustrates the property set for the Delete input. 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"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"> Figure 37 illustrates the property set for the Delete output. 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"?> Error Return MethodFigure 38 illustrates the property set for the Error Return, when an error is detected. 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"?> Error_spcText="Name must not be empty"/> Init MethodThe 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 39 illustrates the property set for the Init input. 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"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"/> Figure 40 illustrates the property set for the Init output. 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"?> Insert MethodThe Insert method is called when a New Record is committed. Figure 41 illustrates the property set for the Insert input. The following is the XML representation of the property set shown in Figure 41: <?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 the Insert output. NOTE: The property set for the Insert output does not affect the data in the business component. The output property set for Insert is used to indicate what fields or records were changed. The following is the XML representation of the property set shown in Figure 42: <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> PreInsert MethodThe PreInsert method is called when a New Record operation is performed. It supplies default values. Figure 43 illustrates the property set for the PreInsert input. 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"?> Business_spcComponent_spcId="1" Business_spcComponent_spcName="Contact"/> Figure 44 illustrates the property set for the PreInsert output. 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 Location="San Jose" /> Query MethodThe 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, then there will be 5 child property sets. Each property set contains a list of field names; that is, field value pairs representing the values of each field for that particular record. Figure 45 illustrates the property set for the Query input and is followed by its XML representation. 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"?> 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-type="Identifier">AccountId</node> <node value-type="TEXT" node-type="Constant">1-6</node> <sort field="Location">ASCENDING</sort> <sort field="Name">DESCENDING</sort> Figure 46 illustrates the property set for the Query output. The following is the XML representation of the property set shown in Figure 46: <?xml version="1.0" encoding="UTF-8" ?> <?Siebel-Property-Set EscapeNames="true"?> Update MethodThe Update method is called when a record is modified. Figure 47 illustrates the property set for the Update input. The following is the XML representation of the property set shown in Figure 47: <?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 48 illustrates the property set for the Update output. NOTE: The property set for Update output does not affect the data in the business component. The output property set for Update is used to indicate what fields or records were changed. The following is the XML representation of the property set shown in Figure 48: <?xml version="1.0" encoding="UTF-8" ?> |
Integration Platform Technologies: Siebel Enterprise Application Integration | Copyright © 2013, Oracle and/or its affiliates. All rights reserved. Legal Notices. | |