ReportParams Structure
Use the ReportParams structure to replace existing filters and variables in an analysis.
The ReportParams structure is common to all web services.
ReportParams Structure Fields
Fields | Description |
---|---|
String[] filterExpressions |
Specifies an array of Oracle Analytics web services filter expressions in the form Object[] filter_expression, filter_expression ... |
Variable[] variables |
Specifies an array of variable values to be set before method execution. This structure is used in executeXMLQuery() method and generateReportSQL() method. |
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. |
String viewName |
Specifies which view to use when generating XML data for the analysis. |
How Filter Expressions Are Applied to an Analysis in Web Services
Step | Internal Processing |
---|---|
1 |
Obtains XML representations of the analysis 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 analysis 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. |
How Variables Are Applied to an Analysis in Web Services
Step | Internal Processing |
---|---|
1 |
Obtains XML representations of the analysis. |
2 |
For each variable, locates all nodes in the analysis XML that have a type of variable, attribute scope equal to analysis, and inner text that matches the variable name. |
3 |
Replaces each node located in Step 2 with the new variable value. |