4 Create Pixel-Perfect Report Jobs

This topic describes how to create and monitor pixel-perfect report jobs. You can schedule report jobs to run at defined intervals and deliver reports to multiple destinations.

Navigate to the Schedule Report Job Page

Navigate to the Schedule Report Job page to schedule a report job.

  1. Navigate to the Report Job page from the Home page, the catalog, or the Report Viewer.
    • From the Home page, under Create, select Report Job.
    • 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.

Set General Options

Use the General tab to enter the general information in the table for a report job.

  1. Select the General tab.
  2. Enter the following information for the report job.
    • 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.

Set Output Options

The Output tab has two regions: Output and Destination. Each scheduled job can have multiple output files with distinct characteristics. Each output file can have multiple destinations.

To set the output options for a report job:
  1. Select the Output tab.
  2. Select the output options.
    Option Description

    Use Bursting Definition to Determine Output and Delivery Destination

    Enable this option to use the report bursting definition for output and delivery. Once selected, all other fields on this page are disabled for selection. This option is only available when bursting is enabled for the report.

    Make Output Public

    Enable this option to make this job output available to all users with permission to access this report. Users with access can view the report from the Report Job History page.

    Save Data for Republishing

    Enable this option to save the XML data that is generated for this job. Access the saved data from the Report Job History page where you can republish it, selecting a new layout and output options.

    Compress output prior to delivery

    Enable this option to compress each report (all report formats except HTML) before delivery. The format for the file name of each compressed report is Name_Output Format.zip. For example, if the delivery destination is email for Order.pdf and Invoice.xlsx reports, the order_PDF.zip and Invoice_XLSX.zip reports are attached to the email.

    Supports email, HTTP, Content Server, and Documents Cloud Service (Oracle Content and Experience Cloud) delivery channels.

    In the Report Job History page, if you view the details of a job that was configured with the Compress output prior to delivery option, and then click Send in the Output & Delivery section, the delivered output isn’t compressed.

Add Destination Types to Report Output

Enter delivery details in the report’s Destination region to deliver a report to multiple destinations.

Administrator must set up the delivery servers in the Administration page.
  1. From an existing report in the Report Viewer, select Actions, and then select Schedule.
  2. In Schedule Report Job, click the Output tab.
  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.
  5. Click Add Destination to deliver a report document to multiple destinations.
  6. Select Save Output to view the output from the Report Job History page.

Report Output Destination Types

Select and define the destination types for your report’s output in the Schedule Report Job page.

Only the destination types configured by the administrator are available for selection. You can add multiple destinations for the report’s output.

Destination Type Description
Email

Enter multiple email addresses separated by a comma. Enter any Message text to include with the report.

To format the message text, you can use HTML 4 elements such as fonts, lists, table cells, hyperlinks, and embedded GIF images.

Printer

Select the Printer Group and the Printer, enter the Number of copies, and select Single sided or Double sided, the printer must support duplex printing for this option to take effect. Optionally select the printer Default Tray from which to print the report, and the Print Range pages.

Fax

Select the Fax Server to deliver the report and enter the Fax Number to which to send the report.

FTP

Skip the username and password fields to use the FTP delivery settings configured by the administrator. Only if you want to override the configuration of the FTP server and use password-based authentication, enter the valid username and password credentials for the FTP server.

Specify the following properties:

  • Remote Directory

    (Required) Enter the delivery directory location, for example, /pub/.

    To deliver the document to the user's home directory, enter . (period).

  • Remote File Name

    (Required) Enter the file name for BI Publisher to assign to the delivery document on the remote server, for example, myreport.pdf.

    You must include the file extension in the name, for example, .pdf.

    To assign a file name dynamically using a date expression, see Defining a Destination File Name Dynamically Using a Date Expression.

  • Select Use Secure FTP to send the output using the Secure FTP protocol.

Web Folder

After selecting Web Folder , enter valid Username and Password credentials.

Remote Directory - enter the directory to which to deliver the document, for example, /pub/. If a value is not entered, then the document is delivered to the login directory.

Remote File Name - enter the file name for BI Publisher to assign to the delivery document on the remote server, for example, myreport.pdf.

