Skip Headers
Oracle® Fusion Middleware Developer's Guide for Oracle Business Intelligence Publisher
11g Release 1 (11.1.1)

Part Number E22259-04
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Index
Index
Go to Master Index
Master Index
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

4 ReportService

This chapter provides details on the ReportService methods that you can use to interact with the BI Publisher Report object. This includes methods for designing and defining reports, report templates, run-time operations, and parameters.

This chapter includes the following sections:

Note:

For information on debugging applications built with BI Publisher Web services, see Section 1.4, "Debugging Web Service Applications."

4.1 createReport() Method

Use the createReport() method to create a report in the BI Publisher catalog. The method enables you to set the path to the data model and supply template files and translation (XLIFF) files to the report definition.

Signature

String createReport(String reportName, String folderAbsolutePathURL, String dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String userID, String password);

Table 4-1 Parameters for createReport() Method

Parameter Description

String reportName

The report name to create with the suffix ".xdo". For example, "myreport.xdo".

String folderAbsolutePathURL

The path to the folder in which to place the created report. For example: xmlp/Reports/financials

String dataModelURL

The path to the data model that will be used as the data source for this report. For example: xmlp/Reports/financials/Data Models/my data model.xdm

String templateFileName

The file name of the template to add the report definition.

byte[] templateData

The template file.

String XLIFFFileName

The file name of the XLIFF file. You must append the locale to the XLIFF file name as follows:

template_<language code>_<country code>.xlf

where

<language_code> is the two-letter ISO 639 language code

<country_code> is the two-letter ISO 639 language code

For example: template_en_us.xlf

byte[] XLIFFData

The XLIFF file.

boolean updateFlag

If true, overwrites existing report. If false, throws error if the report exists.

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.2 createReportInSession() Method

Use the createReport() method to create a report in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

String createReport(String reportName, String folderAbsolutePathURL, String dataModelURL, String templateFileName, byte[] templateData, String XLIFFFileName, byte[] XLIFFData, boolean updateFlag, String bipSessionToken);

Table 4-2 Parameters for createReportInSession() Method

Parameter Description

String reportName

The report name to create with the suffix ".xdo". For example, "myreport.xdo".

String folderAbsolutePathURL

The path to the folder in which to place the created report. For example: xmlp/Reports/financials

String dataModelURL

The path to the data model that will be used as the data source for this report. For example: xmlp/Reports/financials/Data Models/my data model.xdm

String templateFileName

The file name of the template to add the report definition.

byte[] templateData,

The template file.

String XLIFFFileName

The file name of the XLIFF file. You must append the locale to the XLIFF file name as follows:

template_<language code>_<country code>.xlf

where

<language_code> is the two-letter ISO 639 language code

<country_code> is the two-letter ISO 639 language code

For example: template_en_us.xlf

byte[] XLIFFData

The XLIFF file.

boolean updateFlag

If true, overwrites existing report. If false, throws error if the report exists.

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.3 downloadReportDataChunk() Method

Use downloadReportDataChunk() method to download very large documents, so that the caller calls this method multiple times until all document content is downloaded. Each call to this method downloads one chunk of the document, where the beginIdx parameter refers to the file download starting point.

See Section 2.3.44, "ReportDataChunk."

Note:

When using uploadReportDataChunk() or downloadReportDataChunk() in a clustered environment, you must set the System Temporary Directory to be a shared directory accessible to all servers within the cluster. To set the System Temporary Directory:

  1. Sign in to BI Publisher with Administrator privileges.

  2. Click the Administration link.

  3. Under System Maintenance, click Server Configuration.

  4. Under General Properties in the System Temporary Directory property, enter the absolute path to a directory accessible to all servers in the cluster.

    For example, the directory can exist under ${xdo.server.config.dir}/temp but you must enter the absolute path, such as /net/subfoldera/scratch/subfolderb/11gcat/temp

Repeat this procedure for all servers in the cluster, entering the same value for System Temporary Directory.

Signature

ReportDataChunk downloadReportDataChunk(String fileID, int beginIdx, int size);

Table 4-3 Parameters for downloadReportDataChunk() Method

Parameter Description

String fileID

