Creating RTF Templates by Using BI Publisher 11g Template Builder for Word

<Do not delete this text because it is a placeholder for the generated list of "main" topics when run in a browser>

Purpose

This tutorial covers how to use Oracle Business Intelligence Publisher Template Builder for MS Word to create RTF templates.

You will learn how to:

Time to Complete

Approximately 2 hours.

Overview

Template Builder is an extension to MS Word (2003 or later) that simplifies RTF template creation for Oracle BI Publisher reports.

Rich Text Format (RTF) is a specification used by common word processing applications, such as MS Word. Template Builder provides easy-to-use wizards for inserting fields, tables, forms, charts, and cross-tabs. Also, Template Builder provides translation features and enables you to preview reports by using the template in supported formats.

This tutorial provides step-by-step procedures to use Template Builder to create RTF templates for Oracle BI Publisher reports. The examples will cover complex formatting and processing of reports by using these RTF templates. You will also learn how to work in both Online and Offline modes. Translating the RTF templates is covered in detail in the other tutorial -: Exploring Advanced Features of BI Publisher 11g, and also in the Instructor Led Training (ILT) for BI Publisher 11g.

Prerequisites

To complete this tutorial, you should:

The assumption throughout this course is that you are familiar with the basic user interface and navigation of the Oracle BI Publisher.

Software Requirements

The following is a list of software requirements:

Installing Template Builder and Exploring the Template Builder User Interface

In this topic, you will see how to download the Template Builder add-in, and install it. Then you will explore the the Template Builder user interface.

Installing Template Builder

Template Builder can be downloaded from the Get Started region of the Oracle BI Publisher Home page or Oracle BIEE Home page. In this topic, you will download the Template Builder add-in and install it.

Perform the following steps to download and install Template Builder:

.

Log in to Oracle BI Publisher.

 

.

In the Get Started section of the Home page, click the Download BI Publisher Tools menu, and select Template Builder for Word.

.

The Opening BIPublisherDesktop.exe dialog box opens. Click Save File. Save the file to a suitable location on your hard drive.


.

Navigate to the location where you have downloaded the BIPublisherDesktop.exe file and double-click the executable file to begin the installation.

 

.

a. After the Install Shield wizard starts, follow the on-screen instructions to complete the installation.

b. Click Finish.



.

If Template Builder is installed correctly, you will see the BI Publisher ribbon in Word 2007:

.

Note: If you are using Microsoft Word 2007 you may need to modify your Add-In settings: To do so, click the Office button, click Word Options, and then click Add-Ins.

 

Exploring the Template Builder User Interface

In this topic, you will review Template Builder UI components. You will open the existing Balanceletter.rtf file.

(This file is made available to you in the My Templates and Files zip file, as well as in Sample after you install the Template Builder.)

.

