Examples of the Outgoing XML Format

Examples of the XML documents generated and sent by the XML Gateway to the external system are presented in the following table. These examples are based on the Siebel eScript example in Custom Business Service Examples. See DTDs for XML Gateway Business Service for examples of the DTDs that correspond to each of these methods.

Note: The XML examples in this chapter have extraneous carriage returns and line feeds for ease of reading. Delete all the carriage returns and line feeds before using any of the examples.

Method Format of the XML Stream Description

Method	Format of the XML Stream	Description
Delete Request	`<siebel-xmlext-delete-req>` `<buscomp id="1">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `<row>` `<value field="AccountId">146</value>` `<value field="Name">Max Adams</value>` `<value field="Phone">(408)234-1029</<value>` `<value field="Location">San Jose</value>` `<value field="AccessId">146</value>` `</row>` `</siebel-xmlext-delete-req>`	siebel-xmlext-delete-req This tag requests removal of a single record in the remote system.
Init Request	`<siebel-xmlext-fields-req>` `<buscomp id="1">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `</siebel-xmlext-fields-req>`	siebel-xmlext-fields-req This tag fetches the list of fields supported by this instance. buscomp Id The business component ID. remote-source The remote source from which the service is to retrieve data for the business component.
Insert Request	`<siebel-xmlext-insert-req>` `<buscomp id="1">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `<row>` `<value field="AccountId">1-6</value>` `<value field="Name">Max Adams</value>` `<value field="Phone">(398)765-1290</value>` `<value field="Location">Troy</value>` `<value field="AccessId"></value>` `</row>` `</siebel-xmlext-insert-req>`	siebel-xmlext-insert-req This tag requests the commit of a new record in the remote system. The insert-req XML stream contains values for fields entered through the business component.
PreInsert Request	`<siebel-xmlext-preinsert-req>` `<buscomp id="1">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `</siebel-xmlext-preinsert-req>`	siebel-xmlext-preinsert-req This tag allows the connector to provide default values. This operation is called when a new row is created, but before any values are entered through the business component interface.
Query Request	`<siebel-xmlext-query-req>` `<buscomp id="1">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `<max-rows>6/max-rows>` `<search-string>=([Phone] IS NOT NULL) AND ([AccountId] = "1-6")</search-string>` `<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>` `</Siebel-xmlext-query-req>`	siebel-xmlext-query-req This tag queries by example. The query-req XML stream contains parameters necessary to set up the query. In this example, the query requests that record information be returned from the remote system. max-rows Maximum number of rows to be returned. The value is the Maximum Cursor Size defined at the VBC plus one. If the Maximum Cursor Size property is not defined at the VBC, then the max-rows property is not passed. search-string The search specification used to query and filter the information. search-spec Hierarchical representation of the search-string. For information, see Search-Spec Node-Type Values. sort-spec List of sort fields and sort order. Note: In some cases you might retrieve external data for display in a child list applet, using a link to a parent business component. If the parent business component field on which the link is based is empty, then the query request is sent without a search-spec tag, but instead with the following tag: `match field="`Child BC Fieldname`"/>`
Update Request	`<buscomp id="2">Contact</buscomp>` `<remote-source>http://throth/ servlet/VBCContacts</remote-source>` `<row>` `<value changed="false" field="AccountId">1-6</value>` `<value changed="false" field="Name">Max Adams</value>` `<value changed="true" field="Phone">(408)234-1029</value>` `<value changed="true" field="Location">San Jose</value>` `<value changed="false" field="AccessId">146</value>` `</row>` `</siebel-xmlext-update-req>`	siebel-xmlext-update-req This tag requests changes to the field values for an existing row. All values for the record are passed with the value tags, and with the changed attribute identifying the ones that have been changed through the Siebel application.

Delete Request

<siebel-xmlext-delete-req>

<buscomp id="1">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

<row>

<value field="AccountId">146</value>

<value field="Name">Max Adams</value>

<value field="Phone">(408)234-1029</<value>

<value field="Location">San Jose</value>

<value field="AccessId">146</value>

</row>

</siebel-xmlext-delete-req>

siebel-xmlext-delete-req

This tag requests removal of a single record in the remote system.

Init Request

<siebel-xmlext-fields-req>

<buscomp id="1">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

</siebel-xmlext-fields-req>

siebel-xmlext-fields-req

This tag fetches the list of fields supported by this instance.

buscomp Id

The business component ID.

remote-source

The remote source from which the service is to retrieve data for the business component.

Insert Request

<siebel-xmlext-insert-req>

<buscomp id="1">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

<row>

<value field="AccountId">1-6</value>

<value field="Name">Max Adams</value>

<value field="Phone">(398)765-1290</value>

<value field="Location">Troy</value>

<value field="AccessId"></value>

</row>

</siebel-xmlext-insert-req>

siebel-xmlext-insert-req

This tag requests the commit of a new record in the remote system.

The insert-req XML stream contains values for fields entered through the business component.

PreInsert Request

<siebel-xmlext-preinsert-req>

<buscomp id="1">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

</siebel-xmlext-preinsert-req>

siebel-xmlext-preinsert-req

This tag allows the connector to provide default values. This operation is called when a new row is created, but before any values are entered through the business component interface.

Query Request

<siebel-xmlext-query-req>

<buscomp id="1">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

<max-rows>6/max-rows>

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

<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>

</search-spec>

<sort-spec>

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

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

</sort-spec>

</Siebel-xmlext-query-req>

siebel-xmlext-query-req

This tag queries by example. The query-req XML stream contains parameters necessary to set up the query. In this example, the query requests that record information be returned from the remote system.

max-rows

Maximum number of rows to be returned. The value is the Maximum Cursor Size defined at the VBC plus one. If the Maximum Cursor Size property is not defined at the VBC, then the max-rows property is not passed.

search-string

The search specification used to query and filter the information.

search-spec

Hierarchical representation of the search-string. For information, see Search-Spec Node-Type Values.

sort-spec

List of sort fields and sort order.

Note: In some cases you might retrieve external data for display in a child list applet, using a link to a parent business component. If the parent business component field on which the link is based is empty, then the query request is sent without a search-spec tag, but instead with the following tag: match field="Child BC Fieldname"/>

Update Request

<buscomp id="2">Contact</buscomp>

<remote-source>http://throth/ servlet/VBCContacts</remote-source>

<row>

<value changed="false" field="AccountId">1-6</value>

<value changed="false"
field="Name">Max Adams</value>

<value changed="true" field="Phone">(408)234-1029</value>

<value changed="true" field="Location">San Jose</value>

<value changed="false" field="AccessId">146</value>

</row>

</siebel-xmlext-update-req>

siebel-xmlext-update-req

This tag requests changes to the field values for an existing row.

All values for the record are passed with the value tags, and with the changed attribute identifying the ones that have been changed through the Siebel application.