fileID is returned inside ReportResponse, which is returned when calling runReport() Method.

int beginIdx

The starting point of the index (default is 1).

int size

The size of the file to download (in kilobytes).


4.4 downloadReportDataChunkInSession() Method

Use downloadReportDataChunk() method to download very large documents using the bipSessionToken of a given user. The caller calls this method multiple times until all document content is downloaded. Each call to this method downloads one chunk of the document, where the beginIdx parameter refers to the file download starting point.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

ReportDataChunk downloadReportDataChunkInSession(String fileID, int beginIdx, int size, String bipSessionToken);

Table 4-4 Parameters for downloadReportDataChunkInSession() Method

Parameter Description

String fileID

fileID is returned inside ReportRequest, which is returned when calling runReport() Method.

int beginIdx

The starting point of the index (default is 1).

int size

The size of the file to download (in kilobytes).

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.5 getReportDefinition() Method

Use the getReportDefinition() method to get information about a report, such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default.

See Section 2.3.45, "ReportDefinition."

Signature

ReportDefinition getReportDefinition(String reportAbsolutePath, String userID, String password);

Table 4-5 Parameters for getReportDefinition() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.6 getReportDefinitionInSession() Method

Use the getReportDefinitionInSession() method to get information about a report using the bipSessionToken of a given user. This method returns report details such as the default template, output type, and a list of template IDs. With the list of template IDs, you can generate a report with a template other than the default.

See Section 2.3.45, "ReportDefinition."

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

ReportDefinition getReportDefinitionInSession(String reportAbsolutePath, String bipSessionToken);

Table 4-6 Parameters for getReportDefinitionInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.7 getReportParameters() Method

Use the getReportParameters() method to get an array of report parameters and their default values. With the list of parameters, you can set parameter values before running or scheduling a report.

See Section 2.3.42, "ParamNameValues."

Signature

ParamNameValues getReportParameters(ReportRequest reportRequest, String userID, String password);

Table 4-7 Parameters for getReportParameters() Method

Parameter Description

ReportRequest reportRequest

See Section 2.3.46, "ReportRequest."

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.8 getReportParametersInSession() Method

Use the getReportParameters() method to get an array of report parameters and their default values based on the bipSessionToken of a given user. With the list of parameters, you can set parameter values before running or scheduling a report.

See Section 2.3.42, "ParamNameValues."

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

ParamNameValues getReportParametersInSession(ReportRequest reportRequest, String bipSessionToken);

Table 4-8 Parameters for getReportParametersInSession() Method

Parameter Description

ReportRequest reportRequest

See Section 2.3.46, "ReportRequest."

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.9 getReportSampleData() Method

Use the getReportSampleData() method to retrieve the sample data file stored with the report data model.

Signature

byte[] getReportSampleData(String reportAbsolutePath, String userID, String password);

Table 4-9 Parameters for getReportSampleData() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report data model sample data. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.10 getReportSampleDataInSession() Method

Use the getReportSampleDataInSession() method to retrieve the sample data file stored with the report data model based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

byte[] getReportSampleData(String reportAbsolutePath, String bipSessionToken);

Table 4-10 Parameters for getReportSampleDataInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report data model sample data. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.11 getTemplate() Method

Use getTemplate() method to retrieve a template from a report definition in the BI Publisher catalog.

Signature

byte[] getTemplate(String reportAbsolutePath, String templateID, String locale, String userID, String password);

Table 4-11 Parameters for getTemplate() Method

Parameter Description

String reportAbsolutePath

The path to the report to which the template is associated. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateID

The ID of the template (for example, Chart Layout).

String locale

The locale of the template to retrieve (for example, en_US).

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.12 getTemplateInSession() Method

Use getTemplateInSession() method to retrieve a template from a report definition in the BI Publisher catalog based on the bipTokenSession of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

byte[] getTemplateInSession(String reportAbsolutePath, String templateID, String locale, String bipSessionToken);

Table 4-12 Parameters for getTemplateInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report to which the template is associated. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateID

The ID of the template (for example, Chart Layout).

String locale

The locale of the template to retrieve (for example, en_US).

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.13 getTemplateParameters() Method

Use the getReportParameters() method to get the parameters for a template.

