Information on Request XML


Information on Request XML

Today i would like to give some information on Report XML.
Every request internally stored as xml. i.e Request XML, you can view request xml in two ways, goto request’s advanced tab, under Request XML segment you can view this xml or Using Catalog Manager – locate report— on report right click – choose properties –click on Edit XML button—pops window with xml.
Here is through catalog manager.
In general creating a new request throughUI consists of criteria, results, prompts same thing with xml file, it compromise of three main divisions criteria, views, prompts under root node report.
Every request consists of common xml namespace (identified with uniquely named elements and attributes) attributes i.e xmlns
Then next part is criteria (report — criteria)
Criteria element again divided into two major elements Columns, Filters same as UI web construction.
Here is an example with namespaces and all available columns in report.
If you expand column, it internally composed from column related elements and attributes, here is a sample.
Then second large part in criteria is Filters, as show like below
Then next part in report is Views (report –views), in this section consists of all available views for corresponding report.
Last section in report is prompts, here all propmpt related things will be defined in xml, like caption, on which column, control etc
Following chart consist of some of basic elements or attributes and why they are used.
Element
Possible Attributes/Child Elements
Description
saw:report
Is a root element
saw:report
xmlns:saw="com.siebel.analytics.web/report/v1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sawx="com.siebel.analytics.web/expression/v1"
Possible namespace
saw:report
xmlVersion="200705140"
Version of xml
saw:criteria
It’s a saw:report child node.
Consist of all columns and filter related stuff in this section
saw:criteria
subjectArea="Paint"
Defines subject area
saw:criteria
saw:columns
Consist of all report related columns
saw:columns
saw:column
To define column related properties
saw:column
Formula
Defines which column it refer to in presentation layer
saw:column
ColumnID
To identify uniquely across referring report
saw:column
saw:displayFormat exp:
To display cell display properties
saw:column
saw:dataFormat
To display column display properties
saw:column
saw:condition
Exp:
sawx:expr xsi:type="sawx:comparison" op="equal">
ALBANY
To display conditional display
saw:column
saw:navigation
To control drill downs or navigation to other reports
saw:navigation
saw:navTarget
To define navigation target and path
saw:navTargets
Caption
To display Caption
saw:column
saw:columnHeading
exp:
Market
To define header name
saw:filter
subjectArea
To define referring subject area
saw:filter
sawx:expr
To define expression type
Possible expression categories
sawx:expr
xsi:type
To define logical conditions types
Comparison
sqlExpression
savedFilter
string etc.
sawx:expr
op
Operator
saw:views
Is child node of report sibling of criteria element used to customize report layout formats i.e. pivot,table,static view etc
saw:views
currentView
Is one among several display layouts
saw:views
saw:view
To displayor customize particular view
saw:view
xsi:type
To define which view we needed
Here all possible views
saw:titleView
saw:tableView
saw:staticchart
saw:pivotTableView
saw:filtersView
saw:htmlview
saw:narrativeView
saw:sqlview
saw:segmentview
saw:targetlistview
saw:colFilterPrompt
saw:view
saw:cvTable
Compound layout can consist many views ..they are defined as table
saw:cvTable
saw:cvRow
Each view as row
saw:view
autoPreview="true"
Decides whether to display automatically results or not when we access view
saw:prompts
Is a sibling of criteria, view elements or child of report element
Which is used to define prompts
saw:prompts
xsi:type="saw:colFilterPrompt"
To define type of prompt
saw:prompts
Formula
To define presentation column
saw:prompts
subjectArea
To define which subject area
saw:prompts
Op
Operator
saw:prompts
controlType
To set control exp dropdown or edit box or multi selector
saw:prompts
saw:promptCaption
To set caption of prompt

There are few more advanced option which have not mentioned in above chart.

If you have any problem in viewing description in above chart, please find doc file here.

If you need my refernced Request XML file composed on top of paint, then please find here.

Labels: