AnalysisExportViewsService Service

Use the AnalysisExportViewsService service to initiate export of analysis reports and retrieve exported files in PDF, MHTML, Excel, and CSV formats.

Method Name Description

completeAnalysisExport() Method

Retrieves the exported files.

initiateAnalysisExport() Method

Initiates and retrieves the exported files of analysis.

completeAnalysisExport() Method

Use the completeAnalysisExport() method to retrieve exported files in PDF, MHTML, Excel, or CSV formats.

Signature

completeAnalysisExport(String queryID, String sessionID);

Arguments Description

String queryID

Specifies query ID returned by the initiateAnalysisExport() method. See initiateAnalysisExport() Method.

String SessionID

Specifies the unique session ID.

Returns

Returns an output as defined in the AnalysisExportResult structure.

For information on the AnalysisExportResult structure, see AnalysisExportResult Structure.

initiateAnalysisExport() Method

Use initiateAnalysisExport() method to initiate and retrieve exported files of analysis in the following formats - PDF, MHTML, Excel, CSV.

Signature

initiateAnalysisExport(ReportRef reportRef, AnalysisExportOutputFormat outputFormat, AnalysisExportExecutionOptions executionOptions, ReportParams reportParams, String reportViewName, String sessionID);

Arguments Description

ReportRef reportRef

Specifies the path to the analysis definition, supplied in the ReportRef common structure.

AnalysisExportOutputFormat outputFormat

Specifies one of the following output formats that you can select:

  • String PDF - Specifies the PDF format

  • String MHTML - Specifies the MHTML format

  • String Excel 2007 - Specifies the Excel 2007 format

  • String CSV - Specifies the CSV format

AnalysisExportExecutionOptions executionOptions

Specifies the execution options in the AnalysisExportExecutionOptions structure.

ReportParams reportParams

Specifies the filters or variables to apply to the analysis before execution, supplied in the ReportParams common structure.

String reportViewName

Specifies the view to export. If this parameter is null, the analysis default view is used. The view name should match the one used to identify the view in the analysis XML definition.

String sessionID

Specifies the session ID.

Returns

Returns an output as defined in the AnalysisExportResult structure.

For information on the AnalysisExportResult structure, see AnalysisExportResult Structure.