See Section 2.3.41, "ParamNameValue."

Signature

ParamNameValue[] getTemplateParameters(String reportAbsolutePath, String templateID, String userID, String password);

Table 4-13 Parameters for getTemplateParameters() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateID

The ID assigned to the template, for example: "Chart Layout".

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.14 getTemplateParameterInSession() Method

Use the getReportParametersInSession() method to get the parameters for a template.

See Section 2.3.41, "ParamNameValue."

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

ParamNameValue[] getTemplateParameters(String reportAbsolutePath, String templateID, String bipSessionToken);

Table 4-14 Parameters for getTemplateParameterInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report for which to retrieve the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateID

The ID assigned to the template, for example: "Chart Layout".

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.15 getXDOSchema() Method

Use getXDOSchema() method to retrieve the XDO schema for a report definition in the BI Publisher catalog.

Signature

byte[] getXDOSchema(String reportAbsolutePath, String locale, String userID, String password);

Table 4-15 Parameters for getXDOSchema() Method

Parameter Description

String reportAbsolutePath

The path to the report from which to retrieve the XDO schema. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String locale

The locale of the template to retrieve (for example, en_US).

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.16 getXDOSchemaInSession() Method

Use getXDOSchemaInSession() method to retrieve the XDO schema for a report definition in the BI Publisher catalog based on a bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

byte[] getXDOSchemaInSession(String reportAbsolutePath, String locale, String bipSessionToken);

Table 4-16 Parameters for getXDOSchemaInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report from which to retrieve the XDO schema. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String locale

The locale of the template to retrieve (for example, en_US).

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.17 removeTemplateForReport() Method

Use removeTemplateForReport() method to remove a template from a report definition in the BI Publisher catalog.

Signature

boolean removeTemplateForReport(String reportAbsolutePath, String templateFileName, String userID, String password);

Table 4-17 Parameters for removeTemplateForReport() Method

Parameter Description

String reportAbsolutePath

The path to the report from which to remove the template. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateFileName

The file name of the template to remove.

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.18 removeTemplateForReportInSession() Method

Use removeTemplateForReportInSession() method to remove a template from a report definition in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean removeTemplateForReportInSession(String reportAbsolutePath, String templateFileName, String bipSessionToken);

Table 4-18 Parameters for removeTemplateForReportInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report from which to remove the template. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateFileName

The file name of the template to remove.

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.19 runReport() Method

Use the runReport() method to send a request to the BI Publisher server to run a specific report.

See Section 2.3.46, "ReportRequest" and Section 2.3.47, "ReportResponse."

Signature

ReportResponse runReport(ReportRequest reportRequest, String userID, String password);

Table 4-19 Parameters for runReport() Method

Parameter Description

ReportRequest reportRequest

See Section 2.3.46, "ReportRequest."

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.20 runReportInSession() Method

Use the runReportInSession() method to send a request to the BI Publisher server to run a specific report based on the bipSessionToken of a given user.

See Section 2.3.46, "ReportRequest" and Section 2.3.47, "ReportResponse."

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

ReportResponse runReportInSession(ReportRequest reportRequest, String bipSessionToken);

Table 4-20 Parameters for runReportInSession() Method

Parameter Description

ReportRequest reportRequest

See Section 2.3.46, "ReportRequest."

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.21 updateReportDefinition() Method

Use the updateReportDefinition() to update attributes of the report definition file (.xdo) and write the file back to the BI Publisher catalog.

Signature

boolean updateReportDefinition(String reportAbsPath, ReportDefinition newReportDefn, String userID, String password);

Table 4-21 Parameters for updateReportDefinition() Method

Parameter Description

String reportAbsPath

The path to the report for which to update the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

ReportDefinition newReportDefn

See Section 2.3.45, "ReportDefinition."

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.22 updateReportDefinitionInSession() Method

Use the updateReportDefinitionInSession() to update attributes of the report definition file (.xdo) based on the bipTokenSession of a given user, and then to write the file back to the BI Publisher catalog.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean updateReportDefinitionInSession(String reportAbsPath, ReportDefinition newReportDefn, String bipSessionToken);

Table 4-22 Parameters for updateReportDefinitionInSession() Method