The BI Publisher ribbon has the following options:

  • Online

    You can log in to BI Publisher from here. After you log in, you can use the Open button to open a report from the BI Publisher catalog.

  • Load Data

    This group of commands enables you to load a saved sample data file or sample schema to Template Builder. You must load data to use most of the Template Builder functionality. The Sample XML button allows you to load a sample XML file that contains all the fields that you want to insert into your template as a data source. If you are not connected to the BI Publisher server, use this method to load your data.

  • Insert

    This group enables you to insert the following elements into your RTF template.

    • Table Wizard: This function provides a wizard that guides you through the creation of tables used in typical reports.

    • Pivot Table: Using this you can drag and drop data elements into a pivot table.

    • Chart: BI Publisher does not recognize native Microsoft Word charts. The Insert Chart function allows you to insert a chart that is understood by Oracle BI Publisher.

    • ab|Field: This function allows you to select fields from your data source and insert them into your template

    • Table/Form: Use this function to insert data fields to be organized as a simple or nested table or as a form that is repeated with different data. You may even organize all the data fields for the whole document before inserting them.

    • Repeating Group: Use this to select or define a group of elements to be repeated for each occurrence of an element in the data.

    • Conditional Format: This enables you to define simple conditional formats to apply to table rows or cells.

    • Conditional Region: This enables you to insert a conditional statement around a region of the template. A conditional region is an area that is surrounded by a conditional statement. If the statement tests true, the area is displayed in the report; if the condition tests false, the area is suppressed from the report.

    • All Fields: This function inserts all fields found in the XML data into your document. It will also insert processing instructions into your document that will repeat a section, such as a table row when the associated XML element is repeated. When you are working on a deeply nested hierarchy of elements, it is better to insert elements separately, instead of inserting all fields.

  • Preview

    This enables you to preview your RTF template with sample XML data. The preview menu offers you PDF, HTML, RTF, Power Point, Excel (MHTML format), and EXCEL2000 as output formats. When you select any of these output formats, Template Builder will merge the data into your template and create the output document.

  • Tools

    This group has the following advanced editing tools for the templates:
    • Field Browser: This is for advanced users to review and edit BI Publisher commands inserted in the form fields. It shows the commands behind each form field and allows you to edit them. Use this tool to correct flawed RTF templates or to update multiple fields efficiently.
    • Validate Template: The validation function checks the template for incorrect use of BI Publisher commands and unsupported elements in the Word file.
    • Check Accessibility : Run this tool to check for the accessibility features in the template.
    • Translation:
      Extract Text: This command enables you to create a standard XLIFF translation file containing the boilerplate text from your template. XLIFF is a standard file format that is understood by many translation software packages. Because an XLIFF is an XML file, you can translate the text in a text editor.
      Preview Translation: This command enables you to preview your template as a PDF file using a specified XLIFF translation file. This functionality enables you to test translation files.
      Localize Template: This command applies a translation file to an RTF template. This means that in your current RTF template all boilerplate text is translated. The main function of this feature is to create a language-specific version of a template.
    • Export
      XSL-FO Stylesheet:
      This function allows you convert the RTF template into an enhanced XSL-FO stylesheet. This function can be used to generate XSL-FO for debugging or further customization.
      FO Formatted XML: This function allows you to apply the XSL-FO style sheet generated from the Word document to the sample data and save the intermediate FO format. This function is mainly for debugging.
      PDF This function converts the Word document to PDF.

  • Options

    This group allows you to change the following options that influence the look and feel of Template Builder:
    • Display Mode
    • Preview
    • Build

You will use all these functions in the coming sections.

 

Building an RTF Template in Offline Mode

Rich Text Format (RTF) is a specification used by common word processing applications, such as Microsoft Word. When you save a template in Template Builder, the file type should be RTF. You can build and upload your template via a direct connection with the BI Publisher Server, called Online mode, or you can build and upload your template in a disconnected mode, and is called Offline mode.

Note: To work in disconnected mode, you must have a sample data file available in your local work environment. In this example, the sample data file is Balance.XML.

.

a. Select Start >Programs >Oracle BIP Desktop >Samples >RTF Templates.

b. Open the Balance Letter folder and load the file Balance Letter Start.rtf. This is a sample template file.

.

The RTF template file opens in MS Word.

.

To build a report and view the report with data, you must load sample XML data. When working in disconnected or Offline mode, you must have sample data stored locally.

a. Click Sample XML in the Load Data group.

b. Select the Balance.xml sample data file located under your local drive(C):\Program Files\Oracle\BI Publisher\BI Publisher Desktop\samples\RTF templates\Balance Letter. Click Open.

You will see a confirmation message that the data is loaded successfully.

.

a. Now insert the various fields in the Balance Letter by replacing the placeholders. Select the <INSERT ADDRESS HERE> placeholder, and click ab | Field, in the Insert group.

b. In the Field dialog box, select the Customer Name field and click Insert.

.

The Customer_Name field appears in the Balance Letter. Click the space following the CUSTOMER_NAME field and press Enter. This adds a line break.

.

Repeat this process, adding Address Line1. Also, add City, State, and Zip, each of them separated by a comma and space. The letter should look like this:

.

a. Insert the following fields into the letter, in the appropriate placeholders:

  • As_Of_Date
  • Trx Currency Code
  • C Inv Open Balance.

Note that you may have to scroll in the Field dialog box to locate these fields.

b. Close the Field Dialog box.

.

Include the table of invoices by using the Table Wizard. The Table Wizard allows you to add tables, forms, charts, and other objects.

a. Select the <INSERT TABLE OF INVOICE HERE> placeholder in the form letter. Click Table Wizard in the Insert group.



The Table Wizard opens.

b. Accept the default (Table) and click Next.

.

The Table Wizard intuitively selects the correct data set for you. In this example, it is /ARXCOBLX/G_CUSTOMER/G_CURRENCY/G_INVOICES. Accept the default and click Next.

You can change this, however, by clicking the drop-down list.

.

