ExportToStream (Method)

Applies To:

ChartSection object, (CubeQuery)QuerySection object,, DataModelSection ojbect, Document object, DashboardSection object, OLAPQuerySection object, PivotSection object, QuerySection object, ResultsSection object, Section object, TableSection object, ReportSection object

Description:

Enables you to use data streaming in EPM Workspace. Streamed data displays before the entire file is exported. This feature improves performance.

If the file name and associated path information are specified when this method, this information is ignored when streaming is enabled. In the case of the full clients (Interactive Reporting Studio and Interactive Reporting Web Client), the file name and associated path information are used for writing data to disk with no additional errors cited when streaming is enabled (as in the case of export without streaming).

Note:

For UNIX users of the Export and ExportToStream methods, Interactive Reporting references the umask command of the user running the Interactive Reporting Service to determine the three-digit octal code. This code defines the read-write-execute permissions to be turned off. Typically, umask is used in .login or .profile and in the Bourne and C shells. It is a built-in command.

Note:

The use of the Export (Method) or ExportToStream (Method) does not display a prompt dialog in the EPM Workspace or Jobs/Scheduler.

Note:

You cannot export Report sections using the Excel 2007 format (*xlsx).

Syntax:

Expression.ExportToStream(
[optional] String Filename,
[optional] bqExportFileFormat FileFormat,
[optional] Boolean IncludeHeaders,
[optional] Boolean DataStreaming,
[optional] Boolean Prompt,
[optional] BqEncoding Encoding)

Expression Required:

An expression that returns an object for any of these sections:

Constants:

The ExportToStream (Method) uses the BqExportFileFormat constant group, which consists of these values:

Note:

You cannot export a report section using Excel 2007

The BqEncoding constant group values include:

Example:

This example shows how to export a Results section in a data stream to HTML. Because the streaming is enabled, no file name and associated path information have been specified:

ActiveDocument.Sections["Results"].ExportToStream("", bqExportFormatHTML, false, true, false)