Parameter Description

String reportAbsPath

The path to the report for which to update the report definition. For example: /HR Manager/Employee Reports/Employee Listing.xdo

ReportDefinition newReportDefn

See Section 2.3.45, "ReportDefinition."

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.23 updateTemplateForReport() Method

Use updateTemplateForReport() method to update a template for a specific report in the BI Publisher catalog.

Signature

boolean updateTemplateForReport(String reportAbsolutePath, String templateName, String locale, byte[] templateData, String userID, String password);

Table 4-23 Parameters for updateTemplateForReport() Method

Parameter Description

String reportAbsolutePath

The path to the report that contains the template to update. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateName

The name of the template to update (for example, Chart Layout).

String locale

The locale of the template to update (for example, en_US).

byte[] templateData

The template file.

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.24 updateTemplateForReportInSession() Method

Use updateTemplateForReportInSession() method to update a template for a specific report in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean updateTemplateForReportInSession(String reportAbsolutePath, String templateName, String locale, byte[] templateData, String bipSessionToken);

Table 4-24 Parameters for updateTemplateForReportInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report that contains the template to update. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateName

The name of the template to update (for example, Chart Layout).

String locale

The locale of the template to update (for example, en_US).

byte[] templateData

The template file.

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.25 updateXLIFFForReport() Method

Use updateXLIFFForReport() method to update a translation file (XLIFF) associated with a layout definition in the BI Publisher catalog.

Signature

boolean updateXLIFFForReport(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String userID, String password);

Table 4-25 Parameters for updateXLIFFForReport() Method

Parameter Description

String reportAbsolutePath

The path to the report to that contains the XLIFF file to update. For example: /HR Manager/Employee Reports/Employee Listing.xdo

byte[] xliffData

The XLIFF fie to upload.

String layoutFileName

The file name of the layout for which the XLIFF file is to be updated. For example: employee_listing.rtf.

String locale

The locale to assign to the XLIFF (for example, en_US).

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.26 updateXLIFFForReportInSession() Method

Use updateXLIFFForReportInSession() method to update a translation file (XLIFF) associated with a layout definition in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean updateXLIFFForReportInSession(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String bipSessionToken);

Table 4-26 Parameters for updateXLIFFForReportInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report to that contains the XLIFF file to update. For example: /HR Manager/Employee Reports/Employee Listing.xdo

byte[] xliffData

The XLIFF fie to upload.

String layoutFileName

The file name of the layout for which the XLIFF file is to be updated. For example: employee_listing.rtf.

String locale

The locale to assign to the XLIFF (for example, en_US).

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.27 uploadReportDataChunk() Method

Use uploadReportDataChunk() method to upload a report data chunk.

Note:

When using uploadReportDataChunk() or downloadReportDataChunk() in a clustered environment, you must set the System Temporary Directory to be a shared directory accessible to all servers within the cluster. To set the System Temporary Directory:

  1. Sign in to BI Publisher with Administrator privileges.

  2. Click the Administration link.

  3. Under System Maintenance, click Server Configuration.

  4. Under General Properties in the System Temporary Directory property, enter the absolute path to a directory accessible to all servers in the cluster.

    For example, the directory can exist under ${xdo.server.config.dir}/temp but you must enter the absolute path, such as /net/subfoldera/scratch/subfolderb/11gcat/temp

Repeat this procedure for all servers in the cluster, entering the same value for System Temporary Directory.

Signature

uploadReportDataChunk(String fileID, byte[] reportDataChunk, String reportRawDataChunk, String userID, String password);

Table 4-27 Parameters for uploadReportDataChunk() Method

Parameter Description

String fileID

In the first call, you do not need to provide the fileID, after the successful uploading of the first chunk of XML data, it will return a fileID, for example: filename. On your subsequent calls, you can supply the same fileID to append the subsequent data chunks to the same file.

byte[] reportDataChunk

The XML data to upload.

String reportRawDataChunk

String representation of XML data, presenting as reportRawDataChunk. This is an alternative to reportDataChunk byte[].

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.28 uploadReportDataChunkInSession() Method

Use uploadReportDataChunkInSession() method to upload a report data chunk based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