a. Select the following columns:

  • Trx Number
  • Transaction Date
  • Trans Amount
  • Trans Amount (Second "Trans Amount" is Trans Amount Remaining)

Use the shuttle icons to move items to the selected column one at a time or use the double-headed shuttle icons to move all columns at once.

Use the resequence icons to move the columns up and down.

b. Click Next.

.

You can group your data. You use the Break option to insert either a page break or section break after each occurrence of a group. In this example you will not select any options. Click Next.

 

.

a. Select a sort sequence and indicate the type of data that is being sorted. Select Transaction Date, indicate that this field is a number, and sort the column in descending order.

b. Click Finish.

.

The table opens in the template. Observe the codes F (for "Grouping") and E (for "Each") in the table.

.

Preview this template in PDF format. In the Preview group, click PDF.

The report is displayed with the XML file data that you loaded earlier.

.

You can view the Word properties of any table field that you have added to your template. Double-click TRANS_AMOUNT in the table.

The BI Publisher Properties dialog box is displayed.

Click the Word Properties button to edit the inserted fields.

.

a. In the Text Form Field Options dialog box, select Number from the Type drop-down list.

b. Set the default number and number format. Enter $1,000.00 in the Default number text box and select $#,##0.00 from the Number format drop-down list.

c. Click OK. The template is displayed with the applied formatting.

d. Right-justify this Trans Amount field by using MS Word Paragraph menu.

.

You can format the other fields as per your requirement. However, because the date is a text field in this example, you will not be able to format it.

You can also format the column names of the table to a meaningful display using the MS Word menu. Change the column names as given below and then keep the formatting as Bold.

  • Trx Number to Invoice Number
  • Transaction Date to Date
  • Trans Amount to Transaction Amount
  • Trans Amount Remaining to Transaction Amount Remaining

.

Save the template as My Balance Letter in the Learn folder on your local drive.

.

When you preview this template, the report is displayed with the applied formatting.

.

Close the preview and the template file.

.

Log in to BI Publisher Enterprise Edition.

.

On the Catalog page, navigate to the Balance Letter report and click Edit.
This Balance Letter report is part of the Samples files.

.

The Report Editor opens. Click Add New Layout.

.

Click Upload.

.

a. Enter Balance Letter as the layout name.

b. Click Browse. Navigate to and select My Balance Letter.rtf from the Learn folder, and click Open.

c. Select RTF Template as the type and English (United States) as the locale.

.

d. Click Upload.

.

The uploaded layout is displayed in the layout editor. Click Save.

.

Click View Report.

In the displayed report, click the Balance Report tab. The report based on the template that you have designed in Template Builder is displayed.

This concludes the topic on creating a RTF template using Template Builder in Offline mode.

Building an RTF Template in Online Mode

This topic demonstrates how to design an RTF template while logged into BI Publisher.
You will log in to BI Publisher through Template Builder, define an RTF template, add a table with a running total, add grouping and sorting, add a page break, add a chart, preview data in the report by using the template, upload the RTF template to BI Publisher Enterprise Server, and view the report on BI Publisher Enterprise Server.

 

.

a. Open a new blank word document.

b. Log in to BI Publisher by clicking Log On in the Online group.

c. Enter the Report Server URL as the BI Publisher Server installed on your machine. For example, http://<host>:<port>/xmlpserver

d. Click Login.

.

The Open Template dialog box opens. Select the Salary Reports – No Parameters report. (Navigate to \Shared Folders\Sample Lite\Published Reporting\Reports\)

.

When the report opens, you will not see any data in the blank MS Word document. However, XML data definitions are loaded from the report to facilitate the definition of a template. Notice that the report name appears in the title bar of MS Word beside the document name.

.

Now start building the template.

Insert a word table with two rows. Insert the chart in the first row, followed by the table in the second.

.

Now you will add a chart for this template. Position your cursor in the first row of the word table. In the Insert group, click Chart.

.

The Chart window opens. Select Row in the Data pane.

.

a. Drag Annual Salary to Values in the Layout pane.
b. Drag Department Name to the Labels text box.

 

.

In the Layout pane, select the following information:

Step

Attribute

Values

a.

Type

Bar Graph - Vertical

b.

Style

Earth

c.

Aggregation

Average

f.

Title:Title

Average Annual Salary by Department

The Chart wizard should look like this:

Click OK.

.

The chart appears in the template.

.

Now use the Table wizard to insert the table in your template. You did this in the previous topic, but in Offline mode. Take your curser to the next row of the MS Word table, and then insert the table.

