Siebel Analytics Web Administration Guide > Working with Data and Managing the Web Catalog Using Siebel Analytics Web SOAP API > Description of Structures in the Siebel Analytics Web SOAP API >
Replacing Filters and Variables in a Report Using the ReportParams Structure in the Siebel Analytics Web SOAP API
The ReportParams structure replaces existing filters and variables in a report. The ReportParams structure is common to all services in the Siebel Analytics Web SOAP API. Fields in the ReportParams Structure
|
|
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 8 shows how filter expressions are applied to a report.
Table 8. How Filter Expressions Are Applied to a Report in the Siebel Analytics Web SOAP API
|
|
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 9 shows how variables are applied to a report.
Table 9. How Variables Are Applied to a Report in the Siebel Analytics Web SOAP API
|
|
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. |
|