uploadReportDataChunkInSession(String fileID, byte[] reportDataChunk, String reportRawDataChunk, String bipSessionToken);

Table 4-28 Parameters for uploadReportDataChunkInSession() Method

Parameter Description

byte[] reportDataChunk

The XML data to upload.

String reportRawDataChunk

String representation of XML data, presenting as reportRawDataChunk. This is an alternative to reportDataChunk byte[].

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.29 uploadTemplateForReport() Method

Use uploadTemplateForReport() method to upload a template to a report definition in the BI Publisher catalog.

Signature

boolean uploadTemplateForReport(String reportAbsolutePath, String templateName, String templateType, String locale, byte[] templateData, String userID, String password);

Table 4-29 Parameters for uploadTemplateForReport() Method

Parameter Description

String reportAbsolutePath

The path to the report to which to upload the template. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateName

The file name of the template to upload.

String templateType

The template type. Valid values are:

  • csv (CSV)

  • eText (eText template)

  • excel (Microsoft Excel)

  • excel2000 (Microsoft Excel 2000)

  • flash (Adobe Flash)

  • html (HTML)

  • mhtml (MIME HTML)

  • pdf (Adobe PDF)

  • pdfz (eBook)

  • ppt (Microsoft PowerPoint)

  • rtf (Rich Text Format)

  • text (Text)

  • txml (Transformed XML)

  • xml (XML)

  • xpa (Analyzer template)

  • xpt (BI Publisher template)

  • xslfo (XSL-FO style sheet)

String locale

The locale to assign to the template (for example, en_US).

byte[] templateData

The contents of the template file to upload.

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.30 uploadTemplateForReportInSession() Method

Use uploadTemplateForReportInSession() method to upload a template to a report definition in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean uploadTemplateForReportInSession(String reportAbsolutePath, String templateName, String templateType, String locale, byte[] templateData, String bipSessionToken);

Table 4-30 Parameters for uploadTemplateForReportInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report to which to upload the template. For example: /HR Manager/Employee Reports/Employee Listing.xdo

String templateFileName

The file name of the template to upload.

String templateName

The name of the template to upload.

String locale

The locale to assign to the template (for example, en_US).

byte[] templateData

The contents of the template file to upload.

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.


4.31 uploadXLIFFForReport() Method

Use uploadXLIFFForReport() method to upload a translation file (XLIFF) to a layout definition in the BI Publisher catalog.

Signature

boolean uploadXLIFFForReport(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String userID, String password);

Table 4-31 Parameters for uploadXLIFFForReport() Method

Parameter Description

String reportAbsolutePath

The path to the report to which to upload the XLIFF. For example: /HR Manager/Employee Reports/Employee Listing.xdo

byte[] xliffData

The XLIFF fie to upload.

String layoutFileName

The file name of the layout to which to associate the XLIFF file. For example: employee_listing.rtf.

String locale

The locale to assign to the XLIFF (for example, en_US).

String userID

Specifies the BI Publisher user name.

String password

Specifies the password for the user name.


4.32 uploadXLIFFForReportInSession() Method

Use uploadXLIFFForReport() method to upload a translation file (XLIFF) to a layout definition in the BI Publisher catalog based on the bipSessionToken of a given user.

For more information about in-session methods, see Section 1.3, "About In-Session Methods."

Signature

boolean uploadXLIFFForReportInSession(String reportAbsolutePath, byte[] xliffData, String layoutFileName, String locale, String bipSessionToken);

Table 4-32 Parameters for uploadXLIFFForReportInSession() Method

Parameter Description

String reportAbsolutePath

The path to the report to which to upload the XLIFF. For example: /HR Manager/Employee Reports/Employee Listing.xdo

byte[] xliffData

The XLIFF fie to upload.

String layoutFileName

The file name of the layout to which to associate the XLIFF file. For example: employee_listing.rtf.

String locale

The locale to assign to the XLIFF (for example, en_US).

String bipSessionToken

The proprietary token string generated for the user by the BI Publisher server. With the bipSessionToken string, the user no longer needs to provide user credentials. The BI Publisher server can validate this token string and restore the BI Publisher server session to perform needed operation.