a. Select Department Name,Manager, Name, Job Title, Annual Salary, and Fed Withheld (in that order). Your selections should be listed in the right pane of the wizard page.

b. Click Next.

.

In the How would you like to group your report? section, select the following options:

  • Group By - Department Name
  • Group Above
  • Break - Section
  • Then By - Manager
  • Group - Left

Recall that while working on the table in the Offline mode, you did not choose options for grouping. This example uses section breaks in the report with Department Name as the group and has a second grouping by Managers.

Click Next.

.

Sort by Annual Salary in the Which fields would you like to use to sort the data? section. Click Finish.

.

This table appears in the document, below the chart. Right-justify the cell for ANNUAL_SALARY.

.

Save the file as Manager Financials Report.rtf in your Learn folder.

.

Select the PDF preview option from the Preview group. The PDF is displayed. Observe that because you used the “Group above” option while inserting the table, a department name appears above each table.

.

Close the PDF.

.

Now, upload the template to the BI Publisher Server.

Click Upload Template As in the Online group.

.

Upload as new dialog box opens. Enter Manager Financials Report as the Template Name.

.

A confirmation message is displayed. Click OK.

.

Navigate to the Salary Report - No Parameters report in the BI Publisher Enterprise Server and click Edit.

.

The uploaded layout is displayed in the layout editor. Save and then click View Report.

.

In the displayed report, click the Manager Financials Report tab. The report based on the template you have designed in Template Builder is displayed.

This concludes "Building an RTF Template in Online Mode" topic.

Working with a Pivot Table in an Existing RTF Template

This topic covers adding a pivot table to an existing RTF template. You will open an existing RTF template to preview a chart, and add a pivot table to the template. The RTF template Retail Sales.rtf is stored in the My Templates and Files zip file.

.

Open the Retail Sales.rtf file in MS Word. The file looks like this:

.

In the BI Publisher ribbon, click Sample XML in the Load Data group.

.

Navigate to and select RetailSales.xml (located in the same folder as the Retail Sales RTF template), and click Open. This file contains retail sales data from different industries.

.

Click OK in the message dialog box. The data is loaded.

.

Click Enter twice to enter a line break after the PIE Chart.

.

Click Pivot Table in the Insert group. The Pivot Table dialog box opens.

You drag data columns from the Data pane to the blank Layout pane to build a pivot table.

.

a. Drag Year to Column

b. Drag Month to Column

c. Drag Industry to Row

d. Drag Sales to the Please drop data here area.

.

a. Select Sales in the row.

b. Select the cell to the right of Format in the Properties pane to select SUM.

c. Select #,##0 in the properties drop-down list.

d. Click OK.

.

The pivot table appears in the template.

.

Save the template, and then click PDF in the Preview group to view your pivot table.

This concludes the "Working with a Pivot Table in an Existing RTF Template" topic.

Using Template Builder Utilities: Field Browser, Validate Template, and Check Accessibility

This topic will demonstrate how to use the Field Browser, Check Accessibility, and Validate Template utilities available in Template Builder.
You will use the Retail Sales.rtf file, which is made available to you at My Templates and Files zip file.

Using Validate Template

.

a. Open the RTF file Retail Sales.rtf.

b. In the BI Publisher tab, in the Tools group, click Validate Template.

 

.

If there are no validation errors, No Error found is returned.



If an error is found, the error will be displayed.

Note: You can also use Field Browser to help locate the error.

 

Using Field Browser

The Field Browser utility provides a fast way to review and update the BI Publisher instructions hidden in the Microsoft Word form fields. This is particularly useful for understanding and modifying existing templates.

.

In the BI Publisher tab, in the Tools group, click Field Browser to open the Field Browser dialog box.

.

The Field Browser dialog box shows the default text of the form field in the Text column, and the instructions (from the help and status text of the form field) in the Code column.



Note:

  • When you select a specific row in the dialog box, the matching form field will be selected in the Microsoft Word document.
  • If you select some part of the text before opening the Field Browser, the dialog shows only the fields in your selection. If no text is selected, Field Browser will show all fields in the document. This screenshot shows all the fields, because no specific form field was selected before opening Field Browser.

.

You can update processing instructions directly from the Field Browser dialog box.

a. Select INDUSTRY in the Text column..

The Edit field shows the processing instructions.

b. Change all but the first of the capital letters of the word INDUSTRY to lowercase. In other words, change INDUSTRY to Industry.