To assign a file name dynamically using a date expression, see Define a Destination File Name Dynamically with a Date Expression.

Content Server

Select Content Server to limit access to the report on the content server, assign a Security Group and Account to the report. Oracle BI Publisher retrieves the Security Group and Account values from the Administrator specified content server.

See Content Server Destination Type Properties.

Document Cloud Services

Select the ODCS Server and the destination Folder Name.

Content Server Destination Type Properties

Content Server is one of the destination types to deliver your report document. Select the content server where you want the report delivered.

Use the information in this table to enter appropriate values for the Content Server properties.

Property Name Description
Security Group (Optional) Select the WebContent Server security group to assign to the report.
Account (Optional) Select an Account within the Security Group to assign to the report.

You can enter values for the following required metadata fields. If you don't enter values for these fields, the values from the default report information apply.

Author (Optional) enter a value for Author. If you don't enter an Author, your user name is used for the Author metadata field on the WebContent Server.
Title (Optional) Type a Title for the report. If you don't enter a Title, the Layout name is used for the Title on the WebContent Server.
File Name Enter the file name to assign to the delivered document on the remote server, for example, myreport.pdf. The File Name field is used as the Native File Name on the WebContent Server. If you don't supply a file name value, the Output name is used.
Comments (Optional) Type a description to include with the document on the WebContent Server.
Include Custom Metadata The Include Custom Metadata option is only available if the data model for the report includes a Custom Metadata component. When you select the Include Custom Metadata option, the delivered document includes the custom metadata fields specified in the data model.

When you can configure an embedded parameterized report to display online, the parameters display the appropriate values from an analysis or a direct connection to a subject area. When you schedule a an embedded parameterized report, the parameters from the analysis aren't passed to the report. As a result, the report displays default values of the parameters used in the analysis. For a direct connection with a scheduled report, the parameters are passed and the values are displayed correctly in the report.

Add Outputs

You can create multiple report documents for one or more layouts using a combination of output format, locale, time zone, and calendar.

  1. From an existing report in the Report Viewer, select Actions, and then select Schedule.
  2. In Schedule Report Job page, click the Output tab.
  3. In the Output tab, click + to add an output.
  4. In Name, type a name for the output.
  5. Select the options to use from the Layout, Format, Locale, Timezone, and Calendar lists.

    The 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 defaults to the Report Locale defined in the user Preferences. If the layout doesn't have an available translation for the selected locale, BI Publisher applies a locale fallback logic to select the layout. The appropriate number and date formatting are applied independently of the template translation.

    The time zone defaults to the time zone defined in the user Preferences.

  6. Click Save Output.

Define the Schedule for a Job

You can define a schedule for executing a report job.

  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.
  4. In Schedule Report Job, click the Schedule tab.
  5. In the Frequency list, select the option to use for this report.
  6. Complete the options for the specified frequency.
  7. Click Submit.
  8. Optional: In Submit, in the Report Job Name field, type a name, and click OK.

Define a Recurrence Pattern

In the Schedule Report Job page’s Schedule tab, define the when the report is run from these recurrence pattern options.

Option Description Values
Frequency

Defines when to run the report job using the scheduler from the Frequency list.

NA

Frequency

Once

Use the Run Now option or use the date selector to enter the specific Start date and time

Frequency

Hourly/Minute

Use the following values:

  • 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.

Frequency

Daily

Use the following values:

  • 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 run.

  • End - (Optional) Use the date selector to enter an end date and time for this job.

Frequency

Weekly

Use the following values:

  • 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, in the Schedule tab, select Frequency = Daily, Every =14, Start = first Wednesday when you want to run the report, and End = future end date.

  • 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 processed for each run.

  • End - (optional) Use the date selector to enter an end date for this job.

Frequency

Monthly

Use the following values:

  • Every - Select each month that the job runs.

  • 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 processed for each run.

  • End - (Optional) Use the date selector to enter an end date for this job.

Frequency

Annually

Use the following values:

  • Every - Enter the increment in years that the job runs.

  • On - Select either a day in a month, for example, Day 1 of January, or select a day of the week for 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 processed for each run.

  • End - (Optional) Use the date selector to enter an end date for this job.

Frequency

Specific Dates

