Logo: Wesleyan University
  • Tools
    • WesPortal
    • Directory
    • Library
    • OneStop
    • WesConnect
    • Calendar
    • WesMaps
    • WFS
    • Moodle
    • EMS
    • GApps
  • About
  • Admission & Financial Aid
  • Academics
  • Campus
  • Athletics
  • Give
  • Students
  • Alumni
  • Parents

Student Faculty Information System

PeopleSoft Campus Solutions

Feed on
Posts
Comments

BIP Templates

_hard hat

Outline:

  • BI Publisher Template Builder
  • Getting Started with Templates
    • Tutorials
    • Microsoft Word
  • BI Template and MS Word/Add-Ins Menu
  • Template Menu Detail
    • Data
    • Insert
    • Preview
    • Tools
    • Help
  • Template Documentation
    • Wesleyan documents – including an explanation of how to use real data to aid you in designing a BI Publisher Word Template (not as a Data Source), and demonstrations of setting up and formatting template tables.
    • Oracle documents – including an online designer’s guide, links to recorded clips on formatting, and a white paper on sub-templates.
    • HEUG Links – outside references about BI Publisher and templates, including webinars and Alliance presentations.
  • Comparison of Real Data and Sample Data
  • BIP / XMLP Templates – Some Terminology

BIP Template Detailed Pages:

  • BIP – Fields, Tables and Forms
  • BIP – Formatting
  • BIP – Pivot Table and Chart

Go to top

BI Publisher Template Builder

  • BI Publisher enables you to design and create report BI Templates with the more common desktop applications of Microsoft Word (and Adobe Acrobat), and renders data based on those templates.
    • With a single template, it can generate reports in many formats. This approach to reporting can dramatically reduce report maintenance, enabling power users to adjust report templates without involvement of IT resources.
    • The Template Builder is an extension to Microsoft Word, similar to an add-on, that simplifies the development of RTF templates.  RTF or Rich Text Format is a specification used by common word processing applications, such as MS Word.
    • Template Builder provides easy-to-use wizards (and other tools) for inserting fields, tables, forms, charts, and cross-tabs. Also, Template Builder  enables you to preview reports by using the template in supported formats.   It automates many of the manual steps that would otherwise be required.
    • Once the extension (BI Publisher Design Helper) has been installed on your computer, you will see a new tool bar within the Add-Ins menu in MS Word.
  • In addition to the references to BIP Templates available on the BI Publisher / XMLP page, you will find on this and succeeding pages more focused information on creating RTF documents.
    • In addition to the Word Add-In, also installed on your hard drive will be a Help file and sample data files.
  • We currently use Oracle BI Publisher Template Builder for Word Version 10.1.3.4.1 which Desktop Support can install on your computer using the BI Publisher Design Helper.

Go to top

Getting Started with Templates:

  • Before delving too deeply into this information, be sure you’ve reviewed the basic steps for running a simple report through the BIP process.  Once your BI Publisher Design Helper is installed, you can step through the instructions in these documents to see how the basic concepts work:

    • Tutorials:
      • There is a Tutorial (based on the SFIS database) that does not require the creation of a Query or Data Source that might be helpful:  Lesson T1 – BI Publisher Template Tutorial.  With extensive screenshots, this presentation steps you through each stage of the process for creating, editing and publishing a simple BI Publisher report.
      • If you would like to follow the phases starting with Query and Data Source, there are other Tutorials available on the BI Publisher / XMLP page .
      • BI Publisher Template Builder for Word Tutorial – Annotated – This is an annotated version of an Oracle “quick tutorial” document.  The annotations are added to clarify some of the points and to bring the instructions into line with the version of BI Publisher installed at Wesleyan.
      • You can also take a look at the PowerPoint BI Publisher Outline of Steps for Report Developer Role.  Included are some tips on what to think about when creating a query to be used with BI Pubisher.
    • Microsoft Word:  Since the BI Publisher Template Builder uses the formatting features available in MS Word, it is important that you have some proficiency in MS Word overall as well as in formatting and merging.

      • There are various lessons available on Lynda.com that teach about working with MS Word, ranging from Beginner to Intermediate.  You can get the information about accessing Lynda.com on this Information Technology Services page.  When you search on the Lynda.com page you’ll see a variety of courses and videos for working with Word.

Go to top

 BIP Template and MS Word

Begin by opening Microsoft Word.  You can either create a new Word document, or you can open an existing template (or an existing Word doc) to serve as the basis for your new template.  If you use an existing template, be sure to give the new template a different name.

BIP Template Add-Ins Menu

You begin working with the Template Builder by clicking on Add-Ins which is over to the right in the Word Menu.  When you do so, the Add-Ins menu appears as follows.  The sub-menus you will be working with are found in the section circled here in the Custom Toolbars section.  See further details below.

BIP Template Add Ins circled
Go to top

Template Menu Detail

Below is information on some of the sub-menus found in the Add-Ins Menu:

  • Data  BIP Word menus load XML

    • Load XML Data:
      • When creating a template in Word, you first load the XML data file that contains the data fields you may want to make available for use in your RTF template.  You will load the data source each time you open the file.
    • Load XML Schema (not required)

 

  • InsertBIP Word Insert Fields

    • Fields, Tables and Forms

      • Field – This function allows you to select single fields from your data source and insert them into your template.  You can either place the cursor in the Word document where you want a field positioned, or you can just drag the field from the dialog and drop it into the Word document.  When you are first learning, you should use Insert Fields only for data fields that are unique (not repeating) in your document.
      • Table/Form – This is a function that generates a table for you.  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.
      • Table Wizard – This function provides a wizard that guides you through the creation of tables used in typical reports.
    • Pivot Table and Chart
      • Pivot Table – Using this you can drag and drop data elements into a pivot table.  A Pivot Table is a tool that allows you to reorganize and summarize selected columns and rows of data to obtain a desired report.
      • 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.
    • Formatting
      • 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.

  • Preview

    After adding fields to the document, you should test your template.  Oracle BI Publisher Template allows you to preview your template with your sample XML data.  For example, you can preview the output in Adobe Acrobat Reader (PDF), Microsoft Word file (RTF, Microsfot Excel, or a browser (HTML).

    NOTE:  When you select any of the choices to Preview the document for the first time, you’ll receive a popup box that says “This function requires the document to be in Rich Text formant (.rtf).  If you click OK, you will be prompted to save the document as RTF file before BI Publisher continues.”  Once you have saved the document as an RTF file, you can preview whenever you wish.

You’ll see that there is a Preview > RTF.  It seems somewhat confusing, but you will run the Preview to PDF, and you will build the Template in RTF.

  • BIP template menu PREVIEWMenu Items
    • PDF
    • HTML
    • EXCEL
    • EXCEL 2000
    • RTF
    • PowerPoint

 

 

 

  • Tools  BI Template menu TOOLS

    • 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.
    • Translate Template
    • Export
    • Options – This group allows you to change the following options that influence the look and feel of Template Builder:
      • Display Mode
      • Preview
      • Build

 

  • Help  BI Template Menu HELP ABOUT

    • Help – Click to view the Word Help pages for Template Builder.  These were loaded onto your hard drive when Design Helper was installed.  Here is a sample of the first page of Help.
    • About – Click to view information about the version, etc. of BI Publisher Template on your computer. 

 

 

Go to top

TEMPLATE DOCUMENTATION

 

  • Wesleyan documents

    • FAQs about Using Real Data When Designing and Previewing Your BI Publisher Word Template
    • INSERT TABLE/FORM – Setting Up and Formatting – a basic demonstration of how to make formatting changes in a template table

  • Oracle documents

    • Oracle Business Intelligence Publisher Report Designer’s Guide (online)
    • Oracle Business Intelligence Publisher Report User’s Guide (online)
    • XMLP Templates by Example (Tim Dexter)
    • XML Publisher – Beyond the Basics (Tim Burns, io Consulting, Inc.)
    • BI Publisher Template Builder for Word Tutorial – Annotated – This is an annotated version of an Oracle “quick tutorial” document.  The annotations are added to clarify some of the points and to bring the instructions into line with the version of BI Publisher installed at Wesleyan.
    • Sub Templates in Oracle BI Publisher (August 2009)

 

  • HEUG Links
    • Navigate to the PROCEDURES ~ General page to see some outside references on the topic of BI Publisher (XML Publisher) and templates, including webinar content and Alliance presentations.

Go to top

 Comparison of Results Using Real Data and Sample Data

Creating a Template Using Sample Data:

  • If the Data Source has been created and is being used in the Template, what you see in a Preview are field names along with the words “sample data.”
  • To learn about the steps involved in creating a Data Source, review the procedures in the PowerPoint BI Publisher Outline of Steps for Report Developer Role
  • A Preview that is run in the Word Template with Sample Data would look like this:

Preview Country Codes SAMPLE DATA

 

 

 

Creating a Template Using Real Data:

Note that to better illustrate how the final text will appear, the data in the following examples are derived from an XML file saved directly from Query, i.e., the Report Definition Data Source has not yet been created. 

  • The data appearing in the previews are real data saved in the XML File.
  • This is not “live” data, i.e. this is the output of a query as it existed at the point in time that the query was downloaded to XML.
  • Important:  The data you see in the Template are not connected to PS Query.
  • Review this document to better understand this concept:  FAQs about Using Real Data When Designing and Previewing Your BI Publisher Word Template. 
  • A Preview that is run in the Word Template with Real Data would look like this:

Preview Country Codes REAL DATA

Go to top

BIP / XMLP Templates – Some Terminology

Below are some of the essential terms you will run across as you begin working with BI Publisher and Templates.

To familiarize yourself with more complex concepts, you can review related information found on the ORACLE/PEOPLESOFT Publications and Presentations page and Procedures ~ General page.

Basically, a BIP Template is similar in appearance to a Microsoft Word Mail Merge document.  In addition to text and graphics, the BIP Template contains fields that hold the variable information that will appear in the final report, letter or email.  And the Add-In menu contains a number of methods, including wizards, to help you format, perform calculations and aggregations, and otherwise enhance the appearance and usability of the document.

The variable fields are drawn from the query that is the Data Source from PeopleSoft.  The field information could be items such as EmplId, Address, City, State, Course IDs, Dates, Descriptions, etc.

When learning about BI Publisher Templates, you may encounter some of the terms listed below, but the main thing to remember is that you are working in Word and thus have many familiar Word tools available.

In order to effectively begin to use BI Publisher, you should become familiar with the terms highlighted in blue.

  • What is the Data Source?
    • The Data Source is the means by which data is extracted from PeopleSoft for use in the report.  Data Sources include PS Query, Connected Query and XML files.
  • What is XML?  
    • XML – stands for eXtensible Markup Language
      • It is designed to carry data, not to display data.  But it does not really DO anything
      • When you register a Query or a Connected Query as a Data Source, you are generating a sample XML file, not live data.
      • An XML File is the basis for the fields that are part of the BIP Template.
  • What is  BI (XML) Publisher Template Builder?
    • Template Builder is an extension to MS Word  that simplifies RTF template creation for Oracle BI Publisher reports. 
    • While the Template Builder is not required to create RTF templates, it provides many functions that increase productivity.
    • BI Publisher converts documents saved as the RTF file type to a XML-related style that enables you to create report layouts using many standard word processor features.
  • BI (XML) Templates are RTF (Rich Text Format) documents marked up with BI Publisher’s simplified XSL (part of XML).
    • Rich Text Format (RTF) is a specification used by common word processing applications, such as MS Word.
      • When you save a document, RTF is a file type option that you select, i.e. you do not save the file as .DOC, but rather as .RTF. 
      • You can create report designs using many of MS Word’s design features, and BI Publisher will recognize and maintain the design.
    • Template Builder provides easy-to-use wizards and other tools 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 (generally, PDFs).

Go to top

Comments are closed.