c. Select Update.

Observe that the code is changed as per your edit.

Note: Recall from the previous topic that you can use Field Browser to find out validation errors in the template. Use the Find option in the Field Browser to search for the errors.

 

Using Check Accessibility

Template Builder provides an accessibility checker to check the template for features to enhance the accessibility of the report for report consumers who may need assisting technologies to view the report. For more information about developing accessible reports, see "Designing Accessible Reports" in the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

.

In the BI Publisher tab, in the Tools group, click Check Accessibility.

.

The tool generates a report indicating areas of your template that do not include the accessibility features.



This template does not have accessibility compatibility for a row header of a table.

For more information about developing accessible reports, see Designing Accessible Reports" in the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

Setting Configuration Options for Template Builder

In this topic, you will see how to set the various UI options and configuration options for Template Builder. The important settings covered are:

Setting UI Options

 

The tree view showing the data source can show either the correct XML tag names of the data source or a slightly modified version that is easier to read.

Select the Element Names for Reports XML option to show the modified labels. These labels contain no <> characters, use title case capitalization and use spaces instead of underscores.

Setting Preview Options

 

The Preview tab allows you to specify options that influence the Preview functionality of Template Builder.

The various options that you can set using this dialog are:

  • Style Template
  • Locale
  • Java Home
  • Java Option

Style Template

If you have a BI Publisher style template available locally you can specify it here. The style information in the style template is applied to RTF layouts at runtime to achieve a consistent look and feel for your enterprise reports. In this example no style template is defined.

For more information, see "Creating and Implementing Style Templates" in the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

Locale

You can choose the language and territory used for previewing your template. While this change will not automatically translate any files, it is important to set the correct locale for the preview to use the correct direction of the text (left-to-right or right-to-left), and to correctly set locale-specific date, number, and currency formats. In this example the Locale is set to English - United States [en-US]

Java Home

The Preview (and export functionality) requires Java code. You can change the path to your JAVA HOME directory. If this option is not specified, Template Builder assumes that the Java virtual machine (java.exe) is accessible in the PATH specified in your environment variables of Windows. In this example it is set as C:\Program Files\Java\jre6

Java Option

Specify the memory to reserve for Template Builder to process the template. The default value is -Xmx256M. The example shows the same.

Setting Build Options

Use the Build tab to specify options that influence how Template Builder generates tables and forms.

The various Build options that you can set here are:

  • For-each form field
  • Form field size
  • Table Header Color

For-each form field

Use this to choose how the Template Builder creates the form fields for processing instructions in the Insert Table/Form dialog box. The Descriptive option (for example: for-each Invoice) renders a descriptive form field for the processing instructions. This option makes the layout template easier to understand. However, the longer fields may distract from the visual layout of the template. The Abbreviated option (for example: F) provides a one letter abbreviation for each instruction.

Select the Hidden option to generate the processing instruction form fields using Microsoft Word's hidden font effect. Hidden text is hidden in the print preview. You can display or hide the hidden text by selecting or deselecting the “Hidden text” option in the Display options of Microsoft Word Options.

Form field size

The Large option inserts the BI Publisher code in a document variable. The document variable field can accommodate approximately 48 kilobytes of code line.

Note that this setting affects only fields that are created or edited while this option is set.

Table Header Color

When you insert a table by using the Table Wizard or the Insert Table/Form dialog box, the Template Builder applies the table header color specified here to the table header background. Use this feature to customize the default color for your templates.

Generate XSLT 2.0 compliant code

BI Publisher uses the XSLT processor provided by Oracle XDK 11.1.0.7.0, which supports the W3C XSL Transformations 1.0 recommendation. The processor also implements the current working drafts of the XSLT and XPath 2.0 standards. For more information about Oracle XDK see Oracle XML Developer's Kit Programmer's Guide 11g.

By default, BI Publisher is compatible with XSLT 1.0. If you wish to use XSLT and XPath 2.0 features in your template enable this option. This configuration is performed at the template level. The template-level setting will override the server setting.

This concludes the "Setting Configuration Options for Template Builder" topic.

 

Summary

In this tutorial, you have learned how to:

Install Template Builder successfully
Create an RTF template in the Offline mode
Create an RTF template in the Online mode
Create a chart and a pivot table in an existing template
Configure Template Builder settings

Resources

Credits

Copyright © 2011, Oracle and/or its affiliates. All rights reserved