ReportEditingService Service

Use the ReportEditingService service to merge arguments and Oracle Analytics Presentation Services data to create and return the results.

Method Names	Description
applyReportDefaults() Method	Applies analysis default arguments to the analysis and returns the results.
applyReportParams() Method	Applies report arguments to the analysis object and returns the results.
getPromptElements() Method	Retrieves a list of criteria prompt column definitions in a given analysis and current runtime state.
generateReportSQL() Method	Retrieves the SQL query for a given analysis.
getReportColumns() Method	Retrieves a list of criteria columns in an analysis.
getReportElements() Method	Retrieves a list of prompts, unprotected filters, and referenced presentation variables in the given report.

applyReportDefaults() Method

Use the applyReportDefaults() method to apply analysis default arguments to the analysis and returns the results.

Signature

String applyReportDefaults(ReportRef reportRefs, String sessionID);

Arguments	Description
ReportRef object	Specifies the path to the analysis definition, supplied in the ReportRef common structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns the result of applying the default analysis arguments to the specified analysis object.

applyReportParams() Method

Use the applyReportParams() method to apply analysis arguments to the analysis and return the results.

Signature

Object applyReportParams(ReportRef reportRef, ReportParams reportParams, boolean encodeInString, String sessionID);

Arguments	Description
ReportRef reportRef	Specifies the path to the analysis definition, supplied in the ReportRef common structure.
ReportParams reportParams	Optional. Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure.
boolean encodeInString	If set to TRUE, then the returned analysis object is encoded as a character string.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Returns the result of applying analysis arguments to the specified analysis object. If you set encodeInString to true, then the result is encoded as a character string.

getPromptElements() Method

Use the getPromptElements() method to retrieve a list of criteria prompt column definitions in a given analysis and current runtime state.

Signature

getPromptElements(ReportRef promptRef, String viewState, String viewID, String portalPath, String page, NameValuePair optionalParams, String sessionID);

Arguments	Description
ReportRef promptRef	Required. Specifies the catalog path to a saved report or a report xml document.
String viewState	Optional.Specifies the runtime viewState. Runtime prompt definition may be changed based on other prompts setting view viewState.
String viewID	Optional: Specifies the view ID
String portalPath	Optional: Specifies the dashboard catalog path where the report resides.
String page	Optional: Specifies the dashboard page name where the report resides.
NameValuePair optionalParams	Optional: Specifies the name of additional parameters which are usually used for debugging purposes.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

A set of report prompt columns.

See PromptsObjectModel Structure.

generateReportSQL() Method

Use the generateReportSQL() method to retrieve the logical SQL query for a given analysis.

Signature

String generateReportSQL(ReportRef reportRef, ReportParams reportParams, String sessionID);

Arguments	Description
ReportRef reportRef	Specifies the path to the analysis definition supplied in the ReportRef common structure.
ReportParams reportParams	Optional. Specifies the path to the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

A string containing the SQL query for the specified analysis.

getReportColumns() Method

Use the getReportColumns() method to retrieve a list of criteria columns in a given analysis.

Signature

ReportColumn[] getReportElements(String reportPath, String sessionID);

Arguments	Description
ReportRef reportRef	Specifies the path to the analysis definition supplied in the ReportRef common structure.
String sessionID	Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

ReportColumn[] - array of columns in the report.

See ReportHierarchicalColumn Structure and ReportRegularColumn Structure.

getReportElements() Method

Use the getReportElements() method to retrieve a list of all report prompts, unprotected filters, and referenced presentation variables in the given report.

Signature

String getReportElements(String reportPath, String sessionID);

Arguments	Description
String reportPath	Required. Specifies the report catalog path for the report.
String sessionID	Optional. Specifies the session ID, which is usually returned by the logon method. If the SOAP client engine can handle HTTP cookies, you can omit the session ID or set it to null.

Returns

Report ADF parameters.

If present, report ADF parameters for the following objects, in the order listed:

Prompts
Unprotected filters
Presentation variables referenced in the report
Context variables referenced by the Oracle Analytics Presentation Services

See ReportADFParameters Structure.