Use the Add Date option to specify the date and time to run the job. Add multiple specific dates as needed.

Run Now

This option depends on the selection made from the Frequency options.

NA

Start

This option depends on the selection made from the Frequency options.

Specifies the date and time to start the report job.

NA

Use Schedule Triggers

You can associate a schedule trigger that is defined in any data model.

One trigger per report job is supported. A report runs even if trigger in not defined in the report’s data model.

Enable a Schedule Trigger

You can enable a trigger defined in the data model.

  1. Select Use Trigger.
  2. Optional: Set the Retry Limit value to specify the maximum number of times to process 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-processing 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.

    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.
  5. Select the trigger from the list.
  6. If the schedule trigger includes parameters, select values as appropriate.

Configure Notifications

You can configure email and HTTP notifications.

A notification is a message that a job has finished processing. Oracle BI Publisher supports the following notification statuses:

  • Report completed

  • Report completed with warnings

  • Report failed

  • Report skipped

Administrator must configure the delivery email servers and HTTP servers in the Administration Delivery Configuration page.

  1. Select the Notification tab.
  2. To enable email notification, perform these steps:
    1. For Notify By, select Email.
    2. Select the report completion statuses for which to send the notification.
    3. Enter a comma-separated list of addresses.
  3. To enable HTTP notification, perform these steps:
    1. For Notify By, select HTTP.
    2. Specify the HTTP server to which to send the notification.
    3. Specify the user name and password for the HTTP server, if required.
    4. Select the report completion statuses for which to send the notification.

Submit and Monitor a Job

Use the Submit Job dialog to review the confirmation details of the job.

  1. Select Submit to invoke the Submit Job dialog with confirmation details for you to review.
  2. Enter a name for this job and click Submit.
  3. Optional: On the global header, click Open and then click Report Jobs to suspend, edit, or delete a job.
  4. Optional: On the global header, click Open and then click Report Job History to monitor a running job or to see the results.

Create a Job from an Existing Job

You can create a job from an existing job in the Manage Report Jobs page.

  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.

Create a Bursting Job

You can create a bursting job if the report is configured for bursting.

Bursting is splitting of the report data into multiple blocks based on a key field in the data and then applying specific parameters for the layout and delivery for each block of data. For example, a customer invoice report can be burst to deliver each customer's invoice to their own email address.

You must configure the bursting definition for a report in the report's data model.

  1. Make sure the report is enabled for bursting.
  2. From the Oracle BI Publisher Home page, under Create, select Report Job.
  3. Select the Use Bursting Definition to Determine Output & Delivery Destination box on the Output tab.

Advanced Topics

You can increment date parameters and dynamically define a destination file name.

Increment Date Parameters

You can provide expressions in the report's date parameter fields.

If the scheduled report includes date parameters, when you enter values for the schedule dates, you can't change the date values. Every time a scheduled instance of the report is run, the same date parameters are used. 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 runs.

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.

  • {$FIRST_DAY_OF_MONTH()$} - First day of the current month

  • {$LAST_DAY_OF_MONTH()$} - Last day of the current month

  • {$FIRST_DAY_OF_YEAR()$} - First day of the current year

  • {$LAST_DAY_OF_YEAR()$} - Last day of the current year

The date function calls in the parameter values aren't evaluated until the report job is processed by the Scheduler.

You can also enter expressions using the plus sign (+) and minus sign (-) to add or subtract days as follows:

  • {$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:

  • Date From: {$SYSDATE()-7$}

  • Date To: {$SYSDATE()-1$}

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.

Define a Destination File Name Dynamically with a Date Expression

When entering the remote file name for a Web folder or FTP destination, you can enter a date expression to dynamically include a date expression in the file name. The date is set at runtime, using the server time zone.

The date expressions are described in the following table.

Expression Description

%y

Displays the year in four digits: Example: 2011

%m

Displays the month in two digits: 01-12 (where 01 = January)

%d

Displays the date in two digits: 01-31

%H

Displays the hour in two digits based on 24-hour day: 00-24

%M

Displays the minute in two digits: 00 - 59

%S

Displays the number of seconds in two digits: 00 - 59

%l

Displays milliseconds in three digits: 000 - 999

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.