Cloud Documentation
Advanced Search


Extending the Applications for Functional Administrators
Close Window

 

This guide also applies to on-premise implementations

Table of Contents

Show All | Collapse

6 Customizing Reports and Analytics

This chapter contains the following:

Analytics Customization

Reports Customization

Analytics Customization

Customizing Analytics: Highlights

Edit and create custom analyses and dashboards to provide ad hoc reporting on your transactional data. Though the predefined analyses and dashboards help answer many of your business questions, you can create your own to meet custom requirements.

Each analysis and dashboard contains a set of attributes. For example, an analysis to provide information about customers would have attributes such as customer name, customer address, contact information, and so on. When users view the analysis, the latest customer information is queried and displayed. The Oracle Business Intelligence (BI) repository contains the data model metadata that support the available attributes.

This table shows what tools you can use to customize which BI object: analyses, dashboards, or the BI repository.


Tool

Description

Business Intelligence Object

BI Composer

A wizard for creating and editing analyses, available within Oracle Fusion Applications.

Analyses

Oracle Business Intelligence

An application that provides all needed features to customize analyses and dashboards. You can open this application from Oracle Fusion Applications.

Analyses and dashboards

Manage Descriptive Flexfields

Manage Key Flexfields

Manage Extensible Flexfields

Task lists in the Setup and Maintenance work area that let you capture custom attributes.

Oracle BI repository

Oracle BI Administration Tool (not available in Oracle Cloud implementations)

A feature in Oracle Business Intelligence that lets you customize the Oracle BI repository.

Oracle BI repository

Oracle BI Repository Customization

Catalog Security and the Types of Analytics Customizations Allowed: Points to Consider

Before you customize analyses or dashboards, ensure that you have proper permissions for editing and creating objects in the Oracle Business Intelligence (BI) Presentation Catalog.

Custom Folder

The Oracle BI Presentation catalog includes a Custom folder under Shared Folders. The Custom folder contains a subfolder for each product family, similar to the product family subfolder structure under Shared Folders.

When you edit a predefined analysis or dashboard, you should save the updated version in the Custom folder and leave the original as is. Keeping all custom objects in the Custom folder has the following benefits.

  • While patches can update predefined analyses and dashboards outside the Custom folder, you ensure that customized versions of those objects are not affected. You might lose customizations saved outside the Custom folder during upgrades.

  • Customized objects are easily located and identified.

  • Default security facilitates the editing of objects in the Custom folder without compromising security on the original objects.

Note

When you copy an object into the Custom folder, the copied object inherits the permission settings of the Custom folder. You must manually reset the permissions on the analysis or dashboard and product subfolder structure that you create under the Custom folder to reestablish the security settings of the original object.

BI Author

Users with the BI Author role have full control permissions to the Custom folder located under Shared Folders in the catalog.

This table summarizes the actions allowed for users with the BI Author role.


Customization

Action Allowed for BI Author

Edit analysis

Can edit analysis but cannot save to original folder. Must save the edited version to the Custom folder or My Folders.

Copy analysis

Can copy analysis and save to the Custom folder or My Folders. Cannot save the copy to original folder.

Create new analysis

Can create a new analysis and save to the Custom folder or My Folders.

Edit dashboard

Not allowed for predefined dashboards; must first make a copy of predefined dashboards.

Copy dashboard

Can copy dashboard and save to the Custom folder or My Folders. In the Custom folder the copy can be edited. Cannot save the copy to original folder.

Create new dashboard

Not allowed.

BI Platform Administrator

By default, the BI Platform Administrator role (not available in Oracle Cloud implementations) is granted full control permissions to the Custom folder and product family subfolders under Shared Folders. Users with this role can, for example:

  • Edit and delete the objects that are copied to or created in the Custom folder.

  • Set permissions on objects in the Custom folder.

  • Create new dashboards.

  • Directly edit predefined objects in the catalog.

    Important

    Edit predefined analyses or dashboards directly only when necessary to maintain the proper functioning of applications or processes that reference the original objects (such as embedded dashboards or targets of navigation actions). Otherwise, you should copy the predefined objects that you wish to customize into the corresponding product family subfolder under the Custom folder.

Customizing Analytics: Examples

There are many ways to customize predefined analyses and dashboards, as well as many options available to you to create custom analyses and dashboards to suit your needs. The following examples illustrate only a few possible types of customizations.

Create an Analysis

Your team needs to print a simple list of all your customers, sorted by customer ID. From the Reports and Analytics pane, you click Create to create a new analysis. You include only the customer name, ID, and address in the analysis, and add a sort on the customer ID attribute, or column.

When users view this analysis, they can sort the results as needed and create a printable PDF file.

Create a View

A predefined analysis shows the number of hires per year in a bar graph. You want the results in a table format view as well. From the Reports and Analytics pane, you click Edit for the analysis and then Select Views. Add a table view and specify for the analysis layout that the table should be displayed below the graph. Save this customized version of a predefined analysis in the Custom folder of the Oracle Business Intelligence Presentation Catalog.

Create a View Selector

