7Reports Modification

This chapter contains the following:

Overview of Business Intelligence Publisher

Oracle Business Intelligence (BI) Publisher enables you to author, generate, and deliver all types of highly formatted documents and operational reports. You can use familiar office desktop tools to create rich text format (.rtf) documents and reports against any data source. You can view reports, schedule them to run, and distribute them to predefined destinations.

A BI Publisher report consists of one or more .rtf layouts, a reference to a data model, and a set of properties. A report may also include style templates and subtemplates, which allow reusability of functionality and maintain consistency of design. In the logical architecture depicted in the figure, the report includes a data model and a layout, and the layout references two style templates in the catalog which in turn reference subtemplates.

In the BI Publisher logical architecture, the data model accesses data sources and the layout and its optional style template and subtemplates determine the formatting of the report output, which can include email, print, fax, or files, and others. The layout is designed using common office applications, for example Microsoft Word and Excel and Adobe Acrobat and Flash, among others.

BI Publisher logical architecture

Style Templates

A style template is a .rtf template that contains style information that can be applied to report layouts.

A style template is a .rtf template that contains style information that can be applied to report layouts at runtime to achieve a consistent look and feel across your enterprise reports. You associate a style template to a report layout in the report definition. Using a style template has the following benefits:

  • Enables the same look and feel across your reports

  • Enables consistent header and footer content, such as company logos, headings, and page numbering

  • Simplifies changing elements and styles across all reports

Use style templates to define paragraph and heading styles, table styles, and header and footer content.

Paragraph and Heading Styles

When the named style is used in a report layout, the report layout inherits the following from the style template definition:

  • font family

  • font size

  • font weight (normal, bold)

  • font style (normal, italic)

  • font color

  • text decoration (underline or strike through)

Table Styles

Style elements inherited from the table style definition include:

  • font style

  • border style

  • line definition

  • shading

  • text alignment

Header and Footer Content

The header and footer regions of the style template are applied to the report layout. This includes images, dates, page numbers, and any other text-based content. If the report layout also includes header and footer content, then it is overwritten.

Subtemplates

A subtemplate is a piece of formatting functionality in .rtf or .xsl format that can be defined once and used multiple times within a single layout template or across multiple report layout template files. Rich Text Format (RTF) subtemplates are easy to design using native features in Microsoft Word, while subtemplates using Extensible Stylesheet Language (XSL) can be used for complex layout and data requirements. Both .rtf and .xsl subtemplates are stored in the business intelligence catalog as a subtemplate object, and both can be called from .rtf layout templates.

Some common uses for subtemplates include:

  • Reusing a common layout or component (such as a header, footer, or address block)

  • Handling parameterized layout

  • Handling dynamic or conditional layouts

  • Handling lengthy calculations or reusing formulas

RTF Subtemplates

An RTF subtemplate is an RTF file that consists of one or more <?template:?> definitions, each containing a block of formatting or commands, that when uploaded to Business Intelligence (BI) Publisher as a subtemplate object in the catalog can be called from within another RTF template.

XSL Subtemplates

An XSL subtemplate is an XSL file that contains formatting or processing commands in XSL for the Business Intelligence Publisher formatting engine to execute. Use an XSL template to include complex calculations or formatting instructions not supported by the RTF standard.

How You Create and Edit Reports

Use reports to generate and print documents for internal operations, external business transactions, or legal requirements. To meet specific requirements, you must create or edit reports to capture different data, or present data in another way.

Report Components

Each report has components that you can modify, as described in this table:

Report Component Description Tool for Modifying

Data model

Defines the data source, data structure, and parameters for the report. Multiple reports can use the same data model. Each report has one data model.

Data model editor in the application

Layout

Defines the presentation, formatting, and visualizations of the data. A report can have multiple layouts. Different types of layout templates are available, for example Excel and RTF.

Depending on the template file type:

  • XPT: Layout editor in the application

  • RTF: Microsoft Word

  • PDF: Adobe Acrobat Professional

  • Excel: Microsoft Excel

  • eText: Microsoft Word

Properties

Specifies formatting and other settings for the report.

Report editor in the application

What You Can Create or Edit

This table gives just a few examples of creating or editing reports.

Task Example

Edit the layout of a report.

Add your company logo to the report output.

Add a new layout to a report.

Design a new layout template that provides less detail than the existing template.

Edit a data model.

Add two fields to the data model used by a report so you can add those new fields to a layout for the report.

Create a new report based on a new data model.

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

How You Access and Modify Report Components

To create or edit reports, you must access the business intelligence (BI) catalog. In the catalog, objects of type Report represent the report definition, which includes report properties and layouts. Data models are separate objects in the catalog, usually stored in subfolders called Data Models.

Accessing the BI Catalog

