Siebel Portal Framework Guide > Delivering Content to External Web Applications > XML Response Structure >

XML Response


When the SWESetMarkup attribute in a command block is set to XML, the response payload from the Siebel Business XML Web server is returned in XML format. The payload consists of an XML declaration followed by the core XML tags that contain and describe the data.

Each XML tag represents an object from a Siebel Business XML application screen that you requested. The attributes within each tag are read-only and represent the properties of the object.

Table 10 lists the major XML tags that are returned in a response in which the SWEDataOnly attribute is set to TRUE.

NOTE:  The response tags described in this appendix are a subset of the tags that can be returned by the SWE.

Table 10. XML Response Tags
Tag
Description and Attributes

<APPLICATION>

The root tag for each response that is returned from the SWE. The <APPLICATION> tag encloses all the XML response data.

Attribute:

  • NAME. This attribute indicates the name of the application from which the response is generated. For XML requests, the application name in the response will always be "Siebel XML."

<SCREEN>

This tag identifies the Siebel Business Application screen that is the result of, or is accessed by, the command in your request. The <SCREEN> tag also encloses all of the XML tags that identify the data within the Siebel Business Application screen.

Attributes:

  • CAPTION. This attribute indicates the caption of the Siebel Business Application screen.
  • ACTIVE. A value of TRUE indicates that the Siebel Business Application screen is active. A value of FALSE indicates that the Siebel Business Application screen is inactive.
  • NAME. This attribute indicates the Siebel Business Application screen name, which is used to identify the Siebel Business Application screen.

<VIEW>

This tag identifies the view that is the result of, or is accessed by, the command block in your request. This tag also encloses all of the XML tags that identify the data within the view.

Attributes:

  • TITLE. This attribute indicates the title of the view.
  • ACTIVE. A value of TRUE indicates that the view is active. A value of FALSE indicates that the view is inactive.
  • NAME. This attribute indicates the view name, which is used to identify the view.

<APPLET>

This tag identifies the applet that is the result of, or is accessed by, the command block in your request. It also encloses all of the XML tags that identify the data within the applet.

Attributes:

  • ROW_COUNTER. This attribute indicates how many records out of the entire set of records are currently displayed. The ROW_COUNTER attribute is a string of the form, 1 - n of N.
  • NO_DELETE. A value of TRUE indicates that the records in the applet cannot be deleted. A value of FALSE indicates that the records in the applet can be deleted.
  • NO_EXEC_QUERY. A value of TRUE indicates that a query cannot be executed in the applet. A value of FALSE indicates that a query can be executed in the applet.
  • NO_UPDATE. A value of TRUE indicates that the records in the applet cannot be updated. A value of FALSE indicates that the records in the applet can be updated.
  • MODE. Indicates the mode of the applet, which can be one of the following: Base, Edit, New, Query, Sort.

<APPLET>

(Continued

Attributes:

  • TITLE. This attribute title of the applet.
  • NO_INSERT. A value of TRUE indicates that records cannot be inserted into the applet.
  • CLASS. Indicates the class being used by the applet.
  • NO_MERGE. A value of TRUE indicates that records in the applet have not been merged. A value of FALSE indicates that the records in the applet have been merged.
  • ACTIVE. A value of TRUE indicates that the applet is active. A value of FALSE indicates that the applet is inactive.
  • ID. This attribute indicates the applet ID, and can be used to identify the applet.
  • NAME. This attribute indicates the applet name, which is used to identify the applet.

<LIST>

This tag encloses the table of records that is returned from your request. The following two tags and their subordinate tags are enclosed within the <LIST> tag:

<RS_HEADER>

<RS_DATA>

There are no attributes associated with the <LIST> tag.

<RS_HEADER>

This tag encloses all the header information about the columns in a list that your request returns. The <COLUMN>, <METHOD>, and <ERROR> tags can be enclosed within this tag.

<COLUMN>

A response can return multiple <COLUMN> tags. Each <COLUMN> tag within an <RS_HEADER> tag indicates another column within the parent list.

Attributes:

  • NUMBER_BASED. A value of TRUE indicates that the data in the column are numeric. A value of FALSE indicates that the data are not numeric.
  • CALCULATED. A value of TRUE indicates that the data in the column are calculated from other values, as opposed to being input. A value of FALSE indicates that the data are not calculated.
  • LIST_EDITABLE. A value of TRUE indicates that the data in the column are editable. A value of FALSE indicates the data are not editable.
  • HTML_TYPE. This attribute is used to indicate the type of object that is represented in the column.
  • SCALE. A value of TRUE indicates that the data in the column are scaled. A value of FALSE indicates that the data are not scaled.
  • FIELD. This attribute indicates the field name associated with the column. The value in the field name is the same as the column name.
  • HIDDEN. A value of TRUE indicates that the data in the column are hidden on the Siebel Business Application screen. A value of FALSE indicates that the data are visible on the screen.

<COLUMN>

  • DATATYPE. This attribute indicates the Siebel data-type of the data in the column.
  • DISPLAY _NAME. This attribute indicates the text string that would appear in the user interface.
  • TEXT_LENGTH. This attribute indicates the maximum length of field entries in the column.
  • TYPE. This attribute is used to indicate the type of object that is represented in the column.
  • ID. This attribute indicates the unique ID of the column.
  • TEXT_BASED. A value of TRUE indicates that the data in the column is text based. A value of FALSE indicates that the data is not text based.
  • NAME. A value of TRUE indicates that the data in the column are hidden on the Siebel Business application Siebel Business Application screen. A value of FALSE indicates that the data are visible on the screen.
  • REQUIRED. A value of TRUE indicates that the data in the column are required. A value of FALSE indicates that the data are not required.
  • READ_ONLY. A value of TRUE indicates that the data in the column are read-only and cannot be modified. A value of FALSE indicates that the data are editable.

<RS_DATA>

This tag encloses table rows that are returned from your request. The <RS_DATA> tag encloses the <ROW> tag and the <ROW> tag's subordinate tags.

<ROW>

A response can return multiple <ROW> tags. Each <ROW> tag within an <RS_DATA> tag indicates another record within the table. The <ROW> tag encloses the <FIELD> tag.

Attributes:

  • SELECTED. This attribute indicates whether the current row is selected. A value of TRUE indicates that the row is selected. A value of FALSE indicates it is not.
  • ROWID. This attribute is used to identify the row.

<FIELD>

A response can return multiple <FIELD> tags. Each <FIELD> tag within a <ROW> tag indicates another item of data within the record. The field's value is entered between the open and close <FIELD> tags.

Attributes:

  • VARIABLE. This attribute indicates the column to which the field is associated. The value of the VARIABLE attribute should coincide with the NAME attribute of a column.
  • NAME. This attribute is used to identify the field. In most cases, the field name is identical to the column name.
Siebel Portal Framework Guide