For the customized analysis that you added a table to, you later decide that you want to be able to toggle between the table and the graph and not display both at the same time. In the Reports and Analytics pane, find your custom analysis, and click More.

Edit the analysis. Select View Selector as a new view to add, and include the table and graph views in the selector.

Edit a Dashboard Prompt

A dashboard can contain many objects including analyses and prompts, which are parameters that determine what is displayed. A predefined dashboard on invoices provides prompts such as Begin Invoice Date and Invoice Type. You want to replace Begin Invoice Date with a date range prompt.

First you copy the dashboard and its components (analysis and prompt) into the Custom folder. In the Reports and Analytics pane, you click the Browse Catalog icon and then find the copied prompt. You edit that prompt and also the copied analysis so that both components work together.

Copying Dashboards: Worked Example

This example demonstrates how to copy a predefined dashboard so that you can customize the copy and not the original.

The following table summarizes key decisions for this scenario.


Decisions to Consider

In This Example

Which predefined dashboard are you copying?

Payables Invoice Audit Listing

Is the copied version for yourself only or to be shared among multiple users?

Shared

Make a copy of the Payables Invoice Audit Listing dashboard and all its contents, including its analysis and prompt, and place them in the appropriate folders under Shared Folders - Custom. Edit the copied dashboard so that it contains the copied analysis and prompt.

Copying the Dashboard

  1. Navigate to the Reports and Analytics work area (Navigator - Tools - Reports and Analytics).
  2. Go to Shared Folders - Financials - Payables - Invoices - Payables Invoice Audit Listing - Invoice Audit Listing, and click the More link.
  3. In the Folders pane, click the selected Payables Invoice Audit Listing dashboard.
  4. Click the Copy icon button in the toolbar.
  5. In the Folders pane, go to Shared Folders - Custom - Financials.
  6. In the toolbar, click the New icon button and select Folder.
  7. Enter Payables in the Name field and click the OK button.
  8. Click the Paste icon button in the toolbar.

Copying the Prompt and Analysis

  1. With the Payables folder still open, in the toolbar of the Folders pane, click the New icon button and select Folder.
  2. Enter Prompts in the Name field and click the OK button.
  3. Create another folder with the name Report Components.
  4. In the Folders pane, go to Shared Folders - Financials - Payables - Invoices, and select the Prompts folder.
  5. For the Payables Invoice Audit Listing dashboard prompt, click the More link and select Copy.
  6. In the Folders pane, select Shared Folders - Custom - Payables - Prompts, and click the Paste icon button in the toolbar.
  7. In the Folders pane, go to Shared Folders - Financials - Payables - Invoices, and select the Report Components folder.
  8. For the Payables Invoice Audit Listing analysis, click the More link and select Copy.
  9. In the Folders pane, select Shared Folders - Custom - Payables - Report Components, and click the Paste icon button in the toolbar.

Editing the Copied Dashboard

  1. In the Folders pane, go to Shared Folders - Custom - Payables - Payables Invoice Audit Listing.
  2. Click the Edit link for the Invoice Audit Listing dashboard.
  3. Click the Delete icon button for the Payables Invoice Audit Listing dashboard prompt within the Search region.
  4. In the Catalog pane, select Shared Folders - Custom - Payables - Prompts - Payables Invoice Audit Listing and drag it into the Search region.
  5. Delete the Payables Invoice Audit Listing compound view within the Section 1 region.
  6. In the Catalog pane, select Folders - Custom - Payables - Report Components - Payables Invoice Audit Listing and drag it into the Section 1 region.
  7. Click the Save icon button.

FAQs for Analytics Customization

What happens to customized analyses and dashboards when a patch is applied?

All custom analyses and dashboards in Shared Folders - Custom are preserved during the patch process.

Changes to predefined analyses and dashboards are preserved when the patch does not include a new version of that object. If the patch does include a new version of a predefined object that was customized, then the patch process detects and logs this conflict, and patching will stop. The administrator must resolve any conflicts manually using Catalog Manager and then rerun the patch.

Reports Customization

Customizing Reports: Explained

Reports extract data from your applications and present it in the formats required for your enterprise. The output is optimized for high-fidelity printing. Reports provide the information you need for internal operations and statutory compliance; reports also provide the business documents for communicating with your customers.

Many product-specific reports are provided with Oracle Fusion Applications; for example, the invoice register, the pick slip report, the payroll summary, the journals report, and the customer credit memo. To meet the specific needs of your enterprise, you may need to customize the reports provided or create new reports to capture and present different data.

Report Components

Reports are built with Oracle Business Intelligence (BI) Publisher. A report in Oracle BI Publisher consists of components which can be customized, as described in this table:


Report Component

Description

Tool for Customizing

Data model

Defines the data source, data structure, and parameters for the report. A data model can be used by multiple reports. Each report has one data model.

Data model editor in Oracle BI Publisher

Layout

Defines the presentation, formatting, and visualizations of the data. A report may have multiple layouts of the data model, and there are different types of layout templates, for example Excel and RTF.