You can access the BI catalog in any of the following ways:

  • In the Reports and Analytics work area, click Browse Catalog to open the BI catalog, and find your report or data model in the Folders pane.

  • In the Reports and Analytics work area, find your 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 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 work area, change the final node of the URL. For example, change (http://host:port/analytics/saw.dll) to xmlpserver. So the URL you use would be: http://host:port/xmlpserver.

Predefined Reports

A special Customize option is available only:

  • For predefined reports, not data models.

  • Through direct access to the BI Publisher server using the /xmlpserver URL. When you find your report in the BI catalog, select Customize from the More menu.

The Customize option automatically creates a 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 copied version.

If you don't have access to the Customize option or don't want the original version linked to the new report, make a copy of the predefined report and save it in the Custom folder.

Predefined Data Models

Don't edit predefined data models. Instead, copy the data model into the Custom folder and edit the copy. You can't create a new data model based on the transactional tables.

How You Modify Copies of Predefined Reports

The Customize option automatically creates a copy of a predefined report and stores it in the Shared Folders > Custom within the business intelligence (BI) catalog. The copy includes the report definition, folder structure, and original report permissions, and is linked internally to the original report. You can edit the copy of the report, leaving the original report intact. When users open or schedule the original report, they are actually using the newer version.

Benefits of the Customize Option

In addition to conveniently copying a predefined report to the Custom folder, the Customize option:

  • Makes it unnecessary to update processes or applications that call the report. For example, if the original report is set up to run as a scheduled process, you don't need to change the setup. When users submit the same scheduled process, the newer report runs instead of the original.

  • Automatically copies the security settings of the original report.

  • Removes the risk of patches overwriting your edits. If a patch updates the original report, the newer report is not updated in any way.

    Note: The report still references the original data model. The data model is not copied. A patch that updates the data structure of the data model might affect your report.

Accessing the Customize Option

To access the Customize option:

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

  2. In the Folders pane, select the predefined report.

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

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

To edit the copied report again later, you don't need to be in the BI server. Just go to the BI catalog and either:

  • Select the Customize option for the original report.

  • Find your report in the Custom folder and select Edit.

How Links Between Original and Modified Reports Are Managed

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

Maintaining the Link Between Reports

The link between the predefined and modified report is based on the name of the modified report and its location within the Custom folder in the business intelligence (BI) catalog.

  • If you manually create a report with the same name as a predefined report, and give it the same folder path in the Custom folder, then the new report becomes a version of the original. It would be as if you had used the Customize option to create a copy of the predefined report.

  • You can edit the report so that it uses a different data model. But if the original data model is updated later, then your newer report doesn't benefit from the change.

Caution: The link to the original report breaks if you rename the modified or original report.

Tasks Performed on Original Reports

This table describes what happens when you use the original report and a corresponding copied report exists.

Task Performed on the Original Report Result When There Is a Copied Report

Open

Opens the copied report.

Schedule

Creates a report submission for the copied report.

Edit

Edits the copied report.

Copy

Copies the original report.

Download

Downloads the copied report.

Customize

Edits the copied report.

History

Opens the job history of the copied report.

Layouts

Create and Edit Report Layouts

The layout determines what and how data is displayed on report output. Each report has at least one layout template. This topic describes the following aspects of report templates:

  • Layout templates

  • Layout template types

  • Overall process of managing layouts

  • Deleting layout templates

Layout Templates

To modify a layout, you edit the layout template, which:

  • Defines the presentation components, such as tables and labeled fields.

  • Maps columns from the data model to these components so that the data is displayed in the correct place.

  • Defines font sizes, styles, borders, shading, and other formatting, including images such as a company logo.

Layout Template Types

There are a few types of template files to support different report layout requirements.

  • RTF: Rich text format (RTF) templates created using Microsoft Word.

  • XPT: Created using the application's layout editor, these templates are for interactive and more visually appealing layouts.

  • eText: These templates are specifically for Electronic Data Interchange (EDI) and electronic funds transfer (EFT) information.

You can also create and edit other types of templates using Adobe PDF, Microsoft Excel, Adobe Flash, and XSL-FO.

Overall Process to Create or Edit Layouts

Editing or creating report layout, for example using Microsoft Word or the layout editor, involves making the actual changes to the template file. But that task is just one part of the entire process for modifying layouts.

  1. Copy the original report and save the new version in Shared Folders > Custom in the business intelligence (BI) catalog. You create or edit templates for the new copy of the report.

    Tip: You can use the Customize option if the original is a predefined report.
  2. Review report settings for online viewing.

  3. Generate sample data for the report.

  4. Edit or create the layout template file.

  5. Upload the template file to the report definition. Skip this step if you're using the layout editor.

  6. Configure the layout settings.

Deleting Layout Templates

To remove a layout template for a report:

  1. Select your report in the BI catalog and click Edit.

  2. In the report editor, click View a list.

  3. Select the layout template and click Delete.

Make Reports Available for Online Viewing

Some reports are set up so that you can only view them through another application or submit them as scheduled processes. To view your report online while you're editing it, you must define a few settings. When you're done editing your report, make sure that you reset these settings as needed.

Updating Report Properties

  1. Select your report in the business intelligence catalog and click Edit.

  2. In the report editor, click Properties.

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

Updating Layout Settings

  1. Back in the report editor, click View a list.

  2. Make sure that the View Online check box is selected.

Generate Sample Report Data

Depending on the type of report layout changes you're making, sample data can be required or optional. You generate sample data, and then load it for use with your layout so that you can map data fields to layout components. For example, for the Start Date table column in your layout, you can set it so that the data displayed in that column comes from the Start Date field in the sample data.

You can generate sample data from the:

Generate Sample Data from the Data Model

Follow these steps:

  1. Select your data model in the business intelligence (BI) catalog and click Edit. Alternatively:

    1. In the catalog, find the report to generate sample data for and click Edit.

    2. Click the data model name in 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're designing a .rtf template, click Export to save the file locally.

  5. Save the data model.

Save Sample Data from the Report Viewer

For reports that are enabled for online viewing, you can save sample data from the report viewer:

  1. Select the report in the BI 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.

Save Sample Data from the Scheduler

For reports that are enabled for scheduling (not necessarily as a scheduled process), you can save sample data from the scheduler:

  1. Select the report in the BI catalog.

  2. Click Schedule.

  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. Select your report job name in the Job Histories table.

  9. On the details page, in Output and Delivery, click the XML Data Download icon button.

Layout Templates

Create and Edit Report Layout Templates Using the Layout Editor

The layout editor in the application provides an intuitive, drag-and-drop interface for creating pixel-perfect reports with PDF, RTF, Excel, PowerPoint, and HTML output. The layout template files you create with this tool have an .xpt extension. The layout editor tool is the only editing tool that provides dynamic HTML output. Users can interact with this output in a browser, for example by sorting, applying filters, and so on.

Prerequisite

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

Using the Layout Editor

To create or edit XPT templates:

  1. Select the report in the business intelligence (BI) catalog and click Edit.

  2. In the report editor, click Edit to update a template.

    Or, click Add New Layout and select a template type in the Create Layout section.

  3. Create or edit the layout.

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

Set Up for RTF and Excel Report Layout Templates

You can use Microsoft Word or Microsoft Excel to create or edit RTF and Excel layout templates, in addition to the layout editor in the application. If you use Word or Excel directly, you must download and install the appropriate add-in so that the Microsoft application has the features you need to design report layouts.

Note: If you're designing a new layout for your report, consider using the layout editor instead unless you are an experienced layout designer.
Installing the Add-In

  1. Open the Reports and Analytics work area.

  2. Click the Browse Catalog button.

  3. Click Home.

  4. In the Get Started pane, click Download BI Desktop Tools.

  5. Select the add-in for the type of template you're working with.

    • Template Builder for Word: RTF templates

    • Analyzer for Excel: Excel templates

  6. Save and then run the installer.

Protecting Reports by Using Passwords

You can assign a password to your report and protect it from unwanted access. You can do this by setting the runtime properties at the server level using the Runtime Configuration page. The same properties can also be set at the report level, from the report editor's Properties dialog. If different values are set for a property at each level, then report level takes precedence.

The following table describes the properties you can use to set passwords for reports in different formats.

Report Format Property Name Description Default Configuration Name

DOCX output

Open password

Use this property to specify the password that report users must provide to open any DOCX report.

NA

docx-open-password

PPTX output

Open password

Use this property to specify the password that report users must provide to open any PPTX report.

NA

pptx-open-password

XLSX output

Open password

Use this property to specify the password that report users must provide to open any XLSX output file.

NA

xlsx-open-password

Create and Edit RTF Report Layout Templates

An RTF template is a rich text format file that contains the layout instructions to use when generating the report output. Use Microsoft Word with the Template Builder for Word add-in to design RTF templates.

Prerequisites

Install the Template Builder for Word add-in, and generate sample data.

Using Template Builder for Word

To modify an RTF template:

  1. If you are editing an existing layout:

    1. Select your report in the business intelligence catalog and click Edit.

    2. In the report editor, click the Edit link of the layout to download the RTF file.

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

  2. Open the downloaded RTF template file in Microsoft Word. Or, if you're creating a new template, just open Microsoft Word.

  3. Load the sample data that you generated.

  4. Edit or create the layout template.

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

eText Report Layout Templates: Explained

An eText template is an RTF-based report template that is used for Electronic Funds Transfer (EFT) and Electronic Data Interchange (EDI). The template is applied to an input XML data file to create a flat text file that you transmit to a bank or other organizations. Use Microsoft Word to create or edit eText templates.

File Format

Because the output is for electronic communication, not printing, you must follow specific format instructions for exact placement of data on the template. You design eText templates using tables.

  • Each record is represented by a table.

  • Each row in a table corresponds to a field in a record.

  • The columns of the table specify the position, length, and value of the field.

Special Commands

You must set up special handling of the data from the input XML file. This table describes the two levels of handling and where you declare the corresponding commands.

Level Example Setup

Global

Character replacement

Sequencing

Declare global commands in separate setup tables.

Record

Sorting

Declare functions in command rows, in the same table as the data.

Upload the Layout Template File to the Report Definition

If you're creating or editing a report layout using the layout editor, the layout is automatically saved to the report definition, so you can skip this step. For all other layout types, for example RTF, upload the template file to the report definition after you're done making layout changes.

Uploading the Template File

  1. Select your report in the business intelligence catalog and click Edit.

  2. In the report editor, click View a list.

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

  4. Click Upload in Upload or Generate Layout.

  5. In the Upload Template File dialog box:

    1. Enter a layout name.

    2. Browse for and select the layout template file that you created or edited.

    3. Select the template file type.

    4. Select the locale, which you can't change once the template file is saved to the report definition.

    5. Click Upload.

  6. Save the report definition.

Configure Layout Settings for Reports

As part of creating or editing layout, you can set report properties related to layout. These settings determine, for example, which layouts users can choose from when viewing or scheduling the report. The settings apply only to your report.

Setting Layout Properties

  1. Select your report in the business intelligence catalog and click Edit.

  2. In the report editor, click View a list.

  3. Set layout properties, some of which are described in this table.

    Setting Usage

    Output Formats

    Depending on the requirements for a report, you may want to limit the output file formats (for example. PDF or HTML) that users can choose. The available output formats vary depending on the template file type.

    Default Format

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

    Default Layout

    When multiple layouts are available for the report, you must select a default layout to present it first in the report viewer.

    Active

    Active layouts are available for users to choose from when they view or schedule the report.

    View Online

    Select this check box so that layouts are available to users when they view the report. Otherwise, the layout is available only for scheduling the report.

  4. Click Save Report.

New Reports

Create a report when the predefined reports don't provide the data you need. Or, if you want to use a predefined data model, and also want to change other aspects of the report other than layout. Save your report to Shared Folders > Custom in the business intelligence catalog. Saving content in the Custom folder is the only way to ensure that the content is maintained upon upgrade.

Create a Report

  1. Open the Reports and Analytics work area.

  2. Click click New and select Report.

  3. Select the data model to use as the data source for your report.

    Note: Be sure that the data model you select has been validated. If you select a data model that has not been validated or has errors, when the report is run it will error indicating that the data model has not been validated or has an invalid status. To override this warning for a report, select the Ignore Data Model Validation Error option in the report properties.
  4. Continue with the wizard to create the report layout, or choose to use the layout editor and close the wizard.

  5. Define the layout for the report.

  6. Click the Properties button in the report editor to set specific formatting, caching, and processing options for your report, including overriding data model validation errors.

Set Up Access

You or your administrator can:

Change the Branding Logo in a Predefined Project Performance Reporting RTF Report Template

The Update Project Performance Data report layout includes a standard Oracle logo in the report header. You want to replace the Oracle logo with your own logo.

The following table summarizes the key decisions for this scenario.

Decisions to Consider In This Example

What version of Microsoft Word are you using?

Microsoft Word 2007

What image do you want to use as your logo?

O_FusionApps_ProjectPortfolioMgmt_clr.gif

Which data model do you need to download sample report data from?

SummarizationDM

Do you want to preview the changed template?

Yes

Prerequisite

  1. Install the Template Builder for Word add-in, and download sample data (save it locally).

Changing the Logo

To change the logo in the report output:

  1. Select the Update Project Performance Data Execution Report in the BI catalog and click Edit.

  2. In the report editor, click the Edit link of the Update Project Performance Data Execution Report layout to download the RTF file.

  3. Open the RTF file in Microsoft Word.

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

  5. In the template, delete the Oracle logo and the text Fusion Projects and Project Performance Reporting.

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

  7. Select the O_FusionApps_ProjectPortfolioMgmt_clr.gif file and insert it into the Word document.

  8. Resize the image if you need to.

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

  10. In the Oracle BI Publisher tab, in the Preview group, click PDF. You can preview the PDF output that's generated with the sample data that you loaded.

Predefined Reports

Process Output Reports

This topic lists the business intelligence publisher reports available in Oracle Project Portfolio Management. You can use these reports to review your processed data in a predefined format and print them.

The following table lists the available process output reports.

Report Name Report Description Process Name Intended User

Absence Management Transfer Processing Report

Report for the process that loads new, updated, or withdrawn absence records from Oracle Absence Management to Project Execution Management.

Initiate Absence Records Transfer to Oracle Fusion Project Execution

Resource Manager

Accounting and Project Accounting Periods Close Exceptions Report

Report for the processes that close accounting or project accounting periods.

Also displays unprocessed transactions and conditions that prevent the closing of accounting or project accounting periods.

Close Accounting Period

Close Project Accounting Period

Accounting Period Close Exceptions Report

Project Accounting Period Close Exceptions Report

Project Accountant

Grants Accountant

Adjust All Expenditure Items Execution Report

Report for the process that provides a summary of the adjusted expenditure items and adjustment exceptions.

Adjust All Expenditure Items

Project Accountant

Grants Accountant

Import Awards Report

Report for the process that imports awards, award projects, award funding, and other award details from the open interface tables.

Displays the successfully imported awards and award-related objects and the awards that failed the validations.

Import Awards

Project Application Administrator

Project Integration Specialist

Grants Administrator

Import Awards Rejections Report

Report for the process that imports awards, award projects, award funding, and other award details from the open interface tables.

Displays details about the awards that failed the validations.

Import Awards

Project Application administrator

Project Integration Specialist

Grants Administrator

Billing Event Upload Error Report

Report for the process that creates contract billing events in Oracle Project Billing based on the data loaded into the open interface table.

Import Project Billing Events

Project Billing Specialist

Build New Organization Burden Multipliers Execution Report

Report for the process that adds burden multipliers for a new organization to burden schedules after the organization is added to the organization hierarchy.

Build New Organization Burden Multipliers

Project Accountant

Grants Accountant

Change Project and Task Organizations Execution Report

Report for the process that reassigns all projects in one organization to a different organization, or changes the organization on a single project and optionally cascades the changes to the project tasks.

Used particularly when the enterprise is undergoing reorganization.

Change Project and Task Organizations

Business Unit Administrator

Create Periodic Capital Events Execution Report

Report for the process that groups unprocessed assets and costs for capital projects based on the in-service date, expenditure item date, and project, and then associates the groups of unprocessed assets and costs with the event period.

Create Periodic Capital Events

Project Accountant

Grants Accountant

Delete Allocation Transactions Execution Report

Report for the process that deletes all transactions for a draft allocation.

Delete Allocation Transactions

Project Accountant

Grants Accountant

Delete Capitalized Interest Transactions Execution Report

Report for the process that deletes the selected capitalized interest batch that's in draft success status.

Delete Capitalized Interest Transactions

Project Accountant

Grants Accountant

Delete Cost Transactions Report

Report for the process that deletes rejected or all unprocessed project cost transactions in an expenditure batch.

Delete Cost Transactions

Project Accountant

Project Manager

Import Asset and Asset Assignment Execution Report

Report for the process that imports all project assets and project asset assignments. You can generate a summarized or detailed report.

Import Asset Processing

Project Accountant

Generate Group Allocations Report

Report for the process that displays the output of the Generate Group Allocations process.

Generate Group Allocations

Project Accountant

Delete Unreleased Invoices Execution Report

Report for the process that deletes draft, approved, and rejected project contract invoices.

Delete Draft, Approved, and Approval Rejected Invoices

Project Billing Specialist

Grants Accountant

Labor Distribution Cost Execution Report

Report for the process that imports payroll costs to be distributed based on labor schedules.

Displays the payroll costs that succeeded or had exceptions during distribution or were rejected during import.

Import Payroll Costs

Labor Distribution Accountant

Labor Distribution Cost Rejections Report

Report for the process that imports payroll costs to be distributed based on labor schedules.

Displays details about the payroll costs that failed the validations

Import Payroll Costs

Labor Distribution Accountant

Labor Schedules Excel Report

Report for the process that imports project costing labor schedules.

Displays details about the labor schedules that failed the validations.

Import Assignment Labor Schedules

Project Application Administrator

Manage Project Organizations Execution Report

Report for the process that converts all hierarchical lists of organizations specified in the business unit implementation options into flat lists to enhance performance throughout the Project Financial Management application.

Maintain Project Organizations

Project Application Administrator

Generate Borrowed and Lent Amounts Execution Report

Report for the process that creates borrowed and lent distributions for cross-charge transactions within a legal entity.

Generate Borrowed and Lent Amounts: Generate Output Report

Project Accountant

Grants Accountant

Export Invoice Data Report

Report for the process that exports released project contract invoice details to third-party receivables applications.

Export Invoice Details

Project Billing Specialist

Export Revenue Data Report

Report for the process that exports project contract revenue distributions to third-party general ledger applications.

Export Revenue Details

Project Billing Specialist

Federal Financial Report

Federal report that tracks the summary transactions for an award, the amount spent or received, and the outstanding obligation amount.

Generate Federal Financial Report

Grants Administrator

Oracle Fusion Projects Coexistence Cross-Charge Data Report

Report for the process that extracts cross-charge distributions for accounting in third-party applications. The export status of such cross-charge distributions is updated in the application.

Extract Cross-Charge Distributions for External Accounting

Project Accountant

Oracle Fusion Projects Coexistence Data Output Report

Report for the process that extracts cost distributions for accounting in third-party applications. The export status of such cost distributions is updated in the application.

Extract Cost Distributions for External Accounting

Project Accountant

Generate Allocations Execution Report

Report for the process that generates an allocation for the specified allocation rule.

Generate Allocations

Project Accountant

Grants Accountant

Generate Asset Lines Execution Report

Report for the process that creates summarized asset lines for capital assets and retirement adjustment assets based on the asset line grouping method defined for the project.

Generate Asset Lines

Project Accountant

Grants Accountant

Generate Burden Costs Execution Report

Report for the process that summarizes burden costs for expenditure items and then creates and processes separate expenditure items for burden costs.

Generate Burden Costs

Project Accountant

Grants Accountant

Generate Capitalized Interest Transactions Execution Report

Report for the process that calculates capitalized interest and generates transactions for eligible projects and tasks.

Generate Capitalized Interest Transactions

Project Accountant

Grants Accountant

Generate Financial Plan Amounts Execution Report

Report for the process that generates working versions of budgets or forecasts based on existing financial or project plans.

Generate Financial Plan Amounts

Project Manager

Generate Invoices Execution Report

Report for the process that creates invoices for project contract customers according to contractual terms.

Generate Invoices

Project Billing Specialist

Grants Accountant

Generate KPI Values Execution Report

Report for the process that generates KPI values and determines overall project health status.

Generate KPI Values

Project Manager

Generate Revenue Execution Report

Report for the process that recognizes project contract revenue according to contractual terms by creating revenue distributions.

Generate Revenue

Project Accountant

Grants Accountant

Grants Personnel Import Report

Report for the process that imports grants personnel and related data. Displays the list of details for the rejected and successfully imported grants personnel and related data.

Import Grants Personnel

Project Application Administrator

Project Integration Specialist

Grants Personnel Import Rejections Report

Report for the process that imports grants personnel and related data. Displays the list of error details for the rejected grants personnel and related data.

Import Grants Personnel

Project Application Administrator

Project Integration Specialist

Identify Cross-Charge Transactions Execution Report

Report for the process that identifies cross-charge transactions and classifies them as intercompany or borrowed and lent.

Identify Cross-Charge Transactions: Generate Output Report

Project Accountant

Grants Accountant

Project Billing Specialist

Import Keywords Report

Report for the process that imports keywords and related data.

Displays the list of details for the rejected and successfully imported keywords and related data.

Import Keywords

Project Application Administrator

Project Integration Specialist

Import Keywords Rejections Report

Report for the process that imports keywords and related data.

Displays the list of error details for the rejected keywords and related data.

Import Keywords

Project Application Administrator

Project Integration Specialist

Import Budget Report

Report for the process that imports budget versions from the open interface table. Displays the list of error details for the rejected budget versions.

Import Project Budgets

Project Application Administrator

Project Integration Specialist

Import Costs Execution Report

Report for the process that creates expenditure items and cost distributions for the transactions in the open interface table.

Import Costs

Project Accountant

Grants Accountant

Import Cost Rejections Report

Report for the process that identifies the project cost transactions which are rejected by the Import Costs process while importing transactions using the file-based data import feature and the reasons for rejection.

The report name varies as follows based on the type of the imported transactions:

  • Import Project Expense Cost Rejections

  • Import Project Inventory Cost Rejections

  • Import Project Labor Costs Rejections

  • Import Project Miscellaneous Cost Rejections

  • Import Project Nonlabor Cost Rejections

  • Import Project Supplier Cost Rejections

Import Costs

Project Accountant

Grants Accountant

Import Financial Project Plan Report

Report for the process that imports financial project plan versions from the open interface table.

Displays the list of error details for the rejected financial project plan versions.

Import Financial Project Plan

Project Application Administrator

Project Integration Specialist

Import Forecast Report

Report for the process that imports forecast versions from the open interface table. Displays the list of error details for the rejected forecast versions.

Import Project Forecasts

Project Application Administrator

Project Integration Specialist

Import Financial Plan Version Report

Report for the process that imports financial plan version data from the open interface table and creates financial plan versions.

Import Financial Plan Versions

Project Application Administrator

Project Integration Specialist

Import Funding Sources Report

Report for the process that imports grants funding sources and related data. Displays the list of details for the rejected and successfully imported grants funding sources and related data.

Import Funding Sources

Project Application Administrator

Project Integration Specialist

Import Funding Sources Rejections Report

Report for the process that imports grants funding sources and related data. Displays the list of error details for the rejected grants funding sources and related data.

Import Funding Sources

Project Application Administrator

Project Integration Specialist

Import Project Budget Execution Report

Report for the process that imports budget versions from the open interface table.

Displays the list of budget versions that are imported successfully and error details for the rejected budget versions.

Budget Import Execution Report

Project Application Administrator

Project Integration Specialist

Import Project Enterprise Resources Execution Report

Report for the process that imports project enterprise resources from the open interface table and creates project enterprise resources.

Import Project Enterprise Resources

Project Administrator

Import Resource Actual Hours Execution Report

Report for the process that imports resource actual hours data from the open interface or Project Costing.

Import Resource Actual Hours

Project Administrator

Project Integration Specialist

Import Resource Pools and Memberships Report

Report for the process that imports resource pools and pool memberships.

Import Resource Pools and Memberships

Project Administrator

Project Integration Specialist

Import Project Plan Execution Report

Report for the process that imports projects and tasks from the open interface table and creates projects and tasks.

Import Project Plan

Project Manager

Project Administrator

Project Integration Specialist

Import Project Rate Schedules Report

Report for the process that imports project rate schedules and associated person, job, nonlabor, and resource class rates from the open interface table.

Displays the list of project rate schedules and rates that are imported successfully and error details for the rejected rate schedules and rates.

Import Project Rate Schedules

Project Administrator

Import Resource Breakdown Structures Report

Report that displays the summary, exception, and success details of the Import Resource Breakdown Structures process.

Import Resource Breakdown Structures

Project Application Administrator

Project Integration Specialist

Import Project Report

Report for the process that imports projects from the open interface table.

Displays the list of projects that are imported successfully and error details for the rejected projects.

Import Projects

Project Administrator

Grants Administrator

Import Project Progress Report

Report for the process that imports project progress data from the open interface table and creates project progress.

Import Project Progress

Project Manager

Project Application Administrator

Import Project Resource Assignments Execution Report

Report for the process that imports project resource assignment data from the open interface table and creates project resource assignments.

Import Project Resource Assignments

Resource Manager

Import Project Resource Requests Execution Report

Report for the process that imports project resource request data from the open interface table and creates project resource requests.

Import Project Resource Requests

Project Administrator

Import Project Tasks Report

Report for the process that imports project tasks from the open interface table.

Displays the list of project tasks that are imported successfully and error details for the rejected project tasks.

Import Project Tasks

Project Administrator

Grants Administrator

Import Resource Actual Hours Execution Report

Report for the process that imports resource actual hours data from the open interface table and creates time transactions.

Import Resource Actual Hours

Project Administrator

Import Resource Pools and Memberships Execution Report

Report for the process that imports resource pool and pool membership data from the open interface and creates resource pools and memberships.

Import Resource Pools and Memberships

Implementation Administrator

Resource Manager

Import Unassigned Asset Lines Report

Report of the process that updates the asset name on unassigned asset lines.

Displays a summary of successful transactions and errors from the import process

Import Unassigned Asset Lines

Project Accountant

Grants Accountant

Maintain Project Enterprise Labor Resources Output Report

Report for the process that imports Cloud HCM resources to create project enterprise resources.

Displays the list of resources that are imported successfully, resources exceptions, and updates made to name and email of project enterprise resources.

Maintain Project Enterprise Labor Resources

Project Application Administrator

Maintain Project Performance Data Execution Report

Report for the process that improves performance during project performance data summarization by purging unused or deleted dimension members and summaries, reordering data, merging Oracle Essbase incremental slices, and optionally deleting project performance data.

Maintain Project Performance Data

Project Application Administrator

Open Accounting and Project Accounting Periods Execution Report

Report for the processes that update the status of the accounting or project accounting periods to open.

Open Accounting Period

Open Project Accounting Period

Project Accountant

Grants Accountant

Reclassify Billing Offset Balances Execution Report

Report for the process that creates reclassification accounting transactions to effectively net the unbilled receivables and deferred revenue balances together into a single balance.

Reclassify Billing Offset Balances

Project Accountant

Grants Accountant

Recalculate Burden Cost Amounts Execution Report

Report for the process that identifies expenditure items impacted by a burden schedule version change and processes the resulting burden cost recalculation adjustments.

Recalculate Burden Cost Amounts

Project Accountant

Grants Accountant

Release Allocation Transactions Execution Report

Report for the process that release and processes allocation and offset transactions for a draft allocation.

Release Allocation Transactions

Project Accountant

Release Capitalized Interest Transactions Execution Report

Report for the process that releases a capitalized interest batch that's in draft success status and creates expenditure items for the interest transactions.

Release Capitalized Interest Transactions

Project Accountant

Grants Accountant

Reverse Allocation Transactions Execution Report

Report for the process that creates and processes transactions to reverse a released allocation.

Reverse Allocation Transactions

Project Accountant

Grants Accountant

Reverse Capitalized Interest Transactions Execution Report

Report for the process that reverses a capitalized interest batch that's in released status and creates reversal transactions.

Reverse Capitalized Interest Transactions

Project Accountant

Grants Accountant

Sweep Transaction Accounting Events Execution Report

Report for the process that sweeps unaccounted transactions into the next open or future-enterable accounting period so that the current period can be closed.

Sweep Transaction Accounting Events

Project Accountant

Grants Accountant

Transfer Assets to Oracle Fusion Assets Execution Report

Report for the process that creates one additional line for each capital asset line or retirement cost line in Oracle Project Costing and transfers these lines to Oracle Assets to become fixed assets or group retirement reserve adjustments.

Transfer Assets to Oracle Fusion Assets

Project Accountant

Grants Accountant

Transfer Invoice Details to Receivables Execution Report

Report for the process that transfers released project contract invoices to the Oracle Receivables interface tables.

Transfer Invoice Details to Receivables

Project Billing Specialist

Grants Accountant

Update Asset Details from Oracle Fusion Assets Execution Report

Report for the process that identifies assets and asset lines. Updates asset number and asset period in which these assets and asset lines are posted.

Update Asset Details from Oracle Fusion Assets

Project Accountant

Grants Accountant

Update Financial Project Plan and Progress Execution Report

Report for the process that generates working versions of budgets or forecasts based on existing financial or project plans.

Update Financial Project Plan and Progress

Project Manager

Project Administrator

Update Invoice Details from Receivables Execution Report

Report for the process that identifies whether project contract invoices are successfully transferred to the Oracle Receivables application, updates the receivables invoice number in the Project Financial Management application, and triggers currency conversion and summarization.

Update Invoice Details from Receivables

Project Billing Specialist

Grants Accountant

Update Project Contract Performance Data Execution Report

Report for the process that summarizes contract revenue and billing data for project performance reporting.

Update Project Contract Performance Data

Project Manager

Update Project Performance Data Report

Report for the process that summarizes performance data for a project unit, business unit, a range of projects, or the projects managed by a project manager.

Displays the projects, contracts, awards, and project KPIs that were summarized or had exceptions during summarization.

Update Project Performance Data

Project Manager

Project Administrator

Update Project Plan Data Execution Report

Report for the process that updates the project plan with summarized amounts from actual cost transactions.

Update Project Plan Data

Project Manager

Import Project Key Performance Indicators Report

Report for the process that imports KPIs for project templates and projects that are enabled for financial management from the open interface tables.

Displays the number of KPIs and projects that were processed, attached successfully, and not attached.

Import Project Key Performance Indicators

Project Integration Specialist

Project Application Administrator

Update Resource Rates for Project Enterprise Resources Execution Report

Report for the process that updates project enterprise resource rates from resource rate schedules.

Update Resource Rates for Project Enterprise Resources

Resource Manager

Update Work Type Execution Report

Report for the process that provides a summary of the number of updated objects with work type details.

The updated objects are projects, tasks, expenditure items, and cost distributions.

Update Work Type

Project Administrator

Accounting and Project Accounting Periods Close Exceptions Reports

This topic provides an overview of the Accounting and Project Accounting Periods Close Exceptions reports.

Overview

You can review the unprocessed transactions and other conditions that prevent accounting or project accounting periods from being closed by using the Accounting and Project Accounting Periods Close Exceptions reports. Multiple reports are grouped under the Accounting and Project Accounting Periods Close Exceptions reports as listed below.

  • Close Accounting Period Execution Report

  • Close Pending Accounting Period Execution Report

  • Close Project Accounting Period Execution Report

  • Close Pending Project Accounting Period Execution Report

  • Accounting Period Close Exceptions Report

  • Project Accounting Period Close Exceptions Report

Key Insights

These reports answer the following business questions:

  • What must be done before I can close the periods?

  • Are there any issues which will prevent me from closing the periods?

  • Which unprocessed transactions can prevent the periods from being closed?

Frequently Asked Questions

The following table lists the frequently asked questions about these reports.

FAQ Answer

How do I find these reports?

  • Reports and Analytics - Shared Folders - Projects - Project Cost - Accounting

  • Cost Work Area - Tasks - Reporting

  • Revenue Work Area - Tasks - Reports

How do I generate these reports?

Using the following processes:

  • Close Accounting Period

  • Close Project Accounting Period

  • Accounting Period Close Exceptions Report

  • Project Accounting Period Close Exceptions Report

Who uses these reports?

  • Grants Accountant

  • Project Accountant

When do I use these reports?

When you need to close accounting or project accounting periods.

What can I do with these reports?

You can:

  • Confirm that the status of the accounting period has been updated to close or close pending.

  • Confirm that the status of the project accounting period has been updated to close or close pending.

  • Identify unprocessed cost transactions, unaccounted cost transactions, and transactions which exist in account payables but haven't been imported into project costing that prevent accounting and project accounting periods from being closed.

What type of reports are these?

Oracle Business Intelligence Publisher

Process Parameters for the Reports

The following table lists the parameters you must provide for the various processes that generate these reports.

Report Process Process Parameters Values

Close Accounting Period Execution Report

Close Accounting Period

  • *Ledger

  • *Processing Action

  • *Period

  • Report Style

  • Ledger name from list of values

  • Accounting period close

  • Accounting period for the ledger from list of values

  • Detail

    Summary

Close Pending Accounting Period Execution Report

Close Accounting Period

  • *Ledger

  • *Processing Action

  • *Period

  • Report Style

  • Ledger name from list of values

  • Accounting period close pending

  • Accounting period for the ledger from list of values

  • Detail

    Summary

Close Project Accounting Period Execution Report

Close Project Accounting Period

  • *Ledger

  • *Processing Action

  • *Period

  • Report Style

  • Ledger name from list of values

  • Project accounting period close

  • Project accounting period for the ledger from list of values

  • Detail

    Summary

Close Pending Project Accounting Period Execution Report

Close Project Accounting Period

  • *Ledger

  • *Processing Action

  • *Period

  • Report Style

  • Ledger name from list of values

  • Project accounting period close pending

  • Project accounting period for the ledger from list of values

  • Detail

    Summary

Accounting Period Close Exceptions Report

Accounting Period Close Exceptions Report

  • *Ledger

  • *Period

  • Report Style

  • Transaction Category

  • Ledger name from list of values

  • Accounting period for the ledger from list of values

  • Detail

    Summary

  • Cross-charge transactions

    Expenditure transactions

    Inventory transactions

    Receipt accrual transactions

    Revenue transactions

    Supplier invoice transactions

Project Accounting Period Close Exceptions Report

Project Accounting Period Close Exceptions Report

  • *Business Unit

  • *Period

  • Report Style

  • Transaction Category

  • Business unit name from list of values

  • Project accounting period for the business unit from list of values

  • Detail

    Summary

  • Cross-charge transactions

    Expenditure transactions

    Inventory transactions

    Receipt accrual transactions

    Revenue transactions

    Supplier invoice transactions

The following processes always trigger the Validate Pending Inventory and Receipt Transactions process:

  • Close Accounting Period

  • Close Project Accounting Period

The following processes for inventory or receipt accrual transactions always trigger the Validate Pending Inventory and Receipt Transactions process:

  • Accounting Period Close Exceptions Report

  • Project Accounting Period Close Exceptions Report

The following processes have the processing mode set to Update:

  • Close Accounting Period

  • Close Project Accounting Period

The following processes have the processing mode set to Review:

  • Accounting Period Close Exceptions Report

  • Project Accounting Period Close Exceptions Report

Federal Financial Report

This topic provides an overview of the Federal Financial Report.

Overview

The Federal Financial Report provides the award financial information in a standard layout defined by the federal agency. Use this report to track the summary transactions for an award, the amount spent or received, and the outstanding obligation amount.

Key Insights

This report answers the following business questions:

  • What's the cumulative amount of actual cash received that you must report to the federal agency?

  • What's the cumulative amount of federal fund disbursements that you must report to the federal agency?

  • What's the total funds authorized, total expenditures, and total unliquidated obligation that you must report to the federal agency?

Frequently Asked Questions

The following table lists the frequently asked questions about this report.

FAQ Answer

How do I find this report?

Report and Analytics - Shared Folders - Projects - Grants Management - Award

How do I generate this report?

Submit the Federal Financial Report process.

Who uses this report?

Grants Administrator

When do I use this report?

When you want to view and print award financial information in the standard federal format.

What can I do with this report?

View the following information and print the report.

  • Federal agency details

  • Recipient details

  • Project or grant period

  • Transactions:

    • Federal cash amount

    • Federal expenditures and unobligated balance

    • Recipient share

    • Program income

What type of report is this?

Oracle Business Intelligence Publisher

Process Parameters for the Report

You can run the Federal Financial Report process for a single award or multiple awards within or across business units.

Note: The principal investigator can't generate the federal financial report.

The Federal Financial Report process accepts the following parameters:

Parameter Description

* Generate Report

Specifies if you want to submit the process for a single award or multiple awards.

* Business Unit

Name of the business unit.

* Award Name

Name of the award.

Note: Not required when you process multiple awards.

Sponsor

Name of the sponsor.

Note: Required when you process multiple awards. When the award uses a letter of credit, the LOC number is displayed. The sponsor award number and document number are listed in the Federal Grant Number field when you process single or multiple awards, respectively.

Institution

Name of the business unit.

Note: Required only when you process multiple awards.

* Certifying Official

Authorized person who signs on the federal financial report when submitting it to the federal agency.

* Report Date

Date when the report is generated and submitted to the federal agency. The default value is the current date.

* Period End Date

End date of the reporting period. For example, 31 March is the end date for the quarterly report.

* Report Type

Type of report. Valid values are Annual, Semi-Annual, Quarterly, or Final.

Total Recipient Share Required

Total required recipient share of costs within the Federal Financial Report report period end date.

Note: Required only when you process a single award.

Total Federal Program Income

Amount of federal program income earned.

Note: Required only when you process a single award.

Program Income Expended in Accordance with the Deduction Alternative

Amount of program income that was used to reduce the federal share of the total project costs.

Note: Required only when you process a single award.

Program Income Expended in Accordance with the Addition Alternative

Amount of program income that was added to the funds committed to the total project costs and expended to further eligible projects or program activities.

Note: Required only when you process a single award.

Comments

Any explanations or additional information that's required by the federal sponsoring agency.

Output Report

The Federal Financial Report output report prints the following details:

Section in the Report Field Name Description

1

Federal Agency and Organizational Element to Which Report is Submitted

Name of the primary sponsor of the award.

Only awards with federal sponsors are applicable for Federal Financial Report generation.

2

Federal Grant or Other Identifying Number Assigned by Federal Agency

Award number that's tracked by the sponsor.

The award number is displayed in the Sponsor Award Number field, under the General tab in the Edit Award Details page.

3

Recipient Organization (Name, Street 1, Street 2, City, State, County, Country, Province, Zip/Postal Code)

Name and address (the primary address that you entered in the Manage Institutions page) of the award institution.

The award institution is displayed in the Institution field under the General tab in the Edit Award Details page.

4a

D-U-N-S Number

Data Universal Numbering System (D-U-N-S) number of the institution that's used in the report.

The D-U-N-S number is displayed in the D-U-N-S Number field in the Manage Institutions page in the Setup and Maintenance work area.

4b

EIN

Unique identification number of the employer that's assigned by the Internal Revenue Service (IRS) for tax and accounting purposes.

This value is populated from the legal entity that's associated to the award organization.

5

Recipient Account Number or Identifying Number

Award or contract number of the award for which the report is generated.

6

Report Type

Type of Federal Financial Report. Valid values are Annual, Final, Quarterly, and Semiannual.

The report type is the Report Type parameter value that you specified when you submitted the Generate Federal Financial Report process.

7

Basis of Accounting

Accounting method of the primary ledger of the award organization.

The accounting method is displayed in the Accounting Method field of the primary ledger of the award organization in the Manage Primary Ledgers page in the Setup and Maintenance work area.

8

Project/Grant Period

Start and end date of the award for which the report is generated.

The start and end dates are displayed in the Start Date and End Date fields in the Edit Award Details page.

9

Report period end date

Date up to which the report amounts are calculated. The default value is the current date.

The report period end date is the Report Date parameter value that you specified when you submitted the Generate Federal Financial Report process.

10

Transactions

Displays the cumulative amounts of expenditures with accounted dates within the inception of the award through the Federal Financial Report report period end date.

10a

Cash Receipts

Sum of the applied (receipts matched against the invoice) and accounted receipt amounts with the accounting date from inception till the Federal Financial Report report period end date.

Go to Receivables, click Manage Receipts, and search for receipts that have an invoice mapped and accounting date that's less than the Federal Financial Report report period end date.

10b

Cash Disbursements

Sum of all accounted burdened cost incurred by the sponsor (external funding source) with the provider ledger accounting date that's within the Federal Financial Report report period end date.

Go to Projects > Costs, and click Manage Project Costs in the panel drawer. Search for costs that match the contract and funding source as the sponsor and with an accounting period that's within the Federal Financial Report report period end date.

10c

Cash on Hand

Difference between cash receipts (10a) and cash disbursements (10b).

10d

Total Federal funds authorized

Sum of all direct and indirect funding from the sponsor (federal funds) that's allocated to budget periods within the Federal Financial Report report period end date.

10e

Federal share of expenditures

Sum of all accounted burdened cost incurred by the sponsor (external funding source) with provider ledger accounting date that's within the Federal Financial Report report period end date.

Go to Projects > Costs, and click Manage Project Costs in the panel drawer. Search for costs that match the contract and funding source as the sponsor and with an accounting period that's within the Federal Financial Report report period end date.

10f

Federal share of unliquidated obligations

Sum of burdened costs from commitment transactions with provider ledger accounting date that's within the Federal Financial Report report period end date. Only purchase orders and supplier invoices are picked from commitments. Requisitions and third party commitments aren't considered.

Go to Projects > Costs, and click Manage Committed Costs in the panel drawer. Search for costs that match the contract and with an accounting period that's within the Federal Financial Report report period end date.

10g

Total Federal share

Sum of federal share of expenditures (10e) and federal share of unliquidated obligations (10f).

10h

Unobligated balance of Federal Funds

Difference between the total federal funds authorized (10d) and total federal share (10g).

10i

Total receipt share required

Total required recipient share of costs within the Federal Financial Report report period end date.

The total recipient share required is the Total Recipient Share Required parameter value that you specified when you submitted the Generate Federal Financial Report process.

10j

Recipient share of expenditures

Sum of all accounted burdened cost incurred by the internal funding sources with provider ledger accounting date that's within the Federal Financial Report report period end date.

Go to Projects > Costs, and click Manage Project Costs in the panel drawer. Search for costs that match the contract and funding source as internal or organization and with an accounting period that's within the Federal Financial Report report period end date.

10k

Remaining receipt share to be provided

Difference between the total receipt share required (10i) and recipient share of expenditures (10j).

10l

Total Federal program income earned

Amount of federal program income earned.

The total federal program income earned is the Total Federal Program Income parameter value that you specified when you submitted the Generate Federal Financial Report process.

10m

Program Income expended in accordance with the deduction alternative

Amount of program income that was used to reduce the federal share of the total project costs.

The program income expended in accordance with the deduction alternative is the Program Income Expended in Accordance with the Deduction Alternative parameter value that you specified when you submitted the Generate Federal Financial Report process.

10n

Program Income expended in accordance with the addition alternative

Amount of program income that was added to the funds committed to the total project costs and expended to further eligible projects or program activities.

The program income expended in accordance with the addition alternative is the Program Income Expended in Accordance with the Addition Alternativeparameter value that you specified when you submitted the Generate Federal Financial Report process.

10o

Unexpended program income

Difference between the total federal program income earned (10l) and either the program income expended in accordance with the deduction alternative (10m) or the program income expended in accordance with the addition alternative (10n); based on which field has a value.

11

Indirect Expense

Displays the burden schedule version details that the expenditure items, dated until the report period end date, use to create the indirect expense amounts.

Note: Burden costs are calculated using the project raw cost and the burden schedule multiplier.

11a

Type

Type of the burden schedule version that's used for calculating the burden rates for the expenditure items.

11b

Rate

Overall rate of costs under the burden schedule that's calculated using the following formula: (Total burden cost / Total raw cost) x 100.

11c

Period From, Period To

Start and end dates of the burden schedule version for indirect expenses.

11d

Base

Total raw cost of all the costs that were created before the report period end date using the burden schedule, and that belong to the award and funding source (sponsor) for this report.

11e

Amount Charged

Total burden cost of all the costs that were created before the report period end date using the burden schedule, and that belong to the award and funding source (sponsor) for this report.

Burden cost is calculated for each eligible transaction by multiplying the project raw cost with the applicable burden multipliers defined in the burden schedule and then summing up all the calculated burden costs.

11f

Federal Share

The federal share value is populated from the Amount Charged (11e) field.

11g

Totals

Total of each of the indirect expense column value.

12

Remarks

Any explanations or additional information that's required by the federal sponsoring agency.

The remarks are from the Comments parameter value that you specified when you submitted the Generate Federal Financial Report process.

13

Certification

Displays the certification details.

13a

Name and Title of Authorized Certifying Official

Details of the person that you specified in the Certifying Official parameter when you submitted the Generate Federal Financial Report process.

13b

Signature of Authorized Certifying Official

Not populated during the Federal Financial Report generation.

13c

Telephone(Area code, number and extension)

Contact details of the person that you specified in the Certifying Official parameter when you submitted the Generate Federal Financial Report process.

13d

Email Address

Email address of the person that you specified in the Certifying Official parameter when you submitted the Generate Federal Financial Report process.

13e

Date Report Submitted

Date that's populated from the Report Date parameter value that you specified when you submitted the Generate Federal Financial Report process. The default value is the current date.

Indirect Expense Calculation in the Federal Financial Report

The Base, Amount Charged, and Rate values that you view in the Indirect Expenses section of the Federal Financial Report are calculated using formulas based on the dates of the report.

The formulas use the following setup objects:

  • Burden Structures

  • Burden Cost Codes

  • Burden Schedules

Example of Calculating Indirect Expenses and Populating them in the Federal Financial Report

This example explains how indirect expenses are calculated and populated in the Federal Financial Report output report for the FFR Bonus Salary Award award.

In this example, here's how the burden structure is setup in the Manage Burden Structures page:

Field Value Value

Name

Bonus Salary Structure

None

Structure Type

Precedence

None

From Date

01/01/01

None

Cost Base

Labor

None

Cost Base Type

Burden Cost

None

Burden Cost Code

Fringe

Labor Costing

Precedence

1

2

Expenditure Type

Administration

Professional

Description

Administration

Professional

Direct Cost

Note: The direct cost value is specified in the Manage Burden Cost Codes setup page.

Y

N

The budget schedule versions are set up in the Manage Burden Schedules setup page, as follows:

Field Value Value Value Value

Version

2021-and-After

Jul-Dec2020

Jan-Jun2020

Before2020

From Date

01/01/21

07/01/20

01/01/20

01/01/01

To Date

None

12/31/20

6/30/20

12/31/19

Type

Firm

Firm

Firm

Firm

Burden Structure

Bonus Salary Structure

Bonus Salary Structure

Bonus Salary Structure

Bonus Salary Structure

The multipliers to the burden schedule versions are set up as follows:

  • For Before2020 burden schedule version:

    Field Value

    Organization

    Vision City Operations

    Burden Cost Code

    Labor Costing

    Multiplier

    0.5

  • For Jan-Jun2020 burden schedule version:

    Field Value Value

    Organization

    Vision City Operations

    Vision City Operations

    Burden Cost Code

    Labor Costing

    Fringe

    Multiplier

    0.5

    0.2

  • For Jul-Dec2020 burden schedule version:

    Field Value Value

    Organization

    Vision City Operations

    Vision City Operations

    Burden Cost Code

    Labor Costing

    Fringe

    Multiplier

    0.52

    0.2

  • For 2021-and-After burden schedule version:

    Field Value

    Organization

    Vision City Operations

    Burden Cost Code

    Labor Costing

    Multiplier

    0.5

The FFR Bonus Salary Award award is created with the following values:

Award and Award Project Attributes Value

Award Number

FFR_BONUS_SALARY_AWARD

Start Date

10/01/17

End Date

9/30/22

Primary Sponsor

Department of Health and Human Services (DHHS)

Business Unit

Vision City Operations

Legal Entity

Vision City LE

Institution

Stephen University

Burden Schedule

FFR Burden Schedules

Project Name

FFR Salary Project

Project Number

FFR_Salary_Project

Funding Source

Department of Health and Human Services (DHHS)

Start Date

Note: Start date of the award project.

10/01/17

End Date

Note: End date of the award project.

9/30/22

Burden Schedule Overrides

None

The Federal Financial Report process for the FFR Bonus Salary Award award is submitted with the following parameters:

Parameter Value

Business Unit

Vision City Operations

Award Name

FFR Bonus Salary Award

Report Type

Annual

Certifying Official

Mike Phillips

Report Date

8/12/20

Period End Date

8/12/20

Two payroll costs are defined for the Jan-Jun2020 and Jul-Dec2020 burden schedule versions with the following values:

Payroll Cost Attributes Value Value

Transaction Number

7914796

7914799

Expenditure Item Date

01/01/20

07/01/20

Expenditure Type

Administration

Administration

Raw Cost

$100.00

$100.00

Burdened Cost

$100.00

$100.00

Expenditure Organization

Vision City Operations

Vision City Operations

Project Number

FFR_Salary_Project

FFR_Salary_Project

Task Number

1.1

1.1

Contract Name

FFR Bonus Salary Award

FFR Bonus Salary Award

Funding Source

Department of Health and Human Services (DHHS)

Department of Health and Human Services (DHHS)

Person Name

Parker, Alice

Parker, Alice

These two payroll costs are used to calculate the indirect expenses. The indirect expenses are calculated and populated in the Federal Financial Report output report as follows:

Type Rate Period From Period To Base Amount Charged Federal Share

Final

50

01/01/20

06/30/20

$120.00

$60.00

$60.00

Final

52

07/01/20

12/31/20

$120.00

$62.40

$62.40

The Base, Amount Charged and Rate are derived for the costs using the Jan-Jun2020 burden schedule version, as follows:

  • The Base value of $120.00 is derived, as follows. As fringe is considered as direct cost, the transaction raw cost (100) is multiplied with the multiplier of fringe (0.2).

    SUM(100 + (100 x 0.2))
  • The Amount Charged value of $60.00 is derived as follows:

    SUM( (100 + (100 x 0.2)) x 0.5
  • The Rate value of 50 is derived as follows:

    (60 /120) x 100

Preview Invoice Report

This topic provides an overview of the Preview Invoice report.

Overview

You can review invoice information in a specific format using the Preview Invoice feature in the Invoices work area before printing the invoice or sending it to account receivables. To preview the invoice, you must select the:

  • Invoice format template in which you want to preview the invoice. For example, Services Standard Invoice Report, and so on.

    You can create your own format templates for your invoices.

  • Output format in which you want to preview the invoice. For example, HTML, PDF, RTF, and so on.

    To generate the Preview Invoice report in PDF format, you must install Adobe Acrobat Reader. You can download it from http://adobe.com.

Key Insights

This report answers the following business questions:

  • Which cost transactions and billing events are billed through the invoice?

  • Are the transactions billed at the correct rates?

  • Are the invoice line descriptions well formatted and do they provide the requested information?

Frequently Asked Questions

The following table lists the frequently asked questions about this report.

FAQ Answer

How do I find this report?

Reports and Analytics - Shared Folders - Projects - Project Billing

How do I generate this report?

Invoices Work Area - Invoice Processing Status:

  • Draft Invoices - Actions - Preview

  • Submitted Invoices - Actions - Preview

  • Released Invoices - Actions - Preview

Alternatively, click the Preview button on Draft Invoices, Submitted Invoices, and Released Invoices tabs in the Invoice Processing Status region of the Invoices work area.

Click the Preview button on the Edit Invoices page for draft invoices or on the Invoice Details page for submitted, accepted, and released invoices.

Click Preview on the invoices on the Manage Project Invoices page of the Projects work area.

Who uses this report?

  • Grants Accountant

  • Project Billing Specialist

  • Project Manager

When do I use this report?

When you need to preview the invoice before printing or sending it to account receivables.

What can I do with this report?

You can view the following information:

  • Contract terms

  • Invoice date

  • Invoice line details

  • Project summary

  • Total billed amount

What type of report is this?

Oracle Business Intelligence Publisher

How do I modify this report?

Sign in to Oracle BI Publisher to edit the layout and properties of the predefined Services Invoice Report or the Services Standard Invoice Report. You can also modify the predefined Email Attachment Invoice Template, which is used for attaching a preview of a project contract invoice to an invoice approval workflow notification. After you complete modifying the Preview Invoice Report in the BI Publisher, mark the Manage Invoice Templates task as complete in Setup and Maintenance work area.

You must select a single invoice to generate the Preview Invoice report. You can't generate the report if you select multiple invoices in the Invoices work area.

Preview SF270 Report

This topic provides an overview of the Preview SF270 federal report.

Overview

You can use the Preview SF270 report to request only for reimbursements on federal grant awards which aren't sponsored through letters of credit.

Key Insights

This report answers the following business question:

  • What is the reimbursement amount to request, as of a certain period, from the federal agency?

Frequently Asked Questions

The following tables lists the frequently asked questions about this report.

FAQ Answer

How do I find this report?

Reports and Analytics - Shared Folders - Projects - Project Billing

How do I generate this report?

  • Using the Generate Invoices process

  • Manage Invoices - Review SF 270

Who uses this report?

  • Grants Accountant

  • Project Billing Specialist

When do I use this report?

When you need to:

  • Request for reimbursements on federal grant awards which aren't sponsored through letters of credit

  • Display current and previously billed transactions, and cost sharing details in a standard federal format

What can I do with this report?

You can view the following information in the report:

  • Bill From and Bill To

  • Type of payment requested

  • Basis of request

  • Federal sponsoring agency and organization to which the SF270 invoice is submitted

  • Federal grant or other identification number assigned by the federal agency

  • Partial payment request number

  • Employer identification number

  • Recipient account number

  • Period covered by the request

  • Recipient organization name and address

  • Federal amount of reimbursement

  • Total program outlay to date

  • Cumulative Program Income

  • Estimated net cash outlay for advance period

  • Federal and non-Federal share of the cost

  • Additional notes

What type of report is this?

Oracle Business Intelligence Publisher

Prerequisites

Before you can generate and review your invoice in the SF270 report format, you must:

  • Implement Grants Management application for the business unit to which the invoice contract belongs.

  • Select SF270 as the invoice format in the contract bill plan.

  • Create your invoice contract as an award contract.

  • Select only a single invoice to preview.

Create Accounting Transactions Execution Report

This topic provides an overview of the Create Accounting Transactions Execution Report.

Overview

You can use the Create Accounting Transactions Execution Report to review the reclassification of accounting transactions to effectively net unbilled receivables and deferred revenue balances together into a single balance.

Key Insights

This report answers the following business questions:

  • What are the summary results of the reclassify billing offset balances process?

  • What errors were encountered attempting to reclassify billing offset balances?

  • What billing offset reclassification accounting transactions were successfully created by the process?

Frequently Asked Questions

The following table lists the frequently asked questions about this report.

FAQ Answer

How do I find this report?

Report and Analytics - Shared Folders - Projects - Project Revenue

How do I generate this report?

Using the Create Accounting Transactions process from:

  • Revenue Work Area - Tasks - Accounting

  • Scheduled Processes - Schedule New Process

Who uses this report?

  • Grants Accountant

  • Project Accountant

When do I use this report?

When you need to group the unbilled receivables and deferred revenue balances into a single balance.

What can I do with this report?

You can view the following information and print the report.

  • Reclassification errors

  • Reclassification warnings

  • Successful reclassifications

What type of report is this?

Oracle Business Intelligence Publisher

Process Parameters for the Report

The Reclassify Billing Offset Balances process accepts the following parameters.

Parameter Values

*Business Unit

List of values, for example, Vision Operations

*Accounting Period

List of values, for example, 2009-AUG

Contract Type

List of values

Revenue Method Classification

  • Rate Based

  • Amount Based

  • Percent Complete

  • Percent Spent

  • As Incurred

  • As Billed

Contract Number

List of values

Contract Line Number

List of values

*Generate Success Report

  • Yes

  • No

Sweep Transaction Accounting Events Execution Report

This topic provides an overview of the Sweep Transaction Accounting Events Execution Report.

Overview

You can use the Sweep Transaction Accounting Events Execution Report to review unaccounted transactions that are moved into the next open or future-enterable accounting period so that the current period can be closed.

Key Insights

This report answers the following business questions:

  • Are there transactions which need to be accounted before I can close the period?

  • If I run the Sweep Transaction Accounting Events process, which transactions are moved from the current period into the next open period?

  • What's the result of the Sweep Transaction Accounting Events process?

Frequently Asked Questions

The following table lists the frequently asked questions about this report.

FAQ Answer

How do I find this report?

Report and Analytics - Shared Folders - Projects - Project Cost - Accounting

How do I generate this report?

Using the Sweep Transaction Accounting Events process from:

  • Revenue Work Area - Tasks - Accounting

  • Scheduled Processes - Schedule New Process

Who uses this report?

  • Grants Accountant

  • Project Accountant

When do I use this report?

When you need to close a period that has unaccounted transactions.

What can I do with this report?

You can review the output of the Sweep Transaction Accounting Events process and print the report.

What type of report is this?

Oracle Business Intelligence Publisher

Process Parameters for the Report

The Sweep Transaction Accounting Events process accepts the following parameters.

Parameter Values

*Ledger

List of values, for example, Vision City

Business Unit

List of values, for example, Vision Operations

*Accounting Period

List of values, for example, Jan-06

Source Application

  • Project Billing

  • Project Costing

*Process Mode

  • Review

  • Update

Configurable Workflow Notifications

As part of workflow tasks, the application automatically sends notifications. For example, when a project manager assigns a task to a resource, the application sends a notification to the resource. For some workflow tasks, you can use Oracle Business Intelligence (BI) Publisher to tailor the content, layout, and style of the notifications. These report-based notifications aren't only configurable, but also optimized for viewing on mobile devices.

Tip: Notifications aren't sent to the user performing the action. For example, Change Order Status Change Notification is sent to previous owner, new owner, and creator when the ownership changes. If the creator changes the ownership, the notification isn't sent to the creator because notifications aren't sent to the user performing the action.

In addition to getting notifications in email, users can also view in-app notifications by:

  • Clicking the Notifications icon in the global header and opening a notification

  • Going to the Worklist: Notifications and Approvals work area and opening a notification

  • Clicking the In-App Notification link at the end of an email notification

Here's a table that shows the products that have configurable notifications, along with their associated report name, description, recipients and when it's sent. To navigate to the reports, open Reports and Analytics work area > Browse Catalog > Shared Folders > Projects > Workflow Notifications. Keep in mind that each report caters to multiple cases.

Product Report Name Description When It's Sent Recipients

Project Management

Change Order Status Change Notification

Information notification that's sent when a change order is assigned, closed, or canceled.

Ownership changes

  • Previous owner

  • New owner

  • Creator

Project Management

Change Order Status Change Notification

Information notification that's sent when a change order is assigned, closed, or canceled.

Owner closes or cancels change order

  • Participants

  • Creator

Project Management

Change Order Participant Notifications

Information notification that's sent when participants are assigned or removed from a change order.

Change order is submitted for impact assessment

Assessors who were assigned or removed

Project Management

Change Order Participant Notifications

Information notification that's sent when participants are assigned or removed from a change order.

Change order is submitted for review

Reviewers who were assigned or removed

Project Management

Change Order Participant Notifications

Information notification that's sent when participants are assigned or removed from a change order.

Change order is submitted for approval

Approvers who were assigned or removed

Project Management

Change Order Participant Notifications

Information notification that's sent when participants are assigned or removed from a change order.

Change order is submitted for implementation

Implementors who were assigned or removed

Project Management

Change Order Stage Completion Notifications

Information notification that's sent when a participant completes a stage, approves a change order, or rejects a change order.

  • Assessor completes the impact assessment stage

  • Reviewer completes the review stage

  • Approver approves or rejects the change order

  • Implementor completes the implementation stage

Owner

Project Management

Issue Notifications

Information notification that's sent when an issue is assigned, closed, or reopened.

Ownership changes

  • Previous owner

  • New owner

  • Creator

Project Management

Issue Notifications

Information notification that's sent when an issue is assigned, closed, or reopened.

An issue is closed or reopened

  • Creator

  • Owner

Project Management

Deliverable Notifications

Information notification that's sent when a deliverable is assigned, or completed.

Owner is changed

  • Previous owner

  • New owner

  • Creator

Project Management

Deliverable Notifications

Information notification that's sent when a deliverable is assigned, or completed.

Deliverable is completed

  • Owner

  • Creator

Project Management

Gate Approval Request Notification

Action notification that's sent when an approver is assigned to a gate.

Gate approver is assigned

Gate approver

Project Management

Gate Status Change Notifications

Information notification that's sent when a gate is approved or rejected.

Gate is approved or rejected

Project manager

Task Management

Task Details Notifications

Information notification that's sent when a follower is added, a followed task is completed, or a project task, action item, to-do task, or milestone is assigned.

  • A follower is assigned to a project task, action item, to-do task, or milestone

  • Project task, action item, to-do task, or milestone is completed

Follower

Task Management

Task Details Notifications

Information notification that's sent when a follower is added, a followed task is completed, or a project task, action item, to-do task, or milestone is assigned.

Project task, action item, to-do task, or milestone is assigned

Assignee

Project Resource Management

Resource Request Notification

Information notification to the resource manager when a project resource request is created.

Project manager creates project resource request for fulfillment.

Resource Manager

Project Resource Management

Proposed Resource Approval Notification

Approval notification to the project manager when the resource manager proposes a resource on a project resource request.

Resource manager proposes a resource to fulfill assignment

Project Manager

Project Resource Management

Proposed or Nominated Resource Notifications

Information notification to the project manager when the resource manager proposes or nominates a resource on a project resource request.

Resource manager proposes or nominates resources

Project Manager

Project Resource Management

Resource Assignment Notifications

Information notification when a project resource assignment is created directly, or when a proposed or nominated resource is approved on a request.

  • Resource manager proposes and approves resources on a request

  • Resource manager creates direct resource assignment

  • Resource manager approves the nominated resource that the project manager requested for assignment

  • Project manager approves the proposed resources on a request .

  • Project Manager

  • Resource Manager

Project Resource Management

Proposed or Nominated Resource Reject Notification

Information notification when a proposed resource is rejected, or when an assignment request for a nominated resource is rejected.

  • Project manager rejects the proposed resource

  • Resource manager rejects the nominated resource requested by project manager for assignment

  • Resource Manager

  • Project Manager

Project Resource Management

Assignment Notifications Notifying Resource

Information notification to the resource when the resource is assigned to a project, or when an existing project resource assignment is rescheduled or canceled.

  • Resource manager creates a direct resource assignment, proposes and approves a resource, approves a nominated resource that project manager requested for assignment, cancels an assignment, or updates and approves an assignment schedule change

  • Project manager accepts a proposed resource, approves a canceled assignment, approves a change in assignment schedule

Resource

Project Resource Management

Assignment Cancellation Approval Notification

Approval notification to the project manager when the resource manager requests a project resource assignment cancellation.

Resource manager cancels an assignment

Project Manager

Project Resource Management

Assignment Cancellation Notifications

Information notification that informs that a project resource assignment is directly canceled, or a cancellation request is approved.

  • Resource manager cancels an assignment

  • Project manager approves the request for assignment cancellation

  • Project Manager

  • Resource Manager

Project Resource Management

Assignment Adjustment Rejection Notifications

Information notification that informs that a project resource assignment schedule change or cancellation request is rejected.

Project manager rejects the request for assignment cancellation or the assignment schedule change

Resource Manager

Project Resource Management

Assignment Schedule Change Approval Notification

Approval notification to the project manager when the resource manager requests a project resource assignment schedule change.

Resource manager updates the assignment schedule

Project Manager

Project Resource Management

Assignment Schedule Change Notification

Information notification when a project resource assignment is adjusted, or the request for adjustment is approved.

  • Resource manager updates and approves the assignment schedule

  • Project manager approves the assignment schedule change

  • Project Manager

  • Resource Manager

Project Resource Management

Nominated Resource Approval Notification

Approval notification to the resource manager when the nominated resource is requested for assignment by the project manager.

Project manager requests for assignment on the resources that Resource Manager nominated

Resource Manager

Project Resource Management

Resource Staffing Unavailability Notification

Information notification to the resource pool manager when a resource is no longer available for staffing on project resource assignments.

A resource is no longer available for staffing

Staffing Owner

Project Control

Financial Project Plan Approval Notification

Approval notification that's sent when a budget is submitted for baseline or a forecast is sent for approval.

Project manager submits a budget for baseline or forecast for approval

Project Managers and Project Administrators

Project Billing

Project Contract Invoice Approval Notification

Action notification that's sent when a project contract invoice is submitted for approval.

Project contract invoice is submitted

Contract Administrator

Project Costing

Project Expenditure Batch Approval Notification

Approval notification that's sent when a project expenditure batch is submitted for approval.

Project expenditure batch is submitted for approval.

Approvers configured in the workflow approval rules.

Note: Project manager is the project resource requester and resource manager is the staffing owner but in some organizations, if the staffing owner is explicitly defined, the notifications are sent to the staffing owner and not the resource manager.

Process Overview

Generating configurable notifications through BI Publisher involves various types of objects in the BI catalog, including data models, subtemplates, style templates, and reports. Reports pull data from data models and generate notifications in an HTML format. The report layout templates use common table and paragraph styles and refer to a central subtemplate that contains reusable notification components.

This figure shows how these BI objects work together to generate the notification content.

BI Publisher objects, including data model, subtemplate,
style template, layout template, and report, working together to generate
HTML output for workflow notifications
  • Data Sources: Store the attributes and attribute values for business objects and transactions in the application (example of data sources being transaction tables)

  • Data Model: Determines which attributes from data sources are available to be included in the notification and how that data is retrieved

  • Subtemplate: Provides common components, for example a branding logo and buttons, that can be reused in multiple reports

  • Style Template: Provides styles such as the type of lines and fonts to use in tables, or the font type, size, and color to use for headings

  • Report: Contains a layout template that determines:

    • Which attributes appear in the notification, from the data model used for the report

    • What the notification looks like, leveraging components from the subtemplate and styles from the style template used for the report

  • HTML: Is the output generated from the report

  • Email Notification: Has the HTML output embedded in the email body

  • In-App Notification: Has the HTML output embedded in the application UI

Each workflow task with configurable notifications has a corresponding predefined report in the BI catalog. For example, the Gate Approval Request Notification contains Gate Approval Request Notification Layout and uses the Gate Notifications data model. The generated output is included in notifications that are sent to users.

Notification Modifications

After you enable configurable workflow notifications, the predefined reports and related objects in the BI catalog work by default. If you need to modify the notifications, you can edit copies of the predefined reports, data models, and subtemplate (but not the style template). You proceed as you would to edit any report, data model, or subtemplate in the catalog:

  1. Open the Reports and Analytics work area and then click Browse Catalog. The Oracle Transactional Business Intelligence page appears.

  2. Navigate to Shared Folders > Projects > Workflow Notifications. And then, select the product. For example, to configure notifications related to Project Management, click Project Management Control.

  3. Click Edit corresponding to the layout that you want to edit. A page containing all the existing layout appears.

  4. Click Edit corresponding to the default layout to download a copy.

  5. Edit the copied report layout template.

  6. Upload the modified template and set it as default.

You should get familiar with BI Publisher in general before modifying configurable notifications.

  • Use only the Template Builder For Word add-in to edit the .rtf template in Microsoft Word, not the layout editor or other tools available for creating and editing report layout.

  • Edit a copy of predefined layout templates, rather than create new reports or layout templates.

Security

To modify reports and data models for workflow notifications, you must have the BI administrator role.

Setup

To use configurable notifications for Project Management, you must opt-in to the Configure Project and Task Management Notifications feature to configure notifications.

You must download and install the Template Builder for Word add-in:

  1. Open the Reports and Analytics work area.

  2. Click the Browse Catalog button.

  3. Click Home.

  4. In the Get Started pane, click Download BI Desktop Tools and then click Template Builder For Word.

  5. Save and run the installer.

Best Practices for Layouts in Workflow Notifications

Predefined workflow notifications based on report layout templates all follow a general format. When you edit a copy of these layout templates in Microsoft Word, follow the predefined layout as closely as possible for consistency. Also keep in mind shared components and mobile considerations.

General Structure

In general, the workflow notifications contain a set of components that are displayed in a certain order.

The callouts in this figure identify the email notification components listed in the following table.

Example of a workflow email notification with callouts
to identify the various components

The callouts in this figure identify the in-app notification components listed in the following table. In addition to describing each component, the table also indicates if the component appears in the email notification, in-app notification, or both.

Example of a workflow in-app notification with
callouts to identify the various components
Callout Component Notification Type

1

Buttons with the primary actions to take on the task, such as Approve and Reject. These buttons aren't part of the configurable, report-based notification content.

In-app

2

Notification header listing key attributes of the workflow task and the associated transaction.

Both

3

Buttons for the primary actions to take on the task, such as Approve and Reject.

Email

4

Notification body that usually includes transaction and line level details, displayed in tables or sets of attributes with corresponding values. The data model for the report restricts the total number of rows displayed in some of the tables. If the limit is exceeded, the table footer provides a link to the transaction details page, where users can view all the rows. To change this limit, you can edit a copy of the data model.

Both

5

Approval history, including any attachments that users in the history uploaded for the task. You can't edit the approval history component, which usually appears in the body of only email notifications. For in-app notifications, you can usually view the history by clicking the Actions button and selecting History.

Email (or both, in rare cases)

6

Buttons for the primary actions again.

Email

7

A link to the corresponding transaction page, and another link to the in-app notification.

Email

When you modify notifications, try to keep to this general structure and don't remove essential elements such as the action buttons. Likewise, don't change the styles in your layout template. The predefined style template should still apply to your notification; don't edit a copy of the style template and apply that to your notification.

To add components to your notification, for example another table, consider first downloading another style template from My Oracle Support. This template contains Quick Parts content that you can use in Word when you do more advanced work on layout templates. For example, from the Quick Parts gallery, you can select and add the table that's consistent in format with predefined tables already on your notification.

By default, the components that you add in the layout template appear in both email and in-app notifications, where available. You can add conditions to explicitly make a particular element, for example a field, appear only in one type of notification and not the other.

Shared Components

A predefined subtemplate in the business intelligence (BI) catalog applies to all predefined layout templates for workflow notifications. The subtemplate contains components that are shared among the notifications, for example:

  • Branding logo, if you add one to the subtemplate, which would appear as the first component in the email body. The logo appears in email notifications only.

  • Action buttons in email notifications.

  • Links at the end of the email notification, one to the corresponding transaction page, and another to the in-app notification.

When you make a copy of a predefined layout template to edit, the copy automatically inherits the same predefined subtemplate. To edit these shared components, make a copy of the predefined subtemplate, edit the copied version, and apply it to your own layout templates.

Mobile Considerations

Because users can view the workflow notifications on mobile devices, always consider mobile first and keep the notifications as simple as possible. For example:

  • Don't put too much content horizontally, such as too many columns in tables.

  • Keep all text, including attributes and column headings, as short as possible.

  • Center align lists of attributes and their values, if they appear outside tables.

Make sure to test your email notifications on mobile devices.

Add a Branding Logo and Change Other Shared Components in Workflow Notifications

A predefined subtemplate contains common components for all workflow notifications based on predefined report layouts. For example, the subtemplate has a place for you to add a branding logo, which would appear at the beginning of email notifications. You can modify other shared components so that the same changes apply to your notifications. For example, for email notifications, you can also change the text on action buttons, or the text of the links that appear at the end of emails.

Note:
  • You must edit a copy of the subtemplate in the Custom folder of the business intelligence (BI) catalog. Don't directly update the predefined subtemplate.

  • The exact steps can vary depending on your version of Microsoft Word.

Modifying Shared Components in the Subtemplate

To edit a copy of the predefined subtemplate that contains the shared components:

  1. Click Navigator > Reports and Analytics.

  2. Click the Browse Catalog icon.

  3. In the BI catalog (the Folders pane), expand Shared Folders > Common Content > Templates.

  4. For Workflow Notification Subtemplate, click More and select Customize.

    If you're not using the Customize option:

    1. Click Copy in the toolbar with Workflow Notification Subtemplate selected.

    2. In the BI catalog, expand Shared Folders > Custom > Common Content > Templates. Create a Templates folder in this location if it doesn't exist.

    3. Click Paste in the toolbar.

    4. Click the Edit link for the copied subtemplate.

    All reports using the predefined subtemplate are automatically redirected to point to your subtemplate in the Custom folder. This applies:

    • To all reports, predefined or not

    • No matter if you copy and paste the subtemplate or use the Customize option

    • Only if your subtemplate has the same name and relative file path within Custom as the predefined subtemplate

  5. In the Templates section, click the link in the Locale column.

  6. Save the subtemplate .rtf file to your computer.

  7. Open the .rtf file with Microsoft Word.

    • To add a logo, insert your own image in the subtemplate.

    • To change button or link text, edit the text accordingly. Make the same edits wherever that button or link text appears in the subtemplate.

      Caution: To ensure that your layout templates reflect these changes without additional rework, don't edit any other text in the subtemplate .rtf file.
  8. Update Word options to ensure that existing links remain intact in the subtemplate.

    1. Click File > Options > Advanced.

    2. In the Word Options dialog box, click Web Options in the General section.

    3. In the Web Options dialog box, open the Files tab.

    4. Deselect the Update links on save check box.

  9. Save your changes in Word.

Uploading the Modified Subtemplate

To upload your subtemplate to the BI catalog:

  1. In the BI catalog, expand Shared Folders > Custom > Common Content > Templates.

  2. Click Edit for Workflow Notification Subtemplate.

  3. In the Templates section, click the Upload icon.

  4. Select your modified .rtf subtemplate and a locale, and click OK to overwrite the original subtemplate.

Use Quick Parts for Workflow Notifications

Use the Quick Parts feature in Microsoft Word to easily insert reusable pieces of formatted content. When you edit copies of predefined report layout templates for workflow notifications in Word, you can add predefined Quick Parts content to your .rtf file. For example, you can insert a table in a format that's consistent with predefined notifications. The predefined Quick Parts content is available in a style template .dotx file on My Oracle Support.

Note: The exact steps can vary depending on your version of Microsoft Word.

Prerequisites

To get the predefined Quick Parts content into your Quick Parts gallery:

  1. Open Configurable Workflow Notifications: Implementation Considerations (2215570.1) on My Oracle Support at https://support.oracle.com.

  2. Download the .dotx file and save it to your Microsoft Word template folder, for example C:\Users\<user name>\AppData\Roaming\Microsoft\Templates.

Also, to preview your layout template changes before uploading the .rtf file back to the business intelligence (BI) catalog:

  • Generate sample report data from the data model for the report that you're editing.

  • Download a local copy of the subtemplate that applies to the layout template.

Adding Quick Parts Content to Workflow Notifications

To insert content from the Quick Parts gallery into a layout template:

  1. In the BI catalog, find the predefined report with the layout template that you want to modify.

  2. For the report, click More and select Customize.

    If you're not using the Customize option:

    1. Copy the predefined report and paste it in an appropriate subfolder within the Custom folder.

    2. Click the Edit link for the copied report.

  3. Click Edit for the layout template to insert Quick Parts content into, and save the .rtf file to your computer with a new file name.

  4. Open the .rtf file with Microsoft Word.

  5. Put your cursor where you want to insert new content.

  6. From the Insert tab on the ribbon, click Quick Parts within the Text group, and select the component to insert.

  7. Edit the inserted component as needed and add any other components.

  8. Save your changes in Word.

Previewing the Layout Template Changes

To preview your edits before uploading your layout template to the BI catalog:

  1. On the ribbon, open the BI Publisher tab and click Sample XML within the Load Data group to import sample data from the data model. Skip this step if you already loaded sample data.

  2. At the beginning of the document, replace the path with the location of the downloaded subtemplate file on your computer. For example, change <?import:xdoxsl:///Common Content/Templates/Workflow Notification Subtemplate.xsb?> to <?import:file:///C:/Template_Directory/FinFunWorkflowNotificationSub.rtf?>.

  3. From the BI Publisher tab on the ribbon, click HTML in the Preview group.

  4. If the preview reflects your changes as expected, then change the path back to the original location.

  5. Save your changes in Word.

Uploading the Modified Layout Template

To upload your layout template to the BI catalog after previewing the changes:

  1. Back in the BI catalog, click Edit for the report within the Custom folder, if that page isn't still open.

  2. Click the View a list link.

  3. Click the Create icon on the table toolbar.

  4. In the Upload or Generate Layout section, click Upload.

  5. Upload your edited .rtf file with a unique layout name.

  6. Back on the page for editing the report, click Delete for the layout template that you downloaded earlier.

  7. Click the Save Report icon.

Preview Changes to Layout Templates for Workflow Notifications

To modify workflow notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word. Before uploading the .rtf files to the business intelligence (BI) catalog, you should preview the output with the changes you made. You can avoid uploading a broken report that displays an error in the notifications sent to users.

Note: The exact steps can vary depending on your version of Microsoft Word.

Prerequisites

  • Generate sample report data from the data model used for the report, and save the .xml file to your computer.

  • Download a local copy of the subtemplate that applies to your own report layout template:

    1. In the BI catalog, expand Shared Folders > Custom > Common Content > Templates if you're using a modified subtemplate, or Shared Folders > Common Content > Templates for the predefined subtemplate.

    2. Click Edit for Workflow Notification Subtemplate.

    3. In the Templates section, click the link in the Locale column.

    4. Save the subtemplate .rtf file to your computer.

Previewing Output

To generate sample output from a local layout template:

  1. Open your .rtf report layout template in Microsoft Word and make your edits.

  2. On the ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  3. Select the .xml file you downloaded to import sample data from the data model.

  4. At the beginning of your .rtf document, replace the path with the location of the downloaded subtemplate file on your computer. For example, change <?import:xdoxsl:///Common Content/Templates/Workflow Notification Subtemplate.xsb?> to <?import:file:///C:/Template_Directory/FinFunWorkflowNotificationSub.rtf?>.

  5. From the BI Publisher tab on the ribbon, click HTML in the Preview group.

  6. If the preview reflects your changes as expected, then change the path back to the original location.

  7. From the BI Publisher tab on the ribbon, click Validate Template in the Tools group.

  8. Also in the Tools group, click Check Accessibility.

  9. Save your changes in Word.

Apply Changes to Workflow Notifications Soon After Upload

Configurable workflow notifications are refreshed every 24 hours so that they perform better for your users. But when you're making changes to reports, subtemplates, or data models, you can apply your changes sooner so they're available for testing. Create profile options to control when notifications reflect your changes after you upload them to the BI catalog. When you're done configuring notifications, use the same profile options to turn the refresh back to every 24 hours, to optimize performance. But even if you don't, the refresh automatically resets to 24 hours when it's been more than eight hours since you set the profile options.

Note: The refresh applies only to changes uploaded to the BI catalog and the actual notifications that are then sent out with your changes. You can always preview changes to layout templates while you're editing in Microsoft Word or view the report in BI Publisher.

Create Profile Options to Control the Refresh

Your profile options can apply to all workflow tasks, a product family, or a product. Based on the scope you want, your profile option must have a profile option code that follows a certain format.

Scope Profile Option Code Examples

Global

BIP_CLIENT_REFRESH_TIME

BIP_CLIENT_REFRESH_TIME

Product Family

BIP_CLIENT_REFRESH_TIME_<FAMILY>

  • BIP_CLIENT_REFRESH_TIME_FIN

  • BIP_CLIENT_REFRESH_TIME_HCM

  • BIP_CLIENT_REFRESH_TIME_PRC

  • BIP_CLIENT_REFRESH_TIME_PRJ

  • BIP_CLIENT_REFRESH_TIME_SCM

Product

BIP_CLIENT_REFRESH_TIME_<FAMILY>_<PRODUCT>

  • BIP_CLIENT_REFRESH_TIME_FIN_AP

  • BIP_CLIENT_REFRESH_TIME_HCM_PER

  • BIP_CLIENT_REFRESH_TIME_PRC_PON

  • BIP_CLIENT_REFRESH_TIME_PRJ_PJE

  • BIP_CLIENT_REFRESH_TIME_SCM_EGO

The profile options with a smaller scope take precedence. For example, you have profile option A with a global scope and profile option B with a product scope. If you're currently configuring notifications for a particular product, use profile option B to adjust the refresh time just for that product. But based on profile option A, the refresh is still at 24 hours for all other configurable notifications in all other products. Profile option B takes precedence over profile option A only for that one product.

Tip: To find the product family or product code, go to the Setup and Maintenance work area. Use the Manage Taxonomy Hierarchy task in the Application Extensions functional area for any offering. In the hierarchy, expand the root node and then the Oracle Fusion node. Find the row for the family or product and look in the Module Key column for the code.

Now you're ready to create your profile options!

  1. In the Setup and Maintenance work area, go to the Manage Applications Core Profile Options task in the Application Extensions functional area for your offering.

  2. On the Manage Applications Core Profile Options page, click the New icon.

  3. On the Create Profile Option page, enter the profile option code in the format that corresponds to the scope you want.

  4. Enter a display name that you can easily remember to help you find the profile option later.

  5. From the Application list, select Oracle Middleware Extensions for Applications.

  6. From the Module list, select Application Core.

  7. Specify a start date.

  8. Click Save and Close.

  9. On the Manage Applications Core Profile Options page, make sure your new profile option is selected in the Search Results: Profile Options subsection.

  10. In the <Profile Option>: Profile Option Levels subsection, select the Enabled and Updatable check boxes for the Site level.

  11. Save your work.

Set the Refresh Interval

In the Setup and Maintenance work area, go to the Manage Applications Core Administrator Profile Values task in the Application Extensions functional area. Set your profile option at the Site level and enter 15 or higher for the refresh interval in minutes. For example, if you enter 15, then your changes are applied to notifications 15 minutes after you upload to the BI catalog.

Caution: Make sure to enter a whole number.

When you're done making and testing your changes, set the profile option back to 1440, which is 24 hours in minutes. If you forget and leave your profile option as is for longer than eight hours, don't worry! At that point, the profile option resets itself back to 1440 minutes.