Siebel Analytics Web Services Guide > Description of Structures in the Siebel Analytics Web SOAP API >

ReportParams Structure


The ReportParams structure replaces existing filters and variables in a report. This structure is common to all services in the Siebel Analytics Web SOAP API. Table 14 lists the fields in this structure.

Table 14. ReportParams Structure Fields
Fields
Description

Object[] filterExpressions

An array of Siebel Analytics Web filter expressions or their character string representations, in the form Object[] filter_expression, filter_expression ...

Variable [] variables

An array of Siebel Analytics Web variables represented as character strings, in the form Variable [] variable, variable ...

NameValuePair[] nameValues

Should be set to NULL. This field is for internal use only.

TemplateInfo[] templateInfos

Should be set to NULL. This field is for internal use only.

Table 15 shows how filter expressions are applied to a report.

Table 15. How Filter Expressions Are Applied to a Report in the Siebel Analytics Web SOAP API
Step
Internal Processing

1

Obtains XML representations of the report and each filter expression.

2

For each expression element, locates the child node of the type sqlExpression (the type is determined by the value of the xsi:type attribute), and references its inner text.

3

In the report XML, locates all nodes that also have a child node of type sqlExpression where the inner text matches that located in the preceding step.

4

Replaces all nodes found in Step 3 with the expression from Step 2.

Table 16 shows how variables are applied to a report.

Table 16. How Variables Are Applied to a Report in the Siebel Analytics Web SOAP API
Step
Internal Processing

1

Obtains XML representations of the report.

2

For each variable, locates all nodes in the report XML that have a type of variable, attribute scope equal to report, and inner text that matches the variable name.

3

Replaces each node located in Step 2 with the new variable value.

Siebel Analytics Web Services Guide