ReportService 4-9
4.15 getXDOSchema Method
Use getXDOSchema method to retrieve the XDO schema for a report definition in the BI Publisher catalog.
Signature byte[] getXDOSchemaString reportAbsolutePath, String locale, String userID, String
password;
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.2, About In-Session
Methods.
Signature byte[] getXDOSchemaInSessionString reportAbsolutePath, String locale, String
bipSessionToken; 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–15 Parameters for getXDOSchema Method
Parameter Description
String reportAbsolutePath The path to the report from which to retrieve the XDO
schema. For example: HR ManagerEmployee ReportsEmployee 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.
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 ManagerEmployee ReportsEmployee 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.
Table 4–14 Cont. Parameters for getTemplateParameterInSession Method
Parameter Description
4-10 Developers Guide for Oracle Business Intelligence Publisher
4.17 removeTemplateForReport Method
Use removeTemplateForReport method to remove a template from a report definition in the BI Publisher catalog.
Signature boolean removeTemplateForReportString reportAbsolutePath, String
templateFileName, String userID, String password;
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.2, About In-Session
Methods.
Signature boolean removeTemplateForReportInSessionString reportAbsolutePath, String
templateFileName, String bipSessionToken;
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 runReportReportRequest reportRequest, 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 ManagerEmployee ReportsEmployee 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.
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 ManagerEmployee ReportsEmployee 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.