Style templates and subtemplates can also be created and applied to layout templates.

  • RTF: Microsoft Word (Template Builder for Word)

  • XPT (BI Publisher Template): Layout editor in BI Publisher

  • PDF: Adobe Acrobat Professional

  • Excel: Microsoft Excel (Template Builder for Excel)

  • eText: Microsoft Word

Properties

Specifies run time and formatting options.

Report editor in BI Publisher

What You Can Customize

This table shows some common report customization scenarios.


Customization Use Case

Example

Edit the layout of a report provided with an application.

Add your company logo to the Receivables Credit Memo report.

Add a new layout to a report provided with an application.

Design a new form letter users can select when they run the Receivables Credit Memo.

Edit a predefined data model.

Add two fields to the data model used by the Receivables Credit Memo report so that those new fields can be incorporated into a custom layout of the report.

Create a new report based on a new data model.

Create a new data model based on sales order transaction data from an external system, and create new sales order reports using the custom data model.

Additional Report Customization Tasks

Depending on how a report is implemented in Oracle Fusion Applications and the type of customization you make, you may also have to perform additional tasks to implement your custom report in the system.

  • Scheduled processes: When you create a new report and you want users to be able to run this report as a scheduled process, you must create an Oracle Enterprise Scheduler job definition for the report.

  • Translation: If you create a custom layout and you require translations of the layout, you must also provide the translations. Oracle BI Publisher provides a tool for extracting the translation file for some layout types. The translation file can be translated into the required languages then uploaded to the report.

  • Security: You must ensure that the proper security settings are applied to the report and data model to enable the intended report consumers to run the report.

Accessing Report Components to Customize: Points to Consider

To create or edit reports, you need to access the Oracle Business Intelligence (BI) Presentation Catalog. In the catalog, objects of type Report represent the report definition, including report properties and layouts. Data models are separate objects in the catalog, usually stored in subfolders called Data Models. Style templates and subtemplates are also stored in the catalog.

Accessing the Catalog

