removeTemplateForReport Method removeTemplateForReportInSession Method runReport Method

ReportService 4-11

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.2, About In-Session Methods. Signature ReportResponse runReportInSessionReportRequest reportRequest, String bipSessionToken;

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 updateReportDefinitionString reportAbsPath, ReportDefinition newReportDefn, 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. 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. 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 ManagerEmployee ReportsEmployee 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-12 Developers Guide for Oracle Business Intelligence Publisher

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.2, About In-Session Methods. Signature boolean updateReportDefinitionInSessionString reportAbsPath, ReportDefinition newReportDefn, String bipSessionToken;

4.23 updateTemplateForReport Method

Use updateTemplateForReport method to update a template for a specific report in the BI Publisher catalog. Signature boolean updateTemplateForReportString reportAbsolutePath, String templateName, String locale, byte[] templateData, String userID, String password;

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. 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 ManagerEmployee ReportsEmployee 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. 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 ManagerEmployee ReportsEmployee 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.