Oracle Fusion Middleware: User's Guide For Oracle Business Intelligence Publisher 12c (12.2.1.1.0)
Oracle Fusion Middleware: User's Guide For Oracle Business Intelligence Publisher 12c (12.2.1.1.0)
Oracle Fusion Middleware: User's Guide For Oracle Business Intelligence Publisher 12c (12.2.1.1.0)
November 2016
Explains how to view, schedule, deliver, publish, and share
reports created in Oracle Business Intelligence Publisher.
Oracle Fusion Middleware User's Guide for Oracle Business Intelligence Publisher, 12c (12.2.1.1.0)
E72870-02
Copyright © 2015, 2016, Oracle and/or its affiliates. All rights reserved.
Contributors: Oracle Business Intelligence Publisher development, product management, and quality
assurance teams.
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,
transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse
engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is
prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-
specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless
otherwise set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates
will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party
content, products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
2 Getting Started
Accessing Oracle Business Intelligence Publisher ............................................................................... 2-1
Logging in with Credentials ........................................................................................................... 2-1
Logging in as Guest.......................................................................................................................... 2-2
Setting My Account Preferences and Viewing My Groups................................................................ 2-3
Editing Account Preferences........................................................................................................... 2-3
Setting General Preferences ............................................................................................................ 2-4
Changing Your Password ............................................................................................................... 2-5
Viewing Your User Groups ............................................................................................................ 2-5
About the Home Page .............................................................................................................................. 2-6
Create ................................................................................................................................................. 2-6
Jobs or Browse/Manage.................................................................................................................. 2-7
Download BI Publisher Desktop Tools ......................................................................................... 2-7
Recent ................................................................................................................................................. 2-8
Favorites............................................................................................................................................. 2-8
About the Catalog..................................................................................................................................... 2-9
Browsing the Catalog....................................................................................................................... 2-9
About the Global Header......................................................................................................................... 2-9
iii
Searching the Catalog............................................................................................................................. 2-10
3 Viewing a Report
Viewing a Report ...................................................................................................................................... 3-1
Using the Report Viewer Options .......................................................................................................... 3-1
Parameters ......................................................................................................................................... 3-2
Layouts............................................................................................................................................... 3-5
View Report and Choose Other Output Types............................................................................ 3-5
Actions ............................................................................................................................................... 3-8
iv
Viewing Job History for a Specific Report ............................................................................................ 6-2
Searching for Report Job History............................................................................................................ 6-3
Viewing Details of a Job History ............................................................................................................ 6-4
Description of the illustration xdo11g_hist_det_out.gif ..................................................................... 6-4
Downloading Data from a Report Job ................................................................................................... 6-4
Republishing a Report from History ..................................................................................................... 6-5
Sending an Output to a New Destination ............................................................................................. 6-5
Monitoring Running Jobs ........................................................................................................................ 6-6
Canceling a Running Job ......................................................................................................................... 6-8
Getting Error and Warning Information for Reports .......................................................................... 6-8
Deleting a Job History .............................................................................................................................. 6-8
Refreshing the Report Job History Page................................................................................................ 6-9
7 Managing Reports
Overview of the BI Publisher Folders.................................................................................................... 7-1
Reporting Components Stored in the Catalog...................................................................................... 7-1
Creating a Folder or Subfolder ............................................................................................................... 7-2
Performing Tasks on Catalog Objects.................................................................................................... 7-2
Downloading and Uploading Catalog Objects .................................................................................... 7-4
Understanding the Impact of Taking Actions on Objects Referenced by Reports.......................... 7-4
Exporting and Importing Catalog Translation Files............................................................................ 7-5
A Accessibility Features
What are Accessibility Features? ............................................................................................................ A-1
Changing to Accessibility Mode............................................................................................................. A-1
Accessibility Support in the BI Publisher User Interface .................................................................... A-2
Signing In Using Keystrokes........................................................................................................... A-2
Navigating the Home Page............................................................................................................. A-3
Navigating Multiple Rows in Tables............................................................................................. A-3
Accessibility Support in BI Publisher Report Output ......................................................................... A-3
Keyboard Shortcuts .................................................................................................................................. A-4
v
vi
Preface
Welcome to Release 12c (12.2.1.1.0) of the User's Guide for Oracle Business Intelligence
Publisher.
Audience
This document is intended for report consumers who will be viewing and scheduling
reports in Oracle BI Publisher.
Conventions
The following text conventions are used in this document:
Convention Meaning
boldface Boldface type indicates graphical user interface elements associated
with an action, or terms defined in text or the glossary.
italic Italic type indicates book titles, emphasis, or placeholder variables for
which you supply particular values.
vii
New Features for Oracle BI Publisher Users
The Preface describes changes to Oracle BI Publisher report viewing and scheduling
features for Oracle Business Intelligence Publisher 12c (12.2.1.1).
ix
1
Introduction to Using Oracle Business
Intelligence Publisher
This chapter introduces Oracle BI Publisher for report consumers and describes the
features specific to viewing and scheduling reports.
This chapter includes the following section:
Data Model Fetching and structuring the data to Data Modeling Guide for Oracle
developer use in reports Business Intelligence Publisher
Report designer Creating report definitions Report Designer's Guide for Oracle
Designing layouts Business Intelligence Publisher
This chapter describes the basic features of the BI Publisher application including
setting preferences, navigating the catalog, and accessing task menus.
This chapter includes the following sections:
Note:
• Logging in as Guest
2. Select the language that you prefer for log in page. Your language selection only
remains in effect for the current session of BI Publisher. The next time you log into
BI Publisher, the original default language is displayed.
The log in page language selection does not take effect on any other pages in BI
Publisher. For more information on setting the overall BI Publisher UI Language,
see Setting General Preferences.
If your implementation of BI Publisher is integrated with Oracle Business
Intelligence Enterprise Edition, you cannot modify the language selection on the
log in page.
Note:
Logging in as Guest
If your administrator has enabled guest access, then a Guest button displays on the
Login page.
A guest user does not require credentials and has privileges only to view reports
available in the folder set up for guest access.
2. Click Guest.
Note:
Your preferences may be inherited from another Oracle product. If this is true
for your work environment, you cannot update your preferences from within
BI Publisher. If you are not sure where to update your preferences, ask your
administrator.
When BI Publisher is integrated with Oracle Business Intelligence Enterprise
Edition (BI EE), the Report Locale, UI Language, and Time Zone user
preferences are set in the Oracle BI EE application. For more information, see
‘Setting Preferences’ in User's Guide for Oracle Business Intelligence Enterprise
Edition. When you update your BI Publisher preferences in Oracle BI EE, you
must start a new BI Publisher HTTP session for these to take effect in the BI
Publisher interface.
1. In the global header, click your user name displayed after Signed In As and then
select My Account.
• Report Locale
• UI Language
• Time Zone
• Accessibility Mode
Note:
The Email Addresses field is reserved for future use and is not functional in
this release.
Report Locale
A locale is a language and territory combination, for example, English (United States)
or French (Canada).
BI Publisher uses the report locale selection to determine the following:
• The number, date, and currency formatting to apply to the report data.
If a particular report does not have a translation for the selected locale, BI Publisher
applies a locale fallback logic to select the most appropriate layout available. For more
information, see Locale Selection Logic in Report Designer's Guide for Oracle Business
Intelligence Publisher.
BI Publisher applies localized number, date, and currency formatting independently of
the layout translation.
UI Language
The UI language is the language in which the user interface displays, and you select
languages that are available for your installation.
If your implementation of BI Publisher is integrated with Oracle Business Intelligence
Enterprise Edition , you cannot change the UI language here. For more information,
see Setting Preferences in User's Guide for Oracle Business Intelligence Enterprise Edition.
Time Zone
Reports display the time according to the time zone preference selected here.
You can override this setting when creating a scheduled report job, see Creating
Report Jobs. The time displayed on the user interface and reflected in report
processing times is governed by the BI Publisher server time zone.
The Administrator can override your individual time zone setting so that all reports or
some reports use the same system time zone setting instead.
Accessibility Mode
Setting Accessibility mode to On enables the accessibility features for users who
interact with BI Publisher using the keyboard only.
When Accessibility Mode is enabled, the following features are available:
• Tables on user interface pages display check boxes to enable multi-row selection
and subsequent action.
• The create report process flow limits the options presented to require the selection
of a data model as the first step in the process.
• Create
• Jobs or Browse/Manage
• Recent
• Favorites
Create
The Create section provides links to initiate creation tasks, such as create report, create
report job and create data model.
In the Create section, click More to access options not shown. Oracle BI Publisher
populates this list based on the permissions or roles you have.
For more information on each task, see the documents that are listed in the Lists of
Tasks and Documents table.
Create Data Using the Data Model Editor in Data Modeling Guide for Oracle Business
Model Intelligence Publisher
Create Style Creating and Implementing Style Templates in Report Designer's Guide for
Template Oracle Business Intelligence Publisher
Jobs or Browse/Manage
Use the Browse/Manage region from the Home page to quickly begin a specific task
by accessing catalog folders, report jobs, and report job history links.
The Jobs section of the Oracle BI Enterprise Edition Home page provides access to the
Report Jobs and the Report Jobs History pages, where you can view and manage
scheduled, running, and completed report jobs.
• Template Viewer
This add-in for Microsoft Word facilitates the design of RTF templates. For more
information, see Creating RTF Templates Using the Template Builder for Word in
Report Designer's Guide for Oracle Business Intelligence Publisher.
The Template Builder for Excel is included in the Template Builder for Word
installation. The Template Builder for Excel is an add-in for Microsoft Excel that
facilitates the design of Excel Templates. For more information, see Creating Excel
Templates in Report Designer's Guide for Oracle Business Intelligence Publisher.
The Template Viewer enables the testing of most template types from your desktop.
Oracle SQL Developer is a free and fully supported graphical tool for database
development. With SQL Developer, you can browse database objects, run SQL
statements and SQL scripts, and edit and debug PL/SQL statements. You can also run
any number of provided reports, as well as create and save your own. SQL Developer
enhances productivity and simplifies your database development tasks.
Recent
The Recent section contains the reports and other objects that you have recently
viewed, created, or updated.
You can take actions on these objects directly from the Recent region; for example, you
can open, edit, schedule, and view jobs or job history for a report.
Note:
Favorites
The Favorites region enables you to create your own list of objects for quick access.
From the Favorites region you can view, schedule, configure, or edit the objects that
you place there provided you have proper permissions. There are several ways to add
objects to the Favorites region:
• Locate the object in the catalog, click the More link, and then click Add to
Favorites.
• From the Report Viewer, click the Actions menu, and then click Add to Favorites.
2. Click Remove.
Use the Catalog page to locate objects in the catalog and perform tasks specific to those
objects. The objects and options that are available to you are determined by your
system privileges and the permissions assigned to individual folders and objects.
You can use the Catalog page to perform more specialized tasks such as:
The global header is always displayed when you are working in BI Publisher. When
you are viewing a report or working within one of the task editors, you can use the
global header to quickly begin a new task, search the catalog, access product
documentation, or view a different object.
The Signed In As menu enables you to access the My Account dialog, where you can
specify your preferences. For more information, see Setting My Account Preferences
and Viewing My Groups.
If you are logged in as an administrator, the Administration link is displayed in the
global header to enable access to the Administration page, see About the
Administration Page in Administrator's Guide for Oracle Business Intelligence Publisher.
Note:
• Viewing a Report
Viewing a Report
All reports reside in the catalog. The Oracle BI Publisher Home page displays recently
viewed reports and your favorite reports for quick access.
You can view a report in your web browser using the report viewer based on the
report properties. Depending on the report properties and your user permissions, you
can select and view different layouts, interact directly with displayed data, change the
output type, or send the report to someone else.
The Catalog displays two main reports folders:
• Shared Folders contains the reports and folders you have been granted access to
based on your role.
Following are the options available in the report viewer. Not all options are available
for all reports. See each section for more details:
• Parameters
• Layouts
• Actions
Parameters
Reports that enable parameter value input present the parameter selection prompts in
the report viewer. The presentation of the prompts varies according to the report
configuration. Parameters can be presented on the top of the report viewing area, to
the left side of the report viewing area, as a pop-up dialog, or as prompts on the page
before the report is displayed.
The parameter prompts can be hidden or displayed by clicking the Parameters action
button in the upper right area of the report viewer.
Some reports include an Apply button that you must click to re-display the report
after making parameter selections. If there is no Apply button, the report is
regenerated automatically after you make a new value selection. The display of the
Apply button is a parameter property setting. For information about setting this
property, see Configuring Parameter Settings for the Report in Report Designer's Guide
for Oracle Business Intelligence Publisher.
Parameter prompts may be one of the following types:
Lists with many values support search. Click Search at the bottom of the scroll list
to open the Search dialog. For more information, see: The Parameter Search Dialog.
• A text box into which you can type a value, as shown in the following figure.
Separate multiple values with a comma.
• A date editor that launches a calendar from which to select the date.
• % Allows you to match any string of any length, including zero length.
For parameters that support multiple value selections, the Search dialog includes a
shuttle interface to select multiple returned values.
Click the flexfield parameter identifier to open the parameter entry dialog. Enter
values for the flexfield segments in the dialog, as shown in the Flexfield Parameter
dialog figure.
Layouts
You can view the same report in different layouts by clicking on the particular report
layout tab such as Salary by Department, Salary by Manager, and Breakdown by
Office tabs.
When multiple layouts are available, they are displayed as separate tabs in the Report
Viewer page. To view the report displayed in a different layout, click its tab. The
different layouts could have different output types enabled.
• Interactive - This output is only available for layouts designed using BI Publisher's
Layout Editor. Interactive output enables pop-up chart value displays, navigable
and filterable tables, and other interactive features for a report.
• HTML - (Hypertext Markup Language) formats the report for browser viewing.
• PDF - (Portable Document Format) formats the report as PDF and opens the report
in Adobe Acrobat reader. This output type is optimized for printing.
• RTF - (Rich Text Format) is a format used by word processing applications. If you
have a word processing application installed, such as Microsoft Word or
OpenOffice.org, then you are prompted to open the application for viewing.
• Excel (mhtml) - Select this output type to view the report in Excel if you have
Microsoft Excel 2003. This option generates an MHTML format file that can be
opened in Excel 2003 or later. This option supports embedded images, such as
charts and logos.
• Excel (html) - Select this output type only if you are running the earlier versions of
Microsoft Excel 2000 or 2002. This option generates HTML that can be opened in
Excel. It does not support embedded images.
• Excel (*.xlsx) - Select this option to generate the report in Excel.xlsx (Excel XML
format). If you have Excel 2007 or later installed, this option provides the best
preservation of layout and formatting.
Note:
For output format Excel 2007, that uses the xlsx file extension, BI Publisher
does not apply any formatting for number and date. BI Publisher saves the
formatting mask and the actual value (date or number) into the XLSX output
file. The formatting is handled by Microsoft Excel. For example:
• MHTML - (Mime HyperText Markup Language) format enables you to save a Web
page and its resources as a single MHTML file (.mht), in which all images and
linked files are saved as a single entity. Use this option to send or save HTML
output and retain the embedded images and stylesheet formatting.
• PDF/X - is for reports that require formatting for pre-press graphics exchange.
PDF/X is a specialized subset of the PDF standard that streamlines documents for
high-quality print production output and restricts content that does not serve the
print production, such as signatures, comments, and embedded multimedia.
• Zipped PDFs - This option is only available for reports that have been designed to
enable zipped PDF output. BI Publisher generates a zip file containing the report
PDF output and index files. For more information on designing a report to generate
a zipped PDF, see Generating Zipped PDF Output in Report Designer's Guide for
Oracle Business Intelligence Publisher.
Note:
For Safari browser users, the Safari browser renders XML as text. To view the
XML generated by the data engine as XML, right-click inside the frame
displaying the data and then click View Frame Source. This is a display issue
only. The data is saved properly if you choose to export the data.
• Data (CSV) - displays the data in comma separated value format. The data must be
in a simple <rowset>/<row> structure.
• Flash - displays output for templates designed using Adobe Flash. You must have
the Adobe Flash Player Plug-in installed for your Web browser.
Actions
The Actions menu provides more commands and operation that you can perform on
the report.
The options that are available to you depend on your user privileges and properties
set for the report.
The image shows the Actions menu.
• Add to My Favorite adds this report to your My Favorites list on your Home page.
• Edit Report enables you to update the report definition. For example, you can add
or create new layouts, update the report properties, or change the default
parameter values, see Editing Reports in Report Designer's Guide for Oracle Business
Intelligence Publisher.
• Edit Layout enables you to update the layout you are viewing. When the layout
was created using the BI Publisher Layout Editor, the Layout Editor launches in the
browser, see Creating BI Publisher Layout Templates in Report Designer's Guide for
Oracle Business Intelligence Publisher. If the layout is based on another supported
template type such as RTF, PDF, or Excel then you are prompted to save the
template file. You can then open it in the appropriate application.
• Export exports the report to the default application for the output type you select,
for example, Adobe Acrobat for PDF output or Microsoft Excel for Excel output.
• Send enables you to schedule the report for immediate delivery to an e-mail
address, printer, or other destination.
The Send action launches the Schedule Report Job page where you can select the
output, destination, and notification options.
Note: You cannot send a report in Interactive mode. You must select a
different output type such as PDF or HTML from the View Report list, and
then click Send.
• Schedule creates a job to run and distribute the report. For more information, see
Navigating to the Schedule Report Job Page.
• Jobs enables you to view and manage currently scheduled jobs for this report, see
About the Manage Report Jobs Page.
• Job History enables you to view completed and running report jobs, see Viewing
Report Job History and Saved Output.
• Share Report Link enables you to generate a link that you can copy and reuse,
based on the report that you are currently viewing. When you select an option, a
dialog displays the URL to the report. You can control what the URL displays as
follows:
– No Header displays the current report without the BI Publisher logo, tabs, or
navigation path.
– No Parameters displays the current report without the header or any parameter
selections. The Actions, Export, and View Report menus are still available.
– Document Only displays the URL to the current report document only. No
other page information or options are displayed.
Note:
Share Report Link is a report property that can be disabled. For more
information on setting this and other report properties, see Configuring
Report Properties in Report Designer's Guide for Oracle Business Intelligence
Publisher.
Creating Report Jobs chapter describes how to use the BI Publisher scheduler to create
and monitor report jobs. Report jobs can be scheduled to run at defined intervals and
to be delivered to multiple destinations.
This chapter includes the following sections:
• Configuring Notifications
• Advanced Topics
• From the Catalog, navigate to the report you want to schedule, then select the
Schedule link.
• From the Report Viewer, click Actions and then click Schedule.
2. Use the Schedule Report Job tabs to define the options for your report job.
Field Description
Report If you accessed the Schedule page from the report, this field displays the report
path and name. If you accessed the Schedule page from the Create region or the
global header, click Choose to browse for and select the report to schedule.
Parameters Any parameters defined for the report are displayed. Enter the values for this
job. For parameters that allow text entry, separate multiple values with a
comma.
For date parameters, you can use an expression to increment the date for each
run. For more information, see Incrementing Date Parameters.
Option Description
Use Bursting Enable this option to use the report bursting definition for output and
Definition to delivery. Once selected, all other fields on this page are disabled for
Determine selection. This option is only available when bursting is enabled for the
Output and report. For more information on report bursting, see: Creating a Bursting
Delivery Job.
Destination
Make Output Enable this option to make this job output available to all users with
Public permission to access this report. Users with access can view the report
from the Report Job History page.
Save Data for Enable this option to save the XML data that is generated for this job.
Republishing Access the saved data from the Report Job History page (see: Viewing
Report Job History and Saved Output) where you can republish it,
selecting a new layout and output options.
Adding Outputs
Use the Output table fields that are described in this table to add outputs to the job.
The Output Table enables you to create multiple report documents for one or more
layouts using a combination of output format, locale, time zone, and calendar.
The following table describes the fields in the Output table.
Field Description
Format Select the document output format. Output format is the type of
document that is generated, for example, PDF, HTML, or Excel. The
options available here are specified in the report definition.
Locale Select the language-territory combination for this report output. This
field defaults to the Report Locale defined in the user Preferences,
see Setting My Account Preferences and Viewing My Groups.
If the layout does not have an available translation for the selected
locale, BI Publisher applies a locale fallback logic to select the layout.
For more information, see: Locale Selection Logic in Report Designer's
Guide for Oracle Business Intelligence Publisher.
The appropriate number and date formatting are applied
independently of the template translation.
Timezone Select the time zone to use for this report output. The time zone
defaults to the time zone defined in the user Preferences, see Setting
My Account Preferences and Viewing My Groups.
Field Description
Save Output Select this box to save the report output. You must select this option
to view your report from the Report Job History page.
1. From an existing report in the Report Viewer, select Actions, and then select
Schedule.
5. Select the options to use from the Layout, Format, Locale, Timezone, and Calendar
lists.
1. From an existing report in the Report Viewer, select Actions, and then select
Schedule.
3. In the Output tab, open Destinations, and from the Destination Type list, choose a
destination type.
Only those destination types set up by your administrator are displayed in the
Destination Type list.
4. For each destination, from the Output list, select the documents to send to the
destination.
See Report Output Destination Types and Content Server Destination Type
Properties.
6. Select Save Output to view the output from the Report Job History page.
Document Cloud Services Select the ODCS Server and the destination
Folder Name.
1. From the Oracle BI Publisher Home page, under Create, select Report Job.
2. In Schedule Report Job, on the General tab, click search next to the Report field.
3. In Open, navigate to and select the report, and then click Open.
5. In the Frequency list, select the option to use for this report.
7. Click Submit.
8. (Optional) In Submit, in the Report Job Name field, type a name, and click OK.
Option Description
Frequency Defines when to execute the report job using
the scheduler from the Frequency list.
Once
Define a recurrence pattern and select Once option to execute the report job using the
scheduler.
Select Run Now or use the date selector to enter the specific Start date and time.
Hourly/Minute
Select hours or minutes as a recurrence pattern option when you schedule a job using
the Schedule tab to define when to execute the report job.
Every - Select Hour(s) or Minute(s) and enter the appropriate integer value for the
increment.
Start - Use the date selector to enter the date and time to start running this job.
End - (optional) Use the date selector to enter an end date and time for this job.
Daily
One of the options to define a recurrence pattern is to use daily option.
Every - Enter the increment in days, for example, to run the report every day enter 1,
or to run the report every other day, enter 2.
Start - Use the date selector to enter the date and time to start running this job. The
time selected determines when (hour of the day) the job is executed each day that it
runs.
End - (Optional) Use the date selector to enter an end date and time for this job.
Weekly
You can define a recurrence pattern selecting the weekly option, where you can run
the report on a specific day of a week.
Every - Enter the increment in weeks and select the desired day or days of the week.
For example, to run the report every Tuesday and Thursday, enter 1, and then select
Tuesday and Thursday. To run the report every other Wednesday, enter 2, and select
Wednesday.
Start - Use the date selector to enter the date and time to start running this job. The
time selected determines the time that the job is executed for each run.
End - (optional) Use the date selector to enter an end date for this job.
Monthly
Define a recurrence pattern and select the monthly option to execute the report job
monthly using the scheduler.
Every - Select each month that the job executes.
On - Select either a day of the week, for example, 1st Monday of every month; or select
a specific day of the month, for example, 15.
Start - Use the date selector to enter the date and time to start running this job. The
time selected determines the time that the job is executed for each run.
End - (Optional) Use the date selector to enter an end date for this job.
Annually
Use this annual recurrence pattern option to enter the increment in years.
Every
Enter the increment in years that the job executes.
On
Select either a day and a month, for example, Day 1 of January, or select a day of the
week of the month, for example, First Monday of January.
Start
Use the date selector to enter the date and time to start running this job. The time
selected determines the time that the job is executed for each run.
End
(Optional) Use the date selector to enter an end date for this job.
Specific Dates
When you define a recurrence pattern, you can also opt a specific date to run a job.
Add Date - Use the date selector to enter the specific date and time to run the job. Add
multiple specific dates as needed.
• A report job should only run after the successful completion of an extract, transfer,
and load process.
• Account management wants a report triggered if any of the receipts from the
previous day exceed a specified amount.
• Human resources needs a report only when new hires entered the system in the
previous week.
Triggers are set up in the data model and then they are available for selection from the
Schedules tab. You can associate a schedule trigger that is defined in any data model.
A report runs even if trigger in not defined in the report’s data model. One trigger per
report job is supported.
For more information about setting up schedule triggers in a data model, see Adding
Event Triggers in Data Modeling Guide for Oracle Business Intelligence Publisher.
2. (Optional) Set the Retry Limit value to specify the maximum number of times to
execute the schedule trigger to check for the condition. The default value is 1 and
only positive integer values are allowed in this field.
3. (Optional) Set the Pause Time value to specify the number of minutes to wait
before re-executing the schedule trigger. If the Retry Limit value is set to a value
greater than 1, this field is enabled. Only positive integer values are allowed in this
field.
Note:
The retry limit and pause time should not exceed the recurrence schedule time
interval.
If the condition returns false when the maximum number of attempts is reached,
then the job status is displayed as Skipped.
4. Select the Data Model that defines the schedule trigger. When the data model is
selected, the Trigger list displays the schedule triggers defined in the data model.
The Schedule Trigger Enabled for a Report Job figure shows a schedule trigger with
one parameter enabled for a report job.
Configuring Notifications
You can configure email and HTTP notifications.
• Report completed
• Report failed
• Report skipped
Configure the delivery email servers and HTTP servers in the Administration Delivery
Configuration page, see Setting Up Delivery Destinations in Administrator's Guide for
Oracle Business Intelligence Publisher.
Adding Notifications
Follow these steps to configure notifications for a job using the Notification tab.
HTTP
Use the Notification tab to configure notifications for a job and you have the option to
notify by HTTP, giving the HTTP Server name.
1. Select the report completion statuses for which to send the notification.
3. Enter the user name and password for the server, if required.
1. Select Submit to invoke the Submit Job dialog with confirmation details for you to
review.
3. (Optional) On the global header, click Open and then click Report Jobs to suspend,
edit, or delete a job.
For more information, see About the Manage Report Jobs Page.
4. (Optional) On the global header, click Open and then click Report Job History to
monitor a running job or to see the results.
For more information, see Viewing Report Job History and Saved Output.
1. From the Oracle BI Publisher Home page, under Browse/Manage, click Report
Jobs.
2. In Manage Report Jobs select filter criteria to find the existing job.
3. In the results table, click Edit to open the job for editing.
4. Enter the details for the new job definition. When finished, click Submit as New.
5. Enter a name for the new job and click Submit As.
Advanced Topics
Use these topics to increment date parameters and to define a destination file name
dynamically.
This section includes the following topics:
If changing the date parameters is required for each run, you can enter an expression
in the date parameter field of the scheduler to calculate the date each time the report
job executes.
For example, if you create a schedule for a report that runs every Monday to capture
data from the previous week, you need to update the date parameters for the report to
increment to the first and last days of the previous week.
Enter one of the following functions using the syntax shown to calculate the
appropriate date at the scheduled runtime for the report:
• {$SYSDATE()$} - current date, the system date of the server on which BI Publisher
is running.
• {$SYSDATE()+1$}
• {$SYSDATE()-7$}
For this example, to capture data from the previous week, each time the schedule runs,
enter the following in the report's date parameter fields:
Note:
You can set up the date functions as default parameter values in the data
model. In this case, every time a user views the report from the report viewer,
the date parameter is calculated according to the expression supplied for the
default value. For more information, see Adding Parameters and Lists of
Values in Data Modeling Guide for Oracle Business Intelligence Publisher.
Expression Description
%y Displays the year in four digits: Example: 2011
Expression Description
%m Displays the month in two digits: 01-12 (where 01 = January)
Examples
Use these steps to create a file name that appends a date and a file name that prefixes a
date and appends a time.
To create a file name that appends the day, month, and year such as:
myfile_01_11_2010.pdf
Enter the following:
myfile_%d_%m_%y.pdf
To create a file name that prefixes the day, month, and year and appends the hour and
minute such as:
01_01_2010_myfile_22_57.pdf
Enter the following:
%d_%m_%y_myfile_%H_%M.pdf
If the file name includes an undefined expression such as my_file_%a%b%c.pdf, the
file is created as named my_file_%a%b%c.pdf.
Note:
You must have BI Administrator or BI Data Model Developer privileges to
access the Diagnostics tab.
3. Select Enable SQL Explain Plan and Enable Data Engine Diagnostic.
From the Home page, under Browse/Manage, select Report Job History.
6. Select your report to view the details. Under Output & Delivery click Diagnostic
Log to download the explain plan output.
This chapter describes how to view and manage report jobs submitted to the BI
Publisher scheduler.
This chapter includes the following topics:
• Pausing Jobs
• Resuming Jobs
• Deleting Jobs
• Editing Jobs
• On the global header, click Open, and then click Report Jobs.
To access this page from the context of a specific report perform one of the following:
• From the catalog, navigate to the report in the catalog and then click Jobs.
• From the Report Viewer page, click Actions and then click Jobs.
The following image shows the Manage Report Jobs page:
• View future scheduled and recurring jobs for your private, shared, and public
reports.
• Select the time zone to in which to view the job times displayed.
• Report Name - the name of the report from which you launched the Manage
Report Jobs page
1. Enter values for the Filter criteria to search for a specific job or group of jobs.
2. Click Search. The jobs that meet the filter criteria are displayed in the Report Jobs
table.
The table displays general information about the job as well as the status.
Sort the table by a particular column by clicking the column heading and selecting
the up arrow or down arrow for ascending or descending.
Possible status values are:
• Paused - the job is suspended. The report job does not run again until it has
been resumed. Paused jobs are displayed when searching for Suspended jobs
using the filter criteria.
2. Click the Refresh button. The Report Jobs table refreshes and displays job start and
end times in the selected time zone.
1. Click the Report Job Name to view a detail page for the job.
2. To view delivery information for each output, click the expand icon next to the
output name.
Pausing Jobs
The Manage Report Jobs page enables you to take actions on the jobs. You can access
this page and then search for the report jobs to change the status to Pause.
1. Select the job by clicking anywhere in the table row that lists the job information.
Do not click the job name link. You can select multiple jobs by pressing Ctrl
+Shift and then clicking the additional rows. Deselect a row by clicking it again.
Resuming Jobs
Use these steps to change the status of the job to active.
1. Select the job by clicking anywhere in the table row of the paused job.
Do not click the job name link. You can select multiple jobs by pressing Ctrl
+Shift and then clicking the additional rows. Deselect a row by clicking it again.
Deleting Jobs
Use these steps to delete a job.
1. Select the job by clicking anywhere in the table row that lists the job information.
Editing Jobs
Use these steps to edit a job using the Edit icon from the Manage Report Jobs page.
• Click the Edit icon for the job in the results table.
• Click the Report Job Name to view the detail page for the job and then click the
Edit icon next to the job name.
2. Edit the job details using the General, Output, Schedule, and Notification tabs.
3. Click Update Job to save your changes to this job or, to save the edited job as a new
job, click Submit as New and enter a name for the new job.
• To refresh the Manage Report Jobs page, click the Refresh button at the top of the
page.
This chapter describes the BI Publisher job history features including republishing
data from history, sending the job output to new destinations, and getting error
information on report jobs that did not complete successfully.
This chapter includes the following sections:
• From the Home page, under Browse/Manage click Report Job History.
• On the global header, click Open, and then click Report Job History.
To access this page from the context of a specific report perform one of the following:
• From the Catalog: Navigate to the report in the catalog and then click Job History.
• From the Report Viewer, click Actions and then click Job History.
The image shows the Report Job History page.
• View the status and details of running and completed report jobs.
• Download or view the XML data produced from the report, if you selected Save
Data for the report.
• Republish the report data using other formats or templates, if you selected Save
Data for the report.
• Report Path - equals the path to the report from which you launched the Report Jobs
History page
• Scope - equals All Histories includes all of the possible values for scope are Public
and Private job histories.
• Status - equals All includes all of the possible values for status are Success, Failed,
Running, Has output errors, Canceled, Cancelling, Has delivery errors, and
Skipped.
Use the following procedure to further filter the results.
1. Enter values for the Filter criteria to search for a specific job history or group of
completed report jobs. You can filter the results based on the following:
• Report Job Name - the name assigned to the job when it was submitted.
• Report Path - the path to the report. If the report resides under Shared Folders,
do not include Shared Folders in the path. If the report resides under My Folders,
the first node is (~) and your user name. For example, if you are logged in as
Administrator and the report resides under My Folders/Operational
Reports, enter ~Administrator/Operational Reports.
• Start Processing - the date and time at or after which the request started
processing.
• End Processing - the date and time at or before which the request ended
processing.
2. Click Search. The jobs that meet the filter criteria are displayed in the Report Job
Histories table.
The table initially displays 33 matching records. This number is displayed in the
upper right corner of the table. Move the vertical scroll bar down to the lowest
point to fetch 33 more records. The number displayed in the upper right corner
updates to inform you of the number of records that have been fetched so far. You
can continue fetching more records to the table in increments of 33 by moving the
scroll bar down.
You can sort the table by a particular column by clicking the column heading and
selecting the up arrow or down arrow for ascending or descending.
1. Click the Report Job Name to view a detail page for the job.
2. To view delivery information for each output, click the expand icon next to the
output name.
For the data to be available, the Save Data for Republishing option must be enabled
when the job is created. For information on setting this option, see Setting Output
Options.
1. Click the Report Job Name to view the detail page for the job.
2. From the Output & Delivery region, click the XML Data download button.
1. Click the Report Job Name to view the detail page for the job.
2. From the Output & Delivery region, click Republish. This launches the Report
Viewer.
3. From the Report Viewer you can now apply a new layout, choose a different
output type or export the report. Because you are using data the retrieved from the
previous report run, any parameters are not updatable.
4. To return to the Report Job History page, click the Actions menu and select Return.
Note:
The send functionality does not create any history nor does it save the
delivery status. It simply sends the output to the destination selected.
1. Click the Report Job Name to view the detail page for the job.
2. From the Output & Delivery region, locate the output that you want to send to a
new destination and click Send. This launches the Send dialog.
3. Select the delivery type and click Add Destination. Enter the appropriate fields for
your delivery type.
Note:
The status does not automatically update while you are viewing the page. To
check for updates to the status, refresh the page.
1. Click anywhere within the table row for the report job to select it (except the job
name link). You can select multiple jobs by pressing Ctrl + Shift and then clicking
the additional rows. Deselect a row by clicking it again.
You can only cancel a job that has the status, Running.
2. Click the Cancel Running Jobs icon at the top of the table,
The image shows the Report Job Histories page with a cursor pointing to the cancel
icon.
For more complete diagnostic information on errors or warnings, you can view the
diagnostic log files for the job in Oracle Fusion Middleware Control.
For details, see Viewing Log Messages in Administrator's Guide for Oracle Business
Intelligence Publisher.
1. Click anywhere within the table row for the report job to select it.
• To refresh the Report Job History page, click the Refresh button at the top of the
page.
This chapter describes how to manage the report components in the BI Publisher
folders. It includes setting permissions, downloading and uploading reports and
folders, and moving report components in the catalog.
This chapter includes the following sections:
Note:
You can also save reports in shared folders where other users or groups can access
them. User permissions determine which folders are available to which users.
Permissions are assigned at the object-level and determine who can view, edit, and
schedule reports within that folder. Your administrator creates and maintains the
shared folder structure.
• Folders
• Reports
• Data Models
• Style Templates
• Sub Templates
3. In New Folder, enter the folder name and enter a description (optional).
4. Click Create.
• By selecting the object and choosing the task from the Tasks region.
The image shows the Catalog page.
Your access to these actions depends on the permissions granted to you by your
administrator.
Task options include the following:
Note: You can only paste one Copy_of_ item in the same location. Update the
name before pasting additional copies of the same object.
• Cut - cuts the item from the current location. To paste the object in a different
folder, navigate to the folder location and click Paste to place the item in the
desired folder.
• Download - creates an archive file of the object that you can save to a selected
location. See Downloading and Uploading Catalog Objects.
• Customize - use this option only when your enterprise has implemented a
customized process that includes the use of the Custom folder. For more
information, see About Customizing Reports in Report Designer's Guide for Oracle
Business Intelligence Publisher.
Folders also include the following tasks:
• Upload - uploads an archived object to the folder. For more information, see
Downloading and Uploading Catalog Objects.
Folder .xdrz
Report .xdoz
Subtemplate .xsbz
This function enables administrators to export an XLIFF file that contains the
translation strings the selected catalog object or group of objects. The XLIFF strings can
then be translated to the desired target language. After the XLIFF file is translated, the
administrator can import the XLIFF file back to the catalog and assign it the
appropriate locale.
For more information, see Adding Translations for the BI Publisher Catalog and
Reports in Administrator's Guide for Oracle Business Intelligence Publisher.
This appendix provides information about how to use Oracle BI Publisher accessibility
features for report consumers.
This appendix includes the following sections:
• Keyboard Shortcuts
• Keyboard shortcuts that make it easier to navigate content for users with limited or
no ability to use a mouse.
For more information, see Keyboard Shortcuts.
• Content design capabilities that make it possible for content creators to create
content that supports users with accessibility needs.
For more information, see Designing for Accessibility in Report Designer's Guide for
Oracle Business Intelligence Publisher.
1. Press Tab multiple times to navigate through the global header until the focus is on
your user name in the Signed In As area.
4. Press Tab to navigate through the fields on the General tab until you reach the
Accessibility Mode options.
• The Home page does not contain links for accessing the Administration page or for
performing most editing functions.
• Graphs and map views are not displayed but are instead converted to one or more
annotated tables.
• Tables and pivot tables are rendered with appropriate internal annotations to
enable screen readers to describe the contents of cells.
• You cannot use the mouse to modify the layout of a table or pivot table.
By default, Oracle BI Publisher does not use accessibility mode. Each user can decide
whether to enable accessibility mode during sign in as described in Signing In Using
Keystrokes or after sign in by using the following procedure.
2. To change the language that BI Publisher uses for the Sign In page, press Tab to
place the insertion point in the Language field and use the arrow keys to select the
desired language. The insertion point is then placed in the User ID field.
3. Enter the ID and press Tab to place the insertion point in the Password field.
6. Press Shift+Tab twice to place the insertion point on the Sign In button, then
press Enter to activate the Sign In button.
2. Press CTRL+ALT+G to display the Skip to Content link in the upper-left corner of
the Home page.
• ENTER on this link to navigate to the default starting location on the Home
page, which is the first link in the upper-left corner under the global header.
4. Continue to press TAB to navigate through the elements on the Home page.
• Document title.
• Header level property to specify the order in which the table header rows are read
in accessibility mode.
For more information, see Designing for Accessibility in Report Designer's Guide for
Oracle Business Intelligence Publisher.
Keyboard Shortcuts
Oracle BI EE and BI Publisher support standard keyboard shortcuts. The table lists the
shortcuts and the actions.
Both Oracle BI EE and BI Publisher support standard keyboard shortcuts that are used
in many software applications. In addition, both components offer shortcuts to
perform tasks that are specific to those components. The general keystrokes table
describes general keyboard shortcuts for use with Oracle BI EE and BI Publisher.
The table below describes keyboard shortcuts for navigating reports in BI Publisher.
CTRL + Up or Down Arrow Shows the next or previous item in a combo box.
Note:
If you use Freedom Scientific JAWS or other screen reader programs, then you
must first disable the virtual PC cursor before using the keystroke
combinations to navigate the report. You must enable the virtual PC cursor at
other times, including during navigation within table objects on a report.