getTemplate Method getTemplateInSession Method

4-8 Developers Guide for Oracle Business Intelligence Publisher

4.13 getTemplateParameters Method

Use the getReportParameters method to get the parameters for a template. See Section 2.3.41, ParamNameValue. Signature ParamNameValue[] getTemplateParametersString reportAbsolutePath, String templateID, String userID, String password;

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.2, About In-Session Methods. Signature ParamNameValue[] getTemplateParametersString reportAbsolutePath, String templateID, 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–13 Parameters for getTemplateParameters Method Parameter Description String reportAbsolutePath The path to the report for which to retrieve the report definition. For example: HR ManagerEmployee ReportsEmployee 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. 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 ManagerEmployee ReportsEmployee Listing.xdo String templateID The ID assigned to the template, for example: Chart Layout. Table 4–12 Cont. Parameters for getTemplateInSession Method Parameter Description 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