Customizing Reports

Planning includes templates that control the layout and content of PDF reports of data forms, data form definitions, task lists, and planning units. You can use the templates as is. You can also customize the templates to add company logos, and special formatting for features such as shading, page size, orientation, font, font size, headers, percentage of page used for headers, number of data columns per page, and precision.

To customize reports, you must install and configure Microsoft Office Word 2000 or later and Oracle Business Intelligence Publisher Desktop. You can then use Word's BI Publisher menu to update information in the report using a sample .XML file. You can also use Word features to customize formatting. You make the template available by saving the .RTF file with the appropriate name, and placing it in the classpath or in the HspJS.jar file.

You can customize four report types, using the corresponding sample and template files. For information on creating the reports, see the related topics.

Report TypeSample File NameTemplate NameRelated Topics

Data Form

PlanningFormSample.xml

PlanningFormTemplate.rtf

See Creating Simple Data Forms.

Data Form Definition

PlanningFormDefSample.xml

PlanningFormDefTemplate.rtf

See Printing Data Form Definitions.

Task List

PlanningTaskListSample.xml

PlanningTaskListTemplate.rtf

See the Oracle Hyperion Planning User's Online Help.

Planning Unit Annotations

PlanningPUAnnotationSample.xml

PlanningPUAnnotationTemplate.rtf

See Printing Planning Unit Annotations.

This topic gives general customization instructions. For detailed procedures, see the documentation installed with Word and BI Publisher. The BI Publisher install guide and user's guide are also available here:

http://download.oracle.com/docs/cd/E10091_01/welcome.html

  To install BI Publisher Desktop:

  1. Download the most recent version of BI Publisher Desktop from this location:

    http://www.oracle.com/technology/software/products/publishing/index.html

    To customize reports, you only need to install BI Publisher Desktop. BI Publisher is not required.

  2. Save the zip file to your drive, and extract it with Use Folder Names selected.

  3. Close all Microsoft Office applications.

  4. Navigate to the directory where you extracted the zip file, and double-click the setup.exe application.

  5. Follow the instructions in the BI Publisher installation wizard to perform a basic installation, accepting the default settings.

  To customize reports:

  1. Open the Planning HspJS.jar file, installed by default in WEB-INF/lib, and extract the sample file and corresponding template file.

    For example, to customize the task list report, extract these files: PlanningTaskListSample.xml and PlanningTaskListTemplate.rtf.

  2. Save the sample and template files to a location where you can open them later.

  3. In Microsoft Word, open the .RTF template file for the report to customize.

    For example, for task list reports, open the PlanningTaskListTemplate.rtf template file.

  4. From Microsoft Word's Oracle BI Publisher menu, select Data, then Load Sample XML Data, and open the sample file for the report.

    For example, for task list reports, open the PlanningTaskListSample.xml sample file.

    If Word does not display the BI Publisher menu, select the Template Builder toolbar. (For example, select View, then Toolbars, and then Template Builder. See the Oracle Business Intelligence Publisher User's Guide.

  5. Use the Word menus to customize the template.

    For example, you can insert graphics and update fonts. For assistance with these tasks, see the Word documentation.

  6. Optional: To update fields in the report, use Word's BI Publisher menus to add fields from the sample file.

    For example, select Oracle BI Publisher, then Insert, and then Field, click a field in the Field dialog box, and drag the field into the template.

    For assistance with these tasks, see the BI Publisher documentation. (In Word, select Oracle BI Publisher, then Help. In Oracle Business Intelligence Publisher, click Help to view online help.)

  7. When you finish customizing, select Oracle BI Publisher, then Preview Template, and select a format for previewing your changes. You can preview in any format. Click the close box to close the preview file.

  8. In the template file, select Save As, and save the template as an .RTF file with the appropriate file name from the table.

    For example, if you are customizing task list reports, save the file as PlanningTaskListTemplate_Custom.rtf.

    Type of Template

    File Name

    All data forms

    PlanningFormTemplate_Custom.rtf

    Specific data form

    PlanningFormTemplate_Data_Form_Name

    For example, to apply the template to a data form called Income, save the template as PlanningFormTemplate_Income.rtf.

    Data form definition

    PlanningFormDefTemplate_Custom.rtf

    Task list status reports

    PlanningTaskListTemplate_Custom.rtf

    Planning unit annotation reports

    PlanningPUAnnotationTemplate_Custom.rtf

    You must save the template file in a location on the classpath so it is available to the Web application server. Insert the template file in the HspJS.jar file at the root level (the same level as the template files).

  9. Restart the application server to make the custom template available when users create PDF reports in Planning.