Examples of the Incoming XML Format

The following table contains examples of XML documents that are sent from an external system to the XML Gateway in response to a request. 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.

Method	Format of the XML Stream	Description
Delete Return	<siebel-xmlext-delete-ret/>	siebel-xmlext-delete-ret Only the XML stream tag is returned.
Error	<siebel-xmlext-status> <status-code>4</code> <error-field>Name</error-field> <error-text>Name must not be empty</error-text> </siebel-xmlext-status>	Format of the XML stream expected by the Siebel application in case of an error in the external application. If the error is specific to a field, then the field name must be specified. The tags for this XML stream, and the entire XML stream, are optional: siebel-xmlext-status This tag is used to check the status returned by the external system. status-code This tag overrides the return value. error-text This tag specifies textual representation of the error, if it is available. This tag appears in addition to the standard error message. For example, if the Siebel application attempts to update a record in the external system with a NULL Name, and this is not allowed in the external system, then the error text is set to: "Name must not be empty."
Init Return	<siebel-xmlext-fields-ret> <support field="AccountId"/> <support field="Name"/> <support field="Phone"/> <support field="Location"/> <support field="AccessId"/> </siebel-xmlext-fields-ret>	siebel-xmlext-fields-ret The fields-ret XML stream return contains the list of VBC fields supported by the external application for this instance. The following field names are reserved by the Siebel application, and must not appear in this list: Id Created Created By Updated Updated By
Insert Return	<siebel-xmlext-insert-ret> <row> <value field="AccountId">1-6</value> <value field="Name">Max Adams</value> <value field="Phone">[phone]</value> <value field="Location">Troy</value> <value field="AccessId">146</value> </row> </siebel-xmlext-insert-ret>	siebel-xmlext-insert-ret If the remote system has inserted records, then they can be returned to be reflected in the business component in an insert-ret XML stream in the row tag format as the insert-ret stream.
PreInsert Return	<siebel-xmlext-preinsert-ret> <row> <value field="Location">San Jose</value> </row> </siebel-xmlext-preinsert-ret>	siebel-xmlext-preinsert-ret Returns default values for each field, if there is any default value.
Query Return	<siebel-xmlext-query-ret> <row> <value field="AccountId">1-6</value> <value field="Name">Sara Chen</value> <value field="Phone">[phone]</value> <value field="Location">San Francisco</value> <value field="AccessId">128</value> </row> <row> <value field="AccountId">1-6</ value> <value field="Name">Eric Brown</value> <value field="Phone">[phone]</value> <value field="Location">Palo Alto </value> <value field="AccessId">129</value> </row> </siebel-xmlext-query-ret>	siebel-xmlext-query-ret The query-ret XML stream contains the result set that matches the criteria of the query. row This tag indicates the number of rows returned by the query. Each row must contain one or more value tags. The attributes that appear in row tags must be able to uniquely identify the rows. If there is a unique key in the remote data source, then it appears in the result set. If not, a unique key is generated. It is necessary to identify specific rows for DML operations. value This tag specifies the field and value pairs and must be the same for each row in the set.
Update Return	<siebel-xmlext-update-ret> <row> <value field="Location">San Jose</value> <value field="Phone">[phone]</value> </row> </siebel-xmlext-update-ret>	siebel-xmlext-update-ret If the remote system updated fields, then the fields can be returned to be reflected in the business component in an update-ret XML stream in the row tag format as the update-ret stream.