To access the catalog, you have the following options:

  • In the Reports and Analytics pane, click Browse Catalog to open the Oracle BI Presentation Catalog, and find the report in the catalog.

  • In the Reports and Analytics pane, find the report and select More to go to the report directly in the catalog. The data model associated with the report should be in the Data Models subfolder within the same folder as the report.

  • Sign in to the business intelligence application directly (for example: http://host:port/analytics/saw.dll) to open the catalog.

  • Sign in to the BI Publisher server directly (for example: http://hostname.com:7001/xmlpserver) to open the catalog.

    • Alternatively, once you are in the catalog using another method, for example through the Reports and Analytics pane, change the final node of the URL (http://host:port/analytics/saw.dll) to xmlpserver. So the URL you use would be: http://host:port/xmlpserver.

Important

Save all custom report components in Shared Folders - Custom within the catalog. Objects outside the Custom folder are susceptible to patches.

Therefore, Oracle recommends that you do not directly edit predefined report components. If you change a predefined object and a subsequent patch includes a new version of it, then the patch overwrites any customizations.

For predefined report objects only (not data models, style templates, or subtemplates), use the Customize option if possible.

Predefined Reports

The Customize option for predefined report objects is only available through direct access to the BI Publisher server using the /xmlpserver URL. When you find your report in the Oracle BI Presentation Catalog, select the Customize option from the More menu.

The Customize option automatically creates a custom copy of a predefined report and stores it in the Shared Folders - Custom folder within the catalog. The new report is linked to the original, so that when users open or schedule the original, they are actually using the custom version.

If you do not have the Customize option or do not want the original version linked to the new report, then make a copy of the predefined report and save it in the Custom folder.

Predefined Data Models

Don't customize predefined data models. Instead, copy the data model into the Custom folder and edit the copy.

Using the Customize Option for Predefined Reports: Points to Consider

When you select the Customize option for a report, Oracle Business Intelligence (BI) Publisher creates a copy of the report in Shared Folders - Custom within the Oracle BI Presentation Catalog. The report, folder structure, and original report permissions are copied. For example, if the predefined report is in the Sales folder, the custom report is automatically created and saved in the Sales folder within Custom.

This custom copy is linked internally to the original report. You can customize the custom copy of the report, leaving the original report intact. When users initiate a request to run the original report, whether as a scheduled process, from the BI catalog, or through an application process, BI Publisher detects the customized version and runs your custom version instead.

Benefits of the Customize Option

Aside from the convenience of automatically copying a report to the Custom folder, the Customize option:

  • Removes the requirement to edit calling processes or applications to execute the custom report. BI Publisher automatically sends all requests to run the original report to the custom copy. Therefore Oracle Enterprise Scheduler job definitions that point to the original report or applications that call the original report will automatically run your custom report with no additional configuration required.

  • Automatically copies the security settings of the original report.

  • Removes the risk of patches overwriting your customizations of predefined reports. When a patch is applied that updates the original report, the custom report is not updated in any way.

    Note

    The custom report still references the original data model. The data model is not copied. A patch that updates the data model may impact the running of your custom report if the data structure is changed.

Accessing the Customize Option

To access the Customize option:

  1. Sign in to the BI Publisher server (for example, http://hostname.com:7001/xmlpserver).

  2. Go to the predefined report in the catalog.

  3. Select Customize from the More menu for the report.

  4. The copied report in the Custom folder opens, so proceed to customize this report.

To apply further edits to the report in the Custom folder, perform one of the following:

  • Select the Customize or Edit option for the original report to open the existing customized report.

  • Go to the custom report in the Custom folder and select Edit.

Links Between Original and Custom Reports: Points to Consider

The Customize option for predefined reports creates a custom copy of the report that is linked to the original. Consider the following points when you work with both the original and custom versions.

Maintaining the Link Between Reports

The link between the predefined report and the custom report is based on the name of the custom report in the same folder under Custom.

  • If you manually create the identical folder path to a report under the Custom folder and create a report with the same name, Oracle Business Intelligence Publisher treats the identically named report as a customized report and will run this report instead of the original report, as if you had used the Customize option to create it.

  • The link to the original report is broken if you rename the custom report.

    You can edit the custom report so that it uses a different data model. However, if the original data model is updated later, for example due to a patch, then your custom report does not benefit from the change.

Tasks Performed on Original Reports

When a custom version of a report exists, performing tasks on the original report have the results shown in this table.


Tasks Performed on the Original Report

Behavior When a Custom Report Is Present

Open

Opens the custom report.

Schedule

Creates a report job for the custom report.

Edit

Edits the custom report.

Delete

Deletes the original report only. If you delete the custom report, the original report is not deleted.

Copy

Copies the original report.

Cut and Paste

Cuts and pastes the original report.

Rename

Renames the original report. The custom report name is not changed.

Download

Downloads the custom report.

Customize

Edits the custom report.

History

Opens the job history of the custom report.

Roles You Need to Customize Reports: Explained

To view and perform actions on report components in the Oracle Business Intelligence (BI) Presentation catalog, your role must be granted the appropriate combination of functional permissions to enable the actions and access permissions to the object in the catalog. The functional permissions are granted in the definition of the role; the access permissions are granted in the catalog.

Customizing Reports, Style Templates, and Subtemplates

To edit, create, or copy reports, style templates, and subtemplates, you must have the BI Author role.

The following security settings are configured by default in the BI Presentation catalog:

  • All roles are granted the Traverse permission on all reports.

  • The BI Author role is granted Full Control on the Custom folder and product family subfolders, and along with the Read permission, you can:

    • Make a copy of predefined objects and save the copy in the Custom folder.

    • Edit and delete objects copied to the Custom folder for customization.

    • Create new reports, style templates, and subtemplates in the Custom folder.

Using the Customize Option

To access to the Customize option for predefined reports, you must have:

  • The BI Author role (or a role that includes the permission oracle.bi.publisher.developReport).

  • These permissions on the predefined report in the catalog:

    • Read

    • Run Publisher Report

  • These permissions on the Custom folder in the catalog:

    • Read

    • Write

To view a report in the Custom folder that is linked to the predefined report, you must have:

  • The BI Consumer role

  • These permissions on the predefined report in the catalog:

    • Read

    • Run Publisher Report

  • These permissions on the Custom folder in the catalog:

    • Read

    • Run Publisher Report

  • These permissions on the data model of the predefined report:

    • Read

    • Traverse

Customizing Data Models

To create and edit data models, you must be granted the Application Developer role. This role gives you the BI Publisher Data Model Developer role, which allows you to customize data models.

Important

  • Because the BI Publisher Data Model Developer enables the ability to write and execute SQL, it carries substantial access privileges and should, therefore, only be assigned when needed to the right users.

  • This access should be granted only in test environments, not production environments.

Report Layouts

Customizing Report Layouts: Overview

The layout defines the presentation of the report data. All predefined reports include at least one predefined layout template file that defines the presentation components (such as tables and labeled fields) and maps the elements from the data model to these components. The layout also defines font sizes, styles, borders, shading, and can also include images, such as a company logo. To customize a layout, you edit the layout template.

Several types of templates support different report layout requirements.

  • Most of the predefined templates are rich text format (RTF) templates created using Microsoft Word.

  • Some predefined templates are Oracle Business Intelligence (BI) Publisher layout templates created using Oracle BI Publisher's layout editor. These are for interactive and more visually appealing layouts.

  • A third type is the eText template, which is used specifically for electronic data interchange (EDI) and electronic funds transfer (EFT).

Oracle BI Publisher templates can also be created using Adobe PDF, Microsoft Excel, Adobe Flash, and XSL-FO.

You can create style templates and subtemplates to apply to your custom layout templates. For more information on creating style templates and subtemplates, see the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

Customizing Report Layouts: Examples

If the output of predefined reports doesn't completely meet your requirements, you can customize the layout templates. The following examples illustrate reasons to customize layout.

Style Changes Only, No Changes to Data Mapping

This is the simplest type of customization. Examples are removing the predefined logo from the report and inserting your own or simply modifying colors and font styles. For these changes you can download the predefined template and edit it.

Because there are no changes to the data mapping, style changes do not require sample data from your report; however, having sample data available will enable testing of the template from your desktop.

Changes to Mapped Data Elements Within the Existing Layout

An example of this type of customization is adding or removing a table column or data field from the report layout. For these changes you must have sample data to load to the layout editing tool.

You can download the predefined template, load your sample data, insert the required elements, preview your template, then upload your customized template back to the report definition.

New Presentation of the Data

For example, you want to present a different set of fields in a completely different way. Instead of editing an existing layout, it's more efficient to just create one. To create a new layout, start by opening the layout editing tool and loading the sample data to begin designing your custom layout.

Customizing Report Layouts: Procedures

Editing or creating a layout template using Microsoft Word or the layout editor involves making the actual changes to the template. However, that task is just one part of the entire process for customizing layouts.

  1. Create a custom copy of the original report.

  2. Review report settings for online viewing.

  3. Generate sample data from the report.

  4. Edit or create the layout.

  5. Upload the template file to the report definition.

  6. Add translations.

  7. Configure the layout settings.

1. Create a Custom Copy of the Original Report

Make a copy of the original report using the Customize option, or by manually duplicating a report and placing the copy within Shared Folders - Custom in the Oracle Business Intelligence (BI) Presentation Catalog.

2. Review Report Settings for Online Viewing

Some reports are configured to view only through an external application or through Oracle Enterprise Scheduler. To view your report online while you are customizing it, ensure that the following properties are set as shown in this section. When finished customizing your report, ensure that you reset these properties appropriately for production.

  • Report Properties Settings

    1. Navigate to your report copy in the catalog and click Edit.

    2. In the report editor, click the Properties link at the top of the page.

    3. In the Report Properties dialog box, select Run Report Online and deselect Report is Controlled by External Application.

  • Layout Setting

    1. In the report editor, click the View a list link.

    2. Ensure that the View Online check box is selected.

3. Generate Sample Data from the Report

Depending on the type of layout customization you are doing, sample data can be mandatory or helpful. Sample data enables the mapping of data fields to layout components in the report.

You can generate sample data from the:

  • Report data model

  • Report viewer

  • Scheduler

4. Edit or Create the Layout

To design an RTF layout using Template Builder for Word, or design a layout using the Oracle BI Publisher layout editor.

To design one of the other supported layout types, see the corresponding chapter in the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher:

  • PDF templates

  • Excel templates

  • eText templates

5. Upload the Template File to the Report Definition

If you created a layout using the layout editor, the layout is automatically saved to the report definition and you can skip this step. For all other layout types, upload the template file to the report definition.

  1. Navigate to your custom report under the Custom folder in the catalog and click Edit.

  2. On the report definition page, click View a list.

  3. On the table that lists the layouts, click Create.

  4. Under Upload or Generate Layout, click Upload.

  5. In the Upload Template dialog box:

    1. Enter a layout name.

    2. Browse for and select the template file.

    3. Select the template file type.

    4. Select the locale, which is not editable once the template file is saved to the report definition.

    5. Click Upload.

  6. Save the report definition.

6. Add Translations

Template translation enables the extraction of translatable strings from a single RTF-based template or a single BI Publisher layout template. Use this option if you want the report to have output in different languages based on the preferred language of the user; for example, you need to generate invoices for both German and French customers.

For information on translating individual templates, see the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

7. Configure the Layout Settings

To edit the layout settings, click View a list in the report editor.

Note

From here, you can also delete any layout templates by selecting the corresponding row and clicking the Delete icon button.

This table describes the properties to set for your custom layout.


Setting

Description

Output Formats

Output formats are the file formats available for the generated report, such as PDF, HTML, RTF, Excel. Depending on the requirements of a report, you may want to limit the output formats available to users. The output formats available vary according to the template file type.

Default Format

When multiple output formats are available for the report, the default output format is generated by default when the report is run in the report viewer.

Default Layout

When multiple layouts are available for the report, the default layout is presented first in the report viewer. Select this check box for your custom layout when you want it displayed first. One layout must be selected as the default layout.

Apply Style Template

If a style template is assigned to this report, use this field to apply the style template to the layout.

Active

Active layouts are displayed to report consumers.

Tip

To hide the original layout from users, inactivate it.

View Online

Layouts that can be viewed online are available to report consumers from the report viewer. If this check box is not selected, the layout is available only for scheduled jobs.

Generating Sample Report Data: Procedures

The report layout tools require sample data to enable the mapping of data fields to layout components in the report.

You can generate sample data from the:

  • Report data model

  • Report viewer

  • Scheduler

Data Model

To generate sample data from the data model:

  1. Navigate to the data model in the catalog and click Edit.

    Tip

    If you are not sure which data model is the source for a particular report, click the report Edit link. The data model is displayed in the upper left corner of the report editor.

  2. In the data model editor, click View Data.

  3. Enter values for any required parameters, select the number of rows to return, and click View.

  4. To save the sample data to the data model, click Save As Sample Data.

    If you are designing an RTF template, click Export to save the file to a local client for use with the Template Builder for Word.

  5. Save the data model.

Report Viewer

To save sample data from the report viewer:

Note

This procedure requires that the report is enabled for online viewing.

  1. Navigate to the report catalog.

  2. Click Open to run the report in the report viewer with the default parameters.

  3. On the Actions menu, click Export, then click Data.

  4. Save the data file.

Scheduler

To save sample data from the scheduler:

Note

This procedure requires that the report is enabled for scheduling through Oracle Business Intelligence (BI) Publisher.

  1. Navigate to the report in the catalog.

  2. Click Schedule to open the BI Publisher scheduler.

  3. On the General tab, enter values for any report parameters.

  4. On the Output tab, ensure that Save Data for Republishing is selected.

  5. Click Submit.

  6. Open the Report Job History page.

  7. On the global header, click Open, then click Report Job History.

  8. Locate your report job in the report Job Histories table and click the job name. On the details page, under Output and Delivery, click the XML Data Download icon button.

RTF Templates

Customizing RTF Templates: Procedures

Most predefined layout templates are RTF templates. An RTF template is a rich text format file that contains the layout instructions to use when generating the report. RTF templates are created using Microsoft Word. The add-in to Microsoft Word, Template Builder for Word, facilitates the coding of layout instructions.

Tip

If you are designing a new layout for the report, consider using the BI Publisher layout editor. The layout editor is an online layout editing tool launched from the report editor.

Using Template Builder for Word

To customize an RTF template:

  1. Ensure that you have a supported version of Microsoft Word.

  2. From the Oracle Business Intelligence home page, under the Get Started pane, click Download BI Desktop Tools. Select Oracle BI for MS Office and install the client.

  3. If you are modifying a predefined layout, navigate to the copy of the report under Custom in the catalog and click Edit. In the report editor, click the Edit link of the layout to download the RTF file to your local client.

    If you are creating a new layout, skip this step.

  4. Open the downloaded RTF template file in Microsoft Word; or, if you are creating a new template, open Microsoft Word.

  5. Load the sample data to the Template Builder for Word add-in.

  6. Edit or create the layout following the guidelines in the Template Builder for Word help.

  7. Save the file as Rich Text Format (RTF).

Changing the Branding Logo in a Predefined Template: Worked Example

The Payables Invoice Register report layout includes a standard logo in the report header. You want to replace the Oracle logo with your own logo.

The following table summarizes key decisions for this scenario.


Decisions to Consider

In This Example

What version of Microsoft Word am I using?

Microsoft Word 2007

Do I want to preview the customized template?

Yes

Changing the Logo

To change the logo in the report output:

  1. Download sample data from the Payables Invoice Register data model (InvoiceRegisterDM).

  2. Download the RTF template file and open it in Microsoft Word.

  3. In the BI Publisher tab, click Sample XML in the Load Data group, and select sample data that was saved from the data model.

  4. In the template, delete the Oracle logo.

    Payables Invoice Register template in Microsoft Word with the Oracle logo selected for deletion

  5. On the Insert tab in the Illustrations group, click Picture.

  6. Select your company logo image file and insert it into the Word document.

    Payables Invoice Register template in Microsoft Word with a new logo

  7. Resize the image as necessary.

    Tip

    If the template file includes section breaks, you must insert the new logo for each section header.

  8. In the Oracle BI Publisher tab, in the Preview group, click PDF. Template Builder for Word applies the sample data you loaded and generates a PDF output document.

Creating an RTF Template Using an Existing Data Model: Worked Example

This example demonstrates creating an RTF template using an existing data model. You want to create a layout that displays invoice summary for each currency.

The following table summarizes the key decisions for this scenario.


Decisions to Consider

In This Example

What version of Microsoft Word am I using?

Microsoft word 2007

Which data model am I using?

Payables Invoice Register

Which date format do I want displayed in the report output?

M/d/yyyy

What number format do I want displayed in the report output?

999.00

Do I want to preview the layout?

Yes

Creating the Layout and Inserting Fields

To create the layout of the template and insert data fields:

  1. Download to your local client sample data from the Payables Invoice Register data model (InvoiceRegisterDM).

  2. Open Microsoft Word and create a blank new document.

  3. In the BI Publisher tab, click Sample XML in the Load Data group, and select sample data that was saved from the data model.

  4. Using Microsoft Word functionality, insert the page header. Type the text for the header, and insert the field for the Business Unit.

    RTF template with page header

  5. In this example, the report will repeat the table of invoices for each occurrence of the currency code. To create this behavior, insert a repeating group based on the element C_CURRENCY_CODE:

    1. On the BI Publisher tab, in the Insert group, click Repeating Group.

    2. In the BI Publisher Properties dialog box, select the G_CURRENCY in the For Each field.

    3. To display the field value, type Currency: after the for-each tag in the template.

    4. To insert the element from the data, on the BI Publisher tab, in the Insert group, click Field. Select the C_Currency_Code element in the Field dialog box.

      Field dialog box with C_Currency_Code selected

  6. To insert the table, on the BI Publisher tab in the Insert group, click Table Wizard. Make the following selections as shown in this table.


    Field

    Value

    Report Format

    Table

    Data Set

    VENDOR

    Which fields do you want to show in your report?

    • C Vendor Name

    • C Invoice Num

    • C Invoice Date

    • C Invoice Amount

    • C Amount Rem

    Note

    The inserted table will display with the column names from the data, and no formatting is applied to number and date fields.

    Edit the column names by simply editing the text in the column header row.

Apply Formatting to the Layout

To apply date, number, and other formatting to the layout:

  1. Apply formatting in the date field.

    1. Right-click the C_INVOICE_DATE field in the table and select BI Publisher - Properties.

    2. In the BI Publisher Properties dialog box, make the following selections as shown in this table.


      Field

      Value

      Text to display

      8/7/2011

      Type

      Date

      Format

      M/d/yyyy

      Date field formatting selections to make in the BI Publisher Properties dialog box

  2. Apply formatting to the number field.

    1. Right-click the C_INVOICE_AMOUNT field in the table and select BI Publisher - Properties.

    2. In the BI Publisher Properties dialog box, make the following selections as shown in this table.


      Field

      Value

      Text to display

      999.00

      Type

      Number

      Format

      #,##0.00

      Number field formatting selections to make in the BI Publisher Properties dialog box

  3. To display the total for each currency, enter the text Currency Total Remaining: beneath the table, but inside the for-each / end tags. Insert the field as follows:

    1. On the BI Publisher tab, in the Insert group, click Field.

    2. In the Field dialog box, click the C Amount Rem field (under the G Vendor group).

    3. In the Calculation field, select Sum.

      Selections to make in the Field dialog box

    4. Click Insert.

    5. Format the field as a number, as described above.

  4. Perform any additional formatting of colors, fonts, borders, and text strings using Microsoft Word functionality.

Final RTF template created

Previewing the Layout

In the Oracle BI Publisher tab, in the Preview group, click PDF.

Preview of new RTF template

Customizing BI Publisher Templates: Procedures

Oracle Business Intelligence (BI) Publisher templates are created using the BI Publisher layout editor, a design tool that provides an intuitive, drag-and-drop interface for creating pixel perfect reports in PDF, RTF, Excel, PowerPoint, and HTML. It also provides dynamic HTML output that supports lightweight interaction through a browser.

BI Publisher layouts are best suited for reports of simple to medium complexity. The interactive view is only available for BI Publisher layouts, therefore choose this layout type when you want your report consumers to interact with the report (change sorting, apply filters, and so on).

Using the Layout Editor

To customize BI Publisher templates:

  1. Make sure that sample data is generated from the data model that the report is using.

  2. Navigate to the report within the catalog and click Edit.

  3. Under the Create Layout section, click a template to launch the layout editor.

  4. Create the layout using the guidelines in the help for the layout editor.

  5. Click Save to save the layout to the report definition.

Customizing Data Models: Points to Consider

A data model defines the source and structure of the data for a report. At run time, Oracle Business Intelligence (BI) Publisher executes the data model to supply the XML data for a report.

Create a custom data model when the predefined data models do not provide the data required in your report.

If you need to customize the data that is captured by the report data model, you can either copy and edit an existing data model or create a new data model.

For more details on customizing data models, see the help on the pages you use to work with data models.

Predefined Data Models

In the Oracle BI Presentation Catalog, copy the predefined data model and paste in the corresponding folder within Shared Folders - Custom so that both versions have similar file path. Edit only the new copy in the Custom folder.

Data Tables

In BI Publisher the Oracle Fusion Applications tables are provisioned as follows:

  • ApplicationDB_FSCM - includes the applications data for Oracle Fusion Financials, Supply Chain Management, Project Management, Procurement, and Incentive Compensation

  • ApplicationDB_CRM - includes the Oracle Sales Cloud applications data

  • ApplicationDB_HCM - includes the Oracle Fusion Human Capital Management applications data

Typically, you create data sets from SQL queries against your Oracle Fusion application data tables.

Parameters

The order of parameters is important if there are Oracle Enterprise Scheduler job definitions defined for reports that use your data model. If you change the order in the data model, the job definitions must also be updated.

Creating Custom Reports: Procedures

Create a custom report when the predefined reports do not provide the data you need, or if you want to use a predefined data model but change other properties of the report. Save your custom report to Shared Folders - Custom in the Oracle Business Intelligence Presentation Catalog.

Report Creation Process

To create a custom report:

  1. From the toolbar of the catalog, select New - Report, then select the data model to use as the data source for this report.

  2. Continue with the wizard to create the report layout, or select to use the report editor and close the wizard.

  3. Define the layout for the report, and add translations for the layouts if needed.

  4. Configure a variety of properties to set specific formatting, caching, and processing options for your report.

    To access the Report Properties dialog box, click the Properties button in the report editor. For more information on configuring report properties, see the Oracle Fusion Middleware Report Designer's Guide for Oracle Business Intelligence Publisher.

  5. Optionally create an Oracle Enterprise Scheduler job definition so that users can run the custom report as a scheduled process.

  6. Optionally enable access to the report through the Reports and Analytics pane.

  7. Secure your report.

Setting Reports Up to Run as Scheduled Processes: Points to Consider

You can set up predefined or custom Oracle Business Intelligence (BI) Publisher reports to be run as scheduled processes. Otherwise, users can open reports appropriate to be run online through the Reports and Analytics pane or from the Oracle BI Presentation Catalog.

Create an Oracle Enterprise Scheduler job definition for the report. A job definition contains metadata that determines how the scheduled process works. Use the Define Custom Enterprise Scheduler Jobs task in the Setup and Maintenance work area to create job definitions.

General Job Definition Information

This table describes the general information to enter for the job definition.


Field

What You Enter

Job Type

BIPJobType

Report ID

The path to the report in the catalog, starting with the folder beneath Shared Folders, for example: Custom/Financials/Payables/Payables InvoiceRegisterCustom.xdo.

Tip

Ensure that you include the .xdo extension for the report object.

Default Output

A default output format.

Bursting Job

Select if output from this job is to be burst. The BI Publisher report must have a bursting definition. When the report is executed, the output and delivery options are determined by the bursting definition

For more information on adding bursting definitions, see the Oracle Fusion Middleware Data Modeling Guide for Oracle Business Intelligence Publisher.

Parameters

You can define parameters to be available to users when they submit scheduled processes based on your job definition. The parameters that you define must be in the same order as parameters in the data model that the report is using.

For example, the data model has parameters in the following order:

  • P_BUSINESS_UNIT

  • P_VENDOR_ID

  • P_INVOICE_TYPE

You create parameters as follows:

  • Business Unit

  • Supplier ID

  • Invoice Type

When users run the scheduled process, the values they enter are passed to the data model and determine the data to be included in the report.

Note

Because you define parameters using the list of values sources from the Define Custom Enterprise Scheduler Jobs task, you should not define lists of values in the data model.

User Property

The only user property you need to define is EXT_PortletContainerWebModule. Only lists of values associated with the application that you select are made available for parameters in this job definition.

Setting Up Reports for the Reports and Analytics Pane: Procedures

Users can access Oracle Business Intelligence (BI) Publisher reports from the Reports and Analytics pane, which is available in various work areas. Reports can be set up to be submitted as scheduled processes. For users to submit these scheduled processes from the Reports and Analytics pane, you must configure report properties.

Making Reports Available

To determine which reports are available to users in the Reports and Analytics pane, click Edit Settings in the Reports and Analytics pane, or use the Map Reports to Work Areas task in the Setup and Maintenance work area.

Enabling Reports for Scheduling

To enable scheduling in the Reports and Aanalytics pane:

  1. Go to the report in the Oracle BI Presentation Catalog and click Edit.

  2. Click Properties.

  3. On the General tab in the Properties dialog box, enter the following fields:


Field

Value

Enterprise Scheduler Job Package Name

The path for the job definition, for example: /oracle/apps/ess/financials/payables/invoices/transactions/Jobs

Enterprise Scheduler Job Definition Name

The job definition name (not display name), for example: APXINRIR

Securing Reports and Related Components: Procedures

When you create a custom report, you must secure it so that only users with appropriate privileges can run it. You can also update security definitions for custom reports that inherited those definitions from predefined reports.

For securing reports, you can use:

  • An existing role: When a custom report is functionally aligned with a predefined report. For example, if a user who runs the Account Analysis report should also run or have access to the custom report, then you can use the same role and entitlements from the Account Analysis report rather than creating a custom role.

  • A custom role: Which administrators create, or, in Oracle Cloud implementations, can be requested by logging a service request using My Oracle Support at https://support.oracle.com.

Configuring Permissions in the Oracle Business Intelligence Presentation Catalog

For a user to run a report, Read permissions must be granted to that user's role on every component in the Catalog that is used in the report:

  • Report

  • Data model

  • Subtemplate or style template (only if used)

The report object requires additional grants to run, schedule, and view output.

To grant permissions in the catalog:

  1. Go to the object in the catalog and select More - Permissions.

  2. In the Permission dialog box, click the Add users/roles icon button.

  3. In the Add Application Roles, Catalog Groups and Users dialog, select a role from the Application Roles list.

  4. In the Set Permission to field, select Custom, and then click OK.

  5. In the Permission dialog box, click the Edit Custom Permissions icon button for the role you added.

  6. In the Custom Permissions dialog box, select the permissions to enable.

    For all report component types, enable:

    • Read: To access, but not modify, the object.

    • Traverse: To copy the object.

    For report objects only, you typically also enable:

    • Run Publisher Report: To read, traverse the folder that contains the report, and run the report.

    • Schedule Publisher Report: To read, traverse the folder that contains the report, and schedule the report.

    • View Publisher Output: To view the report output generated by the scheduler.

Granting Permissions to the Oracle Enterprise Scheduler Job Definition

If your custom report has an Oracle Enterprise Scheduler job definition defined, then execution permissions must be granted to enable users belonging to the role to submit the corresponding job. For more information on extending custom Oracle Enterprise Scheduler jobs using existing Oracle Fusion applications, see the Oracle Fusion Applications Extensibility Guide for Developers.

Note

This task does not apply to Oracle Cloud implementations.