5Analytics Modification

This chapter contains the following:

Overview of Analytics Creation and Modification

You can edit and create your own analytics on your transactional data. The predefined analyses and dashboards help answer many of your business questions. But you can also create your own to meet your requirements.

Note: You can't use Direct Database Query in your analysis. Direct Database Query isn't supported in SaaS OTBI. To create a direct database SQL report, you can create a BI Publisher SQL data model and then create a report.

This table lists a few examples.

Task Example

Create an analysis

Your team needs a simple list of all your accounts, sorted by account ID. You include the account name, ID, and address in a new analysis, and sort the ID column.

Create a view

A predefined analysis has a bar graph. You save a new version of the analysis with a table view added to the graph.

Create a view selector

You later decide you want to toggle between viewing a table and a graph. You add a view selector that includes the table and graph views.

Edit a dashboard prompt

A predefined dashboard has a Start Date prompt. You make a copy of the dashboard and replace Start Date with a date range prompt.

Create a dashboard

You create a dashboard that includes an analysis and a report, which you can view together. You also add a dashboard prompt to filter both the analysis and the report.

Tip: When you create or edit analyses, you can use a wizard in the Reports and Analytics work area and panel tab.

Flexfield Attributes

Administrators can modify the business intelligence (BI) repository to determine the columns available for you to use in analyses.

Analyses

Use the wizards to quickly create and edit your analytics. You can use a wizard to create and edit most of your analytics, for example to select columns, add filters or views. You can also use advanced business intelligence features to create or edit dashboards or manage analyses and other objects in the catalog.

Create an Analysis

  1. Click Tools > Reports and Analytics in the Navigator.

  2. In the Reports and Analytics work area or the Reports and Analytics panel tab (if available), click Create and select Analysis.

  3. Select the subject area with columns you want to include.

  4. Optionally, click Add/Remove Subject Areas and, in the Add/Remove Subject Areas dialog box, select more subject areas or remove any that you no longer need, then click OK.

  5. Select the columns to include, set options for each column, and click Next.

  6. Optionally, enter a title for the analysis.

  7. Select the type of table or graph to include, specify the layout of the views, and click Next.

    Note: At any point after this step, you can click Finish to go to the last step, to save your analysis.
  8. Optionally, set more options for the table or graph, and click Next.

  9. Optionally, add sorts or filters based on any of the columns you included, and click Next.

  10. If you have a table, optionally define conditional formatting for select columns, for example to display amounts over a certain threshold in a particular color. Click Next.

  11. Enter the name of your analysis and select a folder in the Custom folder or My Folder to save it in.

  12. Click Submit.

Edit an Analysis

  1. Click Tools > Reports and Analytics in the Navigator.

  2. Select your analysis and edit it. In the Reports and Analytics work area, click More for the analysis and select Edit. In the Reports and Analytics panel tab, click the analysis, then click Edit.

  3. Perform steps 4 through 10 from the preceding Create an Analysis task, as needed.

  4. To update an existing analysis in the Custom folder, select the same name in the same folder. To save this analysis as a new copy, either name it with a new name or save it in a new folder in the Custom folder.

  5. Click Submit.

How You Create an Absences by Department Analysis

You are an HR specialist and you want to create an analysis to help you review what types of absences are occurring across all departments.

These are key decisions you need to make for creating the analysis.

Decisions to Consider In This Example

What information to include?

  • Department name

  • Absence reason

  • Number of absences

What type of layout is required?

Table with a bar graph below it.

Do the table columns require any special formatting?

Yes, for the purpose of easier scanning. For the table, associate colors with thresholds so that 30 or more absences of one type are highlighted in red. And, associate colors with thresholds so that 10 or fewer absences of one type are highlighted green.

Is this analysis available for others to use?

No. Save it to My Folders.

To create an analysis of absences by department, complete these tasks:

  1. Select columns

  2. Define the layout

  3. Add column formatting

  4. Save the analysis

Selecting Columns

  1. Navigate to the Reports and Analytics work area.

  2. Click Create.

  3. Select Analysis.

  4. In the Select Subject Area window, select the Workforce Management - Absence Real Time subject area.

  5. On the Create Analysis: Select Columns page, expand the Workforce Management - Absence Real Time folder.

  6. Expand the Department folder.

  7. Select Name and click the Add icon button to move the column to the Selected Columns area.

  8. Expand the Absence Reason folder.

  9. Select Absence Reason Name and click the Add icon button to move the column to the Selected Columns area.

  10. Expand the Assignment Absences folder.

  11. Select # Of Absences and click the Add button to move the column to the Selected Columns area.

  12. Click Next.

Defining the Layout

  1. On the Create Analysis: Select Views page, enter Absence by Department in the Name field.

  2. Next to the Table field, click None to open the Table menu.

  3. Select Table (recommended).

  4. Next to the Graph field, click None to open the Graph menu.

  5. Select Bar (recommended).

  6. Use the default layout value of Table above Graph.

  7. Click Next.

  8. On the Create Analysis: Edit Graph page, click Next.

  9. On the Create Analysis: Sort and Filter page, click Next.

Adding Column Formatting

  1. On the Create Analysis: Highlight page, click Add Column Format in the Formatting region.

  2. Select # Of Absences.

  3. In the first Threshold field, enter 10, and click the down arrow in the first Color field. Select the color Green.

    Tip: If you hover over the colors, hover text shows the name of the color.

  4. In the second Threshold field, enter 30, and click the down arrow in the third Color field. Select the color Red (leave the second color yellow).

  5. Click Next.

Saving the Analysis

  1. In the Create Analysis: Save page, Save In region, enter Absence by Department in the Analysis Name field, enter a description, and then select My Folders.

  2. Click Submit.

  3. Click OK.

Manage Analytics with Advanced Features

Wizards are an easy way to create or edit analyses. But you might have to use advanced features for complicated analyses or specific requirements. For example, you can create view selectors so that users can toggle between views within an analysis, or define criteria for filters using SQL statements.

You can also perform other actions on analyses, for example delete them or copy and paste them within the business intelligence catalog.

How to Create and Edit Analytics

  1. In the Reports and Analytics work area or the Reports and Analytics panel tab (if available), click the Browse Catalog button.

  2. Click the New button, select Analysis in Analysis and Interactive Reporting, and select a subject area.

    Or, select your analysis in the catalog and click Edit.

  3. This table lists the ways you can use the tabs.

    Tab Task

    Criteria

    Select and define the columns to include.

    Add filters.

    Results

    Add views and set options for results.

    Prompts

    Define prompts to filter all views in the analysis.

    Advanced

    View or update the XML code and logical SQL statement that the analysis generates.

    Set options related to query performance.

    Note: To create an analysis using SQL in the Advanced tab, you must be a Business Intelligence Administrator or have the Create Analysis From Simple SQL privilege.

  4. Save your analysis.

More Actions on Analytics

  1. In the Reports and Analytics work area or the Reports and Analytics panel tab (if available), select your analysis and click Action and select More..

  2. Click More for your analysis and select the action you want, for example Delete or Copy.

How can I provide access to a custom analysis or report to multiple users?

By default, shared analyses and reports are owned by the duty role of the user who created them. All users with that duty role are able to view, modify, and save the objects.

How You Take Advantage of Sample Reports

Here's how to create an analysis using a sample report from Customer Connect.

After you find and download a sample report from Customer Connect you can use it in Business Intelligence. You can download a catalog file that may contain multiple reports or the XML source for a report.

Find Sample Reports

First, go to the Customer Connect website and login. You must register if you don't already have an account.
  1. Go to https://cloudcustomerconnect.oracle.com and enter your user name and password.

  2. On the Customer Connect Home page, click the Forums link and select Reporting and Analytics then HCM Report Sharing Center.

  3. In the Shared Reports list, scroll down and select a report. For example, you can select Headcount by Age Band.

    You can see details about each report as well as a view to confirm which report to use.

  4. Click the link below the image of the report to download it.

To use a Catalog Report
Once you have located and saved a catalog file, you can upload it to Business Intelligence. Have Business Intelligence open in another tab.
  1. In the Folders section, click My Folders.

  2. In the Tasks section, click Unarchive.

  3. Click Browse, and navigate to the catalog file.

  4. Click Open.

    Place your analysis in My Folders or in the Custom folder under Shared Folders. If you place the analysis anywhere else it will be lost in the next upgrade.

  5. In the list of reports, find the name of the report you want to use and click Open.

Use an XML Report

In Customer Connect, you can use keywords to search for a report. Once you have downloaded the report, you place the content in Business Intelligence. Have Business Intelligence open in another tab.
  1. In Customer Connect, click the HCM Report Sharing Center tab.

  2. In the Keywords field, enter workforce trend or other search term.

  3. Press Enter.

  4. Click a report name link to view details and then download it from that page, or click the XML file name to download it from the list of Posts.

  5. Click OK.

  6. Open the file you downloaded in Notepad, select all of the content, and copy it to the clipboard.

    You can use Ctrl+A and Ctrl+C.

  7. Switch tabs to Business Intelligence. In the Catalog toolbar, click New and choose Analysis.

  8. Select a subject area. For example, Workforce Performance Rating Distribution.

    You can choose any subject area ending in Real Time.

  9. Click the Advanced tab and press Ctrl+A to select all existing code. Press Delete.

    Make sure you delete all of the existing code before pasting the new code.

  10. Press Ctrl+V to paste the content from Customer Connect.

  11. Click Apply XML.

  12. To run the report, click the Results tab.

    You can edit the report, such as adding custom or flex fields if needed.

  13. Click Save. Navigate to where you want to save the analysis within My Folders or in the Custom folder under Shared Folders.

    You must save the analysis in one of these locations to assure that the report is not lost during an upgrade.

  14. Enter a name and optionally a description.

  15. Click OK.

Cross-Subject Area Joins

Overview of Cross-Subject Area Joins

You can create analyses that combine data from more than one subject area, or cross-subject area analyses. Review guidelines for creating these joins in MyOracle Support (Doc ID 1567672.1). Cross-subject area analyses can be classified into three broad categories:

  • Using common dimensions.

  • Using common and local dimensions.

  • Combining more than one result set from different subject areas using set operators such as union, union all, intersection and difference.

Common Dimensions

A common dimension is a dimensional attribute that exists in all subject areas in the analysis. These dimensions are considered common dimensions between subject areas and can be used to build a cross-subject area report.

Common and Local Dimensions

A local dimension is available only in one of the combined subject areas in a cross-subject area query.

Create a Cross-Subject Area Analysis

To create a cross-subject area analysis, include a measure from each subject area to support the join if it uses a local dimension. You can hide the measure in the results if you don't want it to appear in your analysis.

How to Create a Cross-Subject Area Analysis

  1. In the Reports and Analytic work area, click Browse Catalog.

  2. Click New and select Analysis

  3. Select a subject area.

  4. In the Criteria tab, expand the dimensions and add a column to the analysis.

  5. In the Subject Areas region, click Add/Remove Subject Areas.

  6. In the Subject Area region of the Criteria tab, expand the dimensions and add a column to the analysis.

  7. If the column is a local dimension, add a measure from the subject area. In any join query, you must add at least one measure from all subject areas involved, otherwise unexpected results or errors might occur. If it's preferable to hide the measure in your analysis, select its Column Properties, and in the Column Format tab of the Column Properties dialog box, select the Hide check box and click OK.

  8. If you're using a local dimension, in the Advanced tab, navigate to the Advanced SQL Clauses section, select Show Total value for all measures on unrelated dimensions, then click Apply SQL.

  9. Click the Results tab to see the analysis results.

  10. Click the Criteria tab again to return to the analysis definition.

Effective-Date Reporting for HCM

The ability to report as of a specific date depends on whether you're reporting on event-type measures or non-event type measures.

Event-Type Measures

Event-type measures in Transactional Business Intelligence are those that include a time dimension, or specific date associated with them. Examples include assignment events, absences, and performance. Because these measures have specific dates associated with them, you can run queries against them as of a specific date. You can produce trend reports for any subject area that has the time dimension, meaning any subject area that contains event-type measures.

Non-Event Type Measures

Non-event type measures don't have a specific date associated with them. Examples include headcount and salary. Transactional Business Intelligence is designed to report on non-event measures as of the current date. To report on non-event measures as of a specific date, add a prompt for the date to your analysis. And, add this SQL statement to the analysis: SET VARIABLE PARAM_EFFECTIVE_DATE='@{AsOfDate}';

How You Create a Date-Effective Headcount Analysis

Here's how you create a report with effective-date reporting capability for a nonevent measure. The nonevent measure in this example is headcount. You want an analysis to review headcount by department, but headcount isn't a specific event. Using the Workforce Management - Worker Assignment Real Time subject area, add a prompt for the effective date. This lets you review the data as of a specific date.

Here are the key decisions for this scenario.

Decisions to Consider In This Example

Which subject areas are needed?

Workforce Management - Worker Assignment Real Time

Does the analysis require an SQL statement?

Yes. An SQL statement is needed for the effective date capability.

Create a Date-Effective Analysis for Headcount

  1. Navigate to the Reports and Analytics pane

  2. Click Browse Catalog.

  3. Click the New menu, and select Analysis.

  4. In the Select Subject Area window, select the Workforce Management - Worker Assignment Real Time subject area.

  5. In the Subject Areas region of the Criteria tab, expand the Worker Assignment folder.

  6. Select Headcount and drag it to the Selected Columns region.

  7. Expand the Department folder, select Name, and drag it to the Selected Columns region.

  8. Select the Prompts tab.

  9. On the right side of the page on the Prompts tab, click New and select Variable prompt.

  10. In the New Prompt window, leave the value of Presentation Variable in the Prompt for field, and enter AsOfDate.

  11. In the Label field, enter Workers as of (mm/dd/yyyy).

  12. Expand the Options region.

  13. In the Variable Data Type menu, select Date.

  14. Select the Require user input option.

  15. Select Dynamic for the Text Field Width.

  16. Click OK.

  17. Select the Advanced tab.

  18. On the Advanced tab, scroll down to the Advanced SQL Clauses region.

  19. In the Prefix field, enter SET VARIABLE PARAM_EFFECTIVE_DATE='@{AsOfDate}';

  20. Click Apply SQL.

  21. Click OK to clear the message.

  22. Click Save Analysis.

  23. In the Save As window, select My Folders and enter Date-Effective Headcount in the Name field.

  24. Click OK.

  25. At the top of the page, click the Home link to return to the OTBI EE home page.

  26. Locate your report in the Recent region.

  27. Click Open.

  28. In the Workers as of mm/dd/yyyy field, enter an effective date in the proper format.

  29. Click OK.

  30. Review the results in the Headcount field.

Cross-Subject Area Analyses

Cross-Subject Area Analyses

You can create analyses that combine data from more than one subject area. This type of query is referred to as a cross-subject area analysis. Cross-subject area analyses can be classified into three broad categories:

  • Using common dimensions

  • Using common and local dimensions

  • Combining more than one result set from different subject areas using set operators such as union, union all, intersection, and difference.

Common Dimensions

A common dimension is a dimension that exists in all subject areas that are being joined in the report. For example, Workforce Management - Worker Assignment Real Time and the Workforce Management - Worker Assignment Event Real Time subject areas have Worker, Job, and Department available. These dimensions are considered common dimensions between these two subject areas and they can be used to build a cross-subject area report.

Common and Local Dimensions

The Worker Assignment Details dimension in the Workforce Management - Worker Assignment Real Time subject area isn't available in the Workforce Management - Worker Assignment Event Real Time subject area. Therefore it's a local dimension for the purposes of a cross-subject area query between these two subject areas.

How To Create a Cross-Subject Area Analysis for HCM

Here's how to create a real-time analysis that includes more than one subject area, which is referred to as a cross-subject area analysis. In this example, you create an analysis of headcount by department with the annualized salary in the local currency.

These are the key decisions for this scenario.

Decisions to Consider In This Example

Which subject areas are needed?

For headcount by department, select Workforce Management - Worker Assignment Real Time.

For salary, select Compensation - Salary Details Real Time.

Does the analysis require an SQL statement?

Yes, to join the two subject areas.

Create a Cross-Subject Area Analysis

  1. In the Reports and Analytics work area, click Browse Catalog.

  2. Click New and select Analysis.

  3. In the Select Subject Area window, select the Workforce Management - Worker Assignment Real Time subject area.

  4. In the Subject Area region of the Criteria tab, expand the Department folder.

  5. Click Name and drag it to the Selected Columns area.

  6. Expand the Worker Assignment folder.

  7. Click Headcount and drag it to the Selected Columns area to the right of the Department Name column.

  8. In the upper-right corner of the Subject Areas region, click Add/Remove Subject Areas.

  9. In the Add/Remove Subject Areas window, select Compensation - Salary Details Real Time.

  10. Click OK.

  11. In the Subject Areas region of the Criteria tab, expand the Compensation - Salary Details Real Time folder.

  12. Expand the Salary folder.

  13. Click Annualized Salary and drag it to the Selected Columns area to the right of the headcount column.

  14. Click the Results tab to see the results of the analysis.

  15. Click the Criteria tab again to return to the analysis definition.

  16. In the Subject Areas region on the Criteria tab, expand the Salary Details folder in the Compensation - Salary Details Real Time folder.

  17. Click Apps Local Currency Code and drag it to the Selected Columns area to the right of the Annualized Salary column.

  18. Click the Results tab to view the report again. The headcount column is now blank.

  19. To correct the blank headcount, click the Advanced tab.

  20. On the Advanced tab, scroll down to the Advanced SQL Clauses region.

  21. Select the Dimension check box.

    When you select this check box, the logical SQL is appended with the following request variable value, enabling you to join the two subject areas: SET VARIABLE ENABLE_DIMENSIONALITY = 1;

  22. Click Apply SQL.

  23. In the Message from Web page window, click OK.

  24. Click the Results tab again to see that the headcount column now has numbers.

  25. Click Save Analysis.

  26. Save to My Folders, and enter Headcount by Department in the Name field, and enter a description for your analysis.

Dashboards

Create and Edit Dashboards

You can create and edit dashboards and define their content and layout to organize your analytics and other objects to create meaningful and navigable palettes of information. In addition to objects in the business intelligence (BI) catalog, such as analyses, reports, and prompts, you can add text, sections, and more to a dashboard.

Create a Dashboard

  1. Open the Reports and Analytics work area, or the Reports and Analytics panel tab (if available).

  2. Click Browse Catalog.

  3. Click New and select Dashboard.

  4. Enter the dashboard's name and description, and select a folder to save in.

  5. With the Add content now option selected, click OK.

  6. Optionally, add more pages, or tabs, within the dashboard.

  7. Bring items from the Dashboard Objects or Catalog pane to add content to a page.

  8. Click Save.

Note: The first dashboard page is saved with the page 1 name by default. To rename this page:
  1. Click the Catalog link.

  2. In the Folders pane, select your dashboard.

  3. For page 1, click More and select Rename.

  4. Enter the new name and click OK.

Edit a Dashboard

  1. In the Reports and Analytics work area or the Reports and Analytics panel tab (if available) select your dashboard in the pane and click More.

  2. Select your dashboard in the pane and click More.

  3. Click Edit.

  4. Perform steps 6 and 7 from the preceding Creating Dashboards task, and make other changes as needed, for example:

    • Remove content from the dashboard.

    • Move content around.

    • Change the layout of a page.

Configurable Email Notifications

Overview of HCM Configurable Workflow Notifications

As part of workflow tasks, the workflow automatically sends notifications to your users. For example, when a user submits a performance goal for approval, the approvers receive a notification with the approval request. For some flows, Oracle Business Intelligence (BI) Publisher reports determine the notification content and format, and you can edit the report to configure the email and in-app notifications. These report-based notifications are configurable, and optimized for viewing on mobile devices. In addition to getting notifications in email, users can also view in-app notifications, for example 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

Such business flows include the following HCM workflow tasks:

  • Absence recording approvals

  • Discretionary disbursement approvals

  • Donation approvals

  • Profile management

  • Profile approvals

  • Goal management

  • Goal approvals

  • Career development

  • Feedback

  • Performance management

  • Performance document approvals

  • Talent review

  • Add assignment

  • Add contact

  • Add contingent worker

  • Add nonworker

  • Add pending worker

  • Add terms

  • Approve time cards

  • Change assignment

  • Change manager

  • Change work schedule

  • Change working hours

  • Create contracts

  • Document records

  • Manage areas of responsibility

  • Manage checklists

  • Manage directs

  • Employment

  • Manage grades

  • Manage grade ladders

  • Manage grade rates

  • Manage jobs

  • Manage locations

  • Manage organizations

  • Manage positions

  • Work relationship

  • New hire

  • Person external identifiers

  • Person notes

  • Personal information

  • Promotion

  • Share information

  • Termination

  • Transfer

Process Overview

The process to generate email and in-app notifications is the same as generating other types of report output. The process involves various types of objects in the business intelligence catalog, including data models, subtemplates, style templates, and reports.

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 goal management approval notifications report contains the PerformanceGoalApprovalNotificationsReport layout template and uses the PerformanceGoalApprovalNotificationsDM data model. The generated output is included in emails that are sent to users for goal approval.

Notification Modifications

After you enable configurable email and in-app notifications, the predefined reports and related objects in the BI catalog work by default. The report-based notifications provide the same information as the standard notifications, but in a format optimized for mobile devices. If you must modify the notifications, you can edit copies of the predefined reports and data models, but not the style template. You proceed as you would to edit any report or data model in the catalog, for example:

  1. Find a predefined report for goal approvals in the business intelligence catalog.

  2. Use the Customize option to create a copy of the report that's linked to the original.

  3. Edit the copied report layout template.

For more information about configuring reports, see Oracle Human Capital Management Cloud Creating and Administering Analytics and Reports. You should get familiar with reports and BI Publisher in general before configuring workflow email and in-app notifications. Aspects specific to email and in-app notifications include:

  • You use only the Template Builder for Word add-in to configure the .rtf template in Microsoft Word. You don't use the layout editor or other tools available for configuring report layout.

  • You usually edit a copy of predefined layout templates, rather than create reports or layout templates.

Security

To configure reports and data models for email and in-app notifications, you must have one of these duty roles or privilege:

  • BI Platform Administrator duty role

  • Publisher Data Model Developer duty role

  • Manage BI Publisher Template privilege

Setup

You configure profile options to specify the HCM applications that use the BI Publisher reports rather than the default FYI and approval notifications. To use BI Publisher reports rather than the default workflow and approval notifications, you must:

  • Configure profile options for email and in-app notifications to specify the HCM applications that use the BI Publisher reports.

  • Download and install the Template Builder for Word add-in.

You configure profile options using the Manage Administrator Profile Values task in the Setup and Maintenance work area.

This table shows the profile option codes that determine which business processes use BI Publisher templates for email notifications. It also describes the effect of each code.

Business Processes Profile Option Code Profile Display Name Effect

All Absence Management

BIP_EMAIL_NOTIFICATION_HCM_ANC

BIP_EMAIL_NOTIFICATION_HCM_ANC

The application first checks this setting. If set to true, all Absence Management business processes that can use BI Publisher reports for workflow notifications use them.

All Global Human Resources

BIP_EMAIL_NOTIFICATION_HCM_PER

BI Publisher Notifications Enabled for Global Human Resources

The application first checks this setting. If set to true, all Global Human Resources business processes that can use BI Publisher reports for workflow notifications use them.

All Talent Management

BIP_EMAIL_NOTIFICATION_HCM_TALENT

BI Publisher Notifications Enabled for Talent Management

The application first checks this setting. If set to true, all Talent Management business processes that can use BI Publisher reports for workflow notifications use them.

All HCM

BIP_EMAIL_NOTIFICATION_HCM

BIP EMAIL NOTIFICATION PER FAMILY LEVEL

The application checks this setting next. If set to true, all HCM business processes that can use BI Publisher reports for workflow notifications use them.

This table shows the profile option codes that determine which business processes use BI Publisher templates for in-app notifications. It also describes the effect of each code.

Business Processes Profile Option Code Profile Display Name Effect

All Absence Management

BIP_ONLINE_NOTIFICATION_HCM_ANC

BIP_ONLINE_NOTIFICATION_HCM_ANC

The application first checks this setting. If set to true, all Absence Management business processes that can use BI Publisher reports for in-app notifications use them.

All Global Human Resources

BIP_ONLINE_NOTIFICATION_HCM_PER

BI Publisher Worklist Notifications Enabled for Global Human Resources

The application first checks this setting. If set to true, all Global Human Resources business processes that can use BI Publisher reports for in-app notifications use them.

All Talent Management

BIP_ONLINE_NOTIFICATION_HCM_GOALS

BI Publisher Worklist Notifications Enabled for Goals and Career Management

The application first checks this setting. If set to true, all Talent Management business processes that can use BI Publisher reports for in-app notifications use them.

All Talent Management

BIP_ONLINE_NOTIFICATION_HCM_TALENT

BI Publisher Worklist Notifications Enabled for Talent Management

The application first checks this setting. If set to true, all Talent Management business processes that can use BI Publisher reports for in-app notifications use them.

Templates and Data Models Used for HCM Notifications Based on Reports

You can configure Oracle Business Intelligence (BI) Publisher reports to send notifications (email and in-app) for some HCM workflow tasks. Each business process uses different BI Publisher templates and data models for the email and in-app notifications.

Templates and Associated Data Models

This table shows the BI Publisher templates and the associated data models that are available for each business process.

Business Process Template (Data Model)

Career Development

CareerDevelopmentApprovalFYIReport (CareerDevelopmentApprovalNotificationDM)

CareerDevelopmentApprovalReport (CareerDevelopmentApprovalNotificationDM)

CareerDevelopmentFYINotification (CareerDevelopmentFyiDM)

Feedback

NoteSentToManagerReport (PersonNotes)

NoteSentToWorkerReport (PersonNotes)

Goal Management

PerformanceGoalApprovalNotificationsReport (PerformanceGoalApprovalNotificationsDM)

PerformanceGoalNotificationsReport (PerformanceGoalNotificationsDM)

Performance Management

PerformanceApprovalNotificationsReport (PerformanceApprovalDM)

PerformanceFyiNotificationsReport (PerformanceFYIDM)

Profile Management

ProfileChangeNotificationReport (ProfileChangeNotification)

ProfilesApprovalNotificationFYIReport (ProfilesApprovalNotificationDM)

ProfilesApprovalNotificationReport (ProfilesApprovalNotificationDM)

Talent Review

TalentCalibFYIReport (TalentCalibFYIDM)

Time and Labor

ApprovalEmailNotification (ApprovalEmailNotification)

Workforce Deployment

AddAssignmentReport (EmploymentCreateProcesses)

AddContactReport (AddContact)

AddCWKReport (EmploymentCreateProcesses)

AddNWKReport (EmploymentCreateProcesses)

AddPWKReport (EmploymentCreateProcesses)

AddTermsReport (EmploymentCreateProcesses)

AddWorkRelationshipReport (EmploymentCreateProcesses)

AssignmentChangeReport (EmploymentUpdateProcesses)

CancelWorkRelationshipReport (EmploymentWRProcesses)

ChangeLegalEmployerReport (EmploymentCreateProcesses)

ChangeLocationReport (EmploymentUpdateProcesses)

ChangeManagerReport (EmploymentUpdateProcesses)

ChangeSalaryReport (ChangeSalary)

ChangeWorkHoursReport (EmploymentUpdateProcesses)

CreateGradeLadderReport (ManageGradeLadders)

CreateGradeRateReport (ManageGradeRates)

CreateGradeReport (ManageGrades)

CreateJobReport (ManageJobs)

CreateLocationReport (ManageLocations)

CreateOrganizationReport (ManageOrganizations)

CreatePositionReport (ManagePositions)

DeleteGradeLadderReport (ManageGradeLadders)

DeleteGradeRateReport (ManageGradeRates)

DeleteGradeReport (ManageGrades)

DeletePositionReport (ManagePositions)

EligibleJobsReport (EmploymentUpdateProcesses)

ExternalIdentifierReport (ExternalIdentifier)

ManageDirectsReport (EmploymentUpdateProcesses)

ManageDorReport (ManageDOR)

ManageEmploymentReport (EmploymentUpdateProcesses)

ManageWorkRelationshipReport (EmploymentWRProcesses)

NewHireReport (EmploymentCreateProcesses)

NoteSentToManagerReport (PersonNotes)

NoteSentToWorkerReport (PersonNotes)

NotifyCopyConflictReport (EmploymentWRProcesses)

NotifyDeleteConflictReport (EmploymentWRProcesses)

NotifyMultipleConflictReport (EmploymentWRProcesses)

NotifyWithdrawConflictReport (EmploymentWRProcesses)

PersonalInformationReport (PersonalInformation)

PromotionReport (EmploymentUpdateProcesses)

ResponsibilityInfoFYIReport (ManageAOR)

ResponsibilityInfoReport (ManageAOR)

ShareInfoApprovalFYIReport (ShareInformation)

ShareInfoApprovalReport (ShareInformation)

ShareInfoFYIReport (ShareInformation)

ShareInfoRejectFYIReport (ShareInformation

TerminationReport (EmploymentWRProcesses)

TransferReport (EmploymentUpdateProcesses)

UpdateGradeLadderReport (ManageGradeLadders)

UpdateGradeRateReport (ManageGradeRates)

UpdateGradeReport ((ManageGrades))

UpdateJobReport (ManageJobs)

UpdateLocationReport (ManageLocations)

UpdateOrganizationReport (ManageOrganizations)

UpdatePositionReport (ManagePositions)

ChecklistWelcomeReport (ChecklistWelcomeDataModel)

TaskActionRequiredReport (TaskNotificationDataModel)

TaskFYIReport (TaskNotificationDataModel)

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.

Configure Feedback Notifications Using Reports

This example shows how to configure workflow email and in-app notifications for feedback using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

NoteSentToManager, for updates to notifications about feedback sent to managers

Do I add prompts and headers to the template?

Yes

Do I add data model attributes to the template?

Yes, for DISPLAY_NAME and WORKER_DISPLAY_NAME

Which language do I use for the .rtf template?

English (United States)

Summary of the Tasks

Configure a goal management notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your own report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under Person Notes, click Edit to open the Diagram tab on the PersonNotes page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. In the empty text field, enter the Note_ID for an existing feedback note to pull in all the feedback attributes.

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export.

  9. In the Opening PersonNotes dialog box, select Save File and click OK.

  10. Save the PersonNotes_.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under NoteSentToManagerReport, click More, and then select Customize. A copy of the NoteSentToManagerReport is created automatically in the Custom folder.

  5. On the NoteSentToManagerReport page, under NoteSentToManagerReport, click Edit.

  6. On the Opening NoteSentToManagerReport.rtf dialog box, select Save File and click OK to save the document to your local hard drive. Save the template with the name UpdatedNoteSentToManagerReport.rtf to distinguish it from the original template.

Editing the Template

To modify workflow email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedNoteSentToManagerReport.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Place the cursor at the end of the text AUTHOR_DISPLAY_NAME added feedback about WORKER_DISPLAY_NAME.

  3. Enter recently.. The text now reads AUTHOR_DISPLAY_NAME added feedback about WORKER_DISPLAY_NAME recently.

  4. Place the cursor in front of the feedback code that includes <html2fo: NOTE_TEXT> and press the Enter key to add a line.

  5. Enter Check out this feedback:. When you preview the document, the feedback note appears below the text that you entered.

  6. Save the document.

  7. Proceed to the task Previewing the Document.

Previewing the Document

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 emails sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the PerformanceGoalNotificationsDM_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. From the BI Publisher tab in the Ribbon, click HTML in the Preview group.

  5. From the BI Publisher tab in the Ribbon, click Validate Template in the Tools group.

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

  7. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes that exist in the predefined data model. You will add the DISPLAY_NAME and WORKER_DISPLAY_NAME data model attributes to the template.
  1. Open the UpdatedNoteSentToManagerReport.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the PersonNotes_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Place the cursor after the code containing <html2fo: NOTE_TEXT> and press the Enter key twice to add two new lines.

  7. On the new line, enter Author Name:.

  8. On the BI Publisher tab, in the Insert section, click the 123 Field button to open the Field dialog box.

  9. In the AUTHORNAME folder, select DISPLAY_NAME and click Insert. The field appears in the document.

  10. Place the cursor after the data code DISPLAY_NAME and press the Enter key.

  11. On the new line, enter Worker Name:.

  12. On the Field dialog box, in the WORKERNAME folder, select WORKER_DISPLAY_NAME and click Insert. The field appears in the document.

    Note: Ensure that you don't alter or remove the code WORKER_DISPLAY_NAME or Online Notification that appear at the bottom of the template.

  13. Click Close to return to the UpdatedNoteSentToManagerReport.rtf template.

  14. Preview the template using the steps in the Previewing the Document task.

  15. Save and close the document.

  16. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report Layout to the Oracle BI Publisher Catalog

You must perform this task to use the modified report layout for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog

  3. On the Catalog page, in the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under NoteSentToManagerReport, click Edit.

  5. On the NoteSentToManagerReport Data Model page, on the right side of the page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Feedback Notifications Template.

  8. In the Template File field, browse for the modified UpdatedNoteSentToManagerReport.rtf template on your local drive, select the template, and click Open.

  9. In the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box and return to the NoteSentToManagerReport Data Model page.

  12. On the right side of the page, click View a list to open the Layout page.

  13. In the row for the Updated Feedback Notifications Template, select the Default Layout check box.

  14. On the right side of the page, click the Save Report icon.

Configure Workforce Deployment Notifications Using Reports

This example shows how to configure the promotion workflow email and in-app notification for the workforce deployment business process using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

PromotionReport, for updates to notifications about a worker's promotion

Do I add prompts and headers to the template?

Yes

Do I add data model attributes to the template?

Yes, for Person Type and Annual Salary

Which language do I use for the .rtf template?

English (United States)

Summary of the Tasks

Configure a promotion notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your own report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under Promotion data model, click Edit to open the Diagram tab on the Promotion data model page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. Enter the following attributes for the promotion that are key attributes and enable you to pull in all the goal attributes:

    • TransactionID

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export.

  9. In the Opening Promotion_.xml dialog box, select Save File and click OK.

  10. Save the Promotion_.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under PromotionReport, click More, and then select Customize. A copy of the PromotionReport is created automatically in the Custom folder.

  5. On the PromotionReport page, under PromotionReport, click Edit.

  6. On the Opening PromotionReportR11.rtf dialog box, select Save File and click OK to save the document to your local hard drive. Save the template with the name UpdatedPPromotionReport.rtf to distinguish it from the original template.

Editing Prompts and Headers in the Template

To modify email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedPromotionReportR11.rtf.rtf template in Microsoft Word with the Template Builder installed, if not already open. The document contains all notifications for the workforce deployment business process.

  2. Scroll to the notification with the header Promotion Details.

  3. Place the cursor in front of the Description header text.

  4. Enter Your. The text now reads Your Promotion Details.

  5. Scroll to the prompt Mail Stop. Replace Mail Stop with Post Office Box.

  6. Save the document.

  7. Proceed to the task Previewing the Document.

Previewing the Document

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 emails and in-app notification sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the PromotionReportDM_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. At the top 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/Workflow Notification Subtemplate.rtf?>.

  5. From the BI Publisher tab in 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 in the Ribbon, click Validate Template in the Tools group.

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

  9. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes to data model. You will add the Person Type and Annual Salary data model attributes to the template.
  1. Open the UpdatedPerformanceGoalNotifications.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the Promotion_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Scroll to the Employee Details notification.

  7. Place the cursor after Name and press the Enter key.

  8. On the new line, enter Person Type.

  9. Place the cursor after the data code ParentEntityName and press the Enter key to enter a new line.

  10. On the BI Publisher tab, in the Insert section, click the 123 Field button to open the Field dialog box.

  11. In the EMPLOYEEDETAILS folder, select PERSON_TYPE and click Insert. The field appears in the document.

  12. Place the cursor after the data code Department and press the Enter key.

  13. On the new line, enter Annual Salary.

  14. Place the cursor after the data code Department and press the Enter key to enter a new line.

  15. On the Field dialog box, in the EMPLOYEEDETAILS folder, select ANNUAL_SALARY and click Insert. The field appears in the document.

  16. Click Close to return to the PromotionReportR11.rtf template.

  17. Preview the template using the steps in the Previewing the Document task.

  18. Save and close the document.

  19. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report Layout to the Oracle BI Publisher Catalog

You must perform this task to use the modified report layout for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog

  3. On the Catalog page, in the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under the PromotionReport, click Edit.

  5. On the PromotionReport Data Model page, on the right side of the page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Promotion Template.

  8. In the Template File field, browse for the modified Updated PromotionReportR11.rtf template on your local drive, select the template, and click Open.

  9. In the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box and return to the PromotionReport page.

  12. On the right side of the page, click View a list to open the Layout page.

  13. In the row for the Updated Promotion Report Template, select the Default Layout check box.

  14. On the right side of the page, click the Save Report icon.

Configure Notifications in Talent Review Using Reports

This example shows how to configure workflow email and in-app notifications for the talent review business process using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

TalentCalibFYIReport, for updates to notifications about talent review meetings

Do I add prompts and headers to the template?

Yes

Do I add data model attributes to the template?

Yes, for meeting date and meeting ID

Which language do I use for the .rtf template?

English (United States)

Summary of the Tasks

Configure a talent review notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your custom own report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under TalentCalibFYIDM, click Edit to open the Diagram tab on the Talent Calib FYI Data Model page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. Enter the following attributes for an existing meeting that are key attributes and enable you to pull in all the meeting attributes:

    • MeetingId

    • ParticipantId

    • FYINotificationName

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export.

  9. In the Opening TalentCalibFYIDM dialog box, select Save File and click OK.

  10. Save the TalentCalibFYIDM_.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under TalentCalibFYIReport, click More, and then select Customize. A copy of the TalentCalibFYIReport is created automatically in the Custom folder.

  5. On the TalentCalibFYIReport page, under TalentCalibFYIReport, click Edit.

  6. On the TalentCalibFYIReport dialog box, select Save File and click OK to save the document to your local hard drive. Save the template with the name UpdatedTalentCalibReport.rtf to distinguish it from the original template.

Editing Prompts and Headers in the Template

To modify workflow email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedTalentCalibReport.rtf report template using MS-Word. The document contains all notifications for the talent review business process.

  2. Scroll to the first notification with the header Talent Review Meeting Scheduled.

  3. Place the cursor after the You are invited to the talent review meeting MEETING_TITLE. Meeting details are listed in this notification. body text.

  4. Enter Ensure that you update content for your reports before the meeting.

  5. Place the cursor right in front of Meeting Date. Enter Talent Review. The text now reads Talent Review Meeting Date.

  6. Save the document.

  7. Proceed to the task Previewing the Document.

Previewing the Document

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 emails sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the TalentCalibFYIDM_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. From the BI Publisher tab in the Ribbon, click HTML in the Preview group.

  5. From the BI Publisher tab in the Ribbon, click Validate Template in the Tools group.

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

  7. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes that exist in the predefined data model. You will add the Meeting Date and Meeting ID data model attributes to the template.
  1. Open the UpdatedTalentCalibReport.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the TalentCalibFYIDM_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Scroll to the first notification with the header Talent Review Meeting Scheduled.

  7. Place the cursor after Meeting Date and press the Enter key.

  8. On the new line, enter Meeting ID.

  9. Place the cursor after the data code MEETING_DATE and press the Enter key to create a new line.

  10. On the BI Publisher tab, in the Insert section, click the 123 Field button to open the Field dialog box.

  11. In the G_1 folder, select MEETING_ID and click Insert. The field appears in the document.

  12. Click Close to return to the UpdatedTalentCalibReport.rtf template.

  13. Preview the template using the steps in the Previewing the Document task.

  14. Save and close the document.

  15. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report Layout to the Oracle BI Publisher Catalog

You must perform this task to use the modified report layout for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog to open the Catalog page.

  3. In the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under TalentCalibFYIReport, click Edit.

  5. On the TalentCalibFYIReport page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Talent Review Notifications Template.

  8. In the Template File field, browse for the modified UpdatedTalentCalibReport.rtf template on your local drive, select the template, and click Open.

  9. In the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box and return to the TalentCalibFYIDM Data Model page.

  12. On the right side of the page, click View a list to open the Layout page.

  13. In the row for the Updated Talent Review Notifications Template, select the Default Layout check box.

  14. On the right side of the page, click the Save Report icon.

Configure Performance Management Notifications Using Reports

This example shows how to configure workflow email and in-app notifications for the performance management business process using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

PerformanceFyiNotificationsReport

Do I add prompts and headers to the template?

Yes

Do I add predefined data model attributes to the template?

Yes, for Evaluation ID

Which language do I use for the .rtf template?

English

Summary of the Tasks

Configure a performance management notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under PerformanceFyiNotificationsReport Data Model, click Edit to open the Diagram tab on the Performance Fyi NotificationsReport Data Model page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. Enter the Evaluation ID of an actual performance evaluation in the EvaluationID field to pull in all the performance document attributes. The Evaluation ID is a key attribute that enables you to see all available data attributes. Leave any existing sample data in these fields for any other fields.

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export.

  9. In the Opening PerformanceFYIDM dialog box, select Save File and click OK.

  10. Save the PerformanceFYIDM.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under PerformanceFyiNotificationsReport, click More, and then select Customize. A copy of the PerformanceFyiNotificationsReport is created automatically in the Custom folder.

  5. On the PerformanceFYINotificationsReport page, under PerformanceFyiNotificationsReport, click Edit.

  6. On the Opening PerformanceFyiNotificationsReport .rtf dialog box, select Save File and click OK to save the document to your local hard drive. Save the template with the name UpdatedPerformanceFyiNotificationsReport.rtf to distinguish it from the original template.

Editing Prompts and Headers in the Template

To modify workflow email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedPerformanceFYINotifications.rtf template in Microsoft Word with the Template Builder installed, if not already open. The document contains all notifications for the performance management business process.

  2. Scroll to the Performance Document Reopened notification.

  3. Select the Performance Document Reopened header text.

  4. Change the text to Your Manager Reopened Your Performance Document.

  5. Scroll to the body text MGR_NAME reopened your performance document CUSTOMARY_NAME and place your cursor after the period.

  6. Enter You can continue your evaluation.

  7. Scroll to the Review Period text.

  8. Place the cursor right before Review Period. Enter Performance Document. The text now reads Performance Document Review Period. (For TR, using Meeting Date - Enter Talent Review. The text now reads Talent Review Meeting Date.)

  9. Save the document.

  10. Proceed to the task Previewing the Document.

Previewing the Document

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 emails sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the PerformanceFYIDM_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. From the BI Publisher tab in the Ribbon, click HTML in the Preview group.

  5. From the BI Publisher tab in the Ribbon, click Validate Template in the Tools group.

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

  7. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes that exist in the predefined data model.
  1. Open the UpdatedPerformanceFYINotifications.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the PerformanceFYIDM_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Scroll to the Performance Document Reopened notification.

  7. Place the cursor after Review Period and press the Enter key.

  8. On the new line, enter Person ID.

  9. Place the cursor after the data code REVIEW_PERIOD_NAME and press the Enter key to create a new line.

  10. On the BI Publisher menu bar, in the Insert section, click the 123 Field button to open the Field dialog box.

  11. In the PERSON_DETAILS folder, select PERSON_ID and click Insert. The field appears in the document.

  12. Place the cursor after the Person ID text you entered in step 8 and press the Enter key.

  13. On the new line, enter Current Date.

  14. Place the cursor after the data code PERSON_ID you added in step 11 and press the Enter key to add a new line.

  15. In the DATA_DS folder, select PCURRENTDATE and click Insert. The field appears in the document.

  16. Click Close to return to the PerformanceFYINotifications.rtf template.

  17. Preview the template using the steps in the Previewing the Document task.

  18. Save and close the document.

  19. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report to the Oracle BI Publisher Server

You must perform this task to use the customized template for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog

  3. On the Catalog page, in the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under the PerformanceFYIDM, click Edit.

  5. On the PerformanceFyiNotificationsReport page, on the right side of the page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Performance FYI Notifications Report Template.

  8. In the Template File field, browse for the modified UpdatedPerformanceFyiNotificationsReport.rtf template on your local drive, select the template, and click Open.

  9. In the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box and return to the Performance FYI Notifications Data Model page.

  12. On the right side of the page, click View a list to open the Layout page.

  13. In the row for the Updated Performance FYI Notifications Template, select the Default Layout check box.

  14. On the right side of the page, click the Save Report icon.

Configure Notifications in Goal Management Using Reports

This example shows how to configure workflow email and in-app notifications for the goal management business process using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

PerformanceGoalNotificationsReport, for updates to notifications about goal content

Do I add prompts and headers to the template?

Yes

Do I add data model attributes to the template?

Yes, for Goal ID and Goal Plan ID

Which language do I use for the .rtf template?

English (United States)

Summary of the Tasks

Configure a goal management notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your own report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under Performance Goal Notifications Data Model, click Edit to open the Diagram tab on the Performance Goal Notifications Data Model page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. Enter the following attributes for an existing goal that are key attributes and enable you to pull in all the goal attributes:

    • GoalID

    • NotificationType

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export.

  9. In the Opening PerformanceGoalNotificationsDM dialog box, select Save File and click OK.

  10. Save the PerformanceGoalNotificationsDM_.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog.

  3. On the Catalog page, in the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under PerformanceGoalNotificationsReport, click More, and then select Customize. A copy of the PerformanceGoalNotificationsReport is created automatically in the Custom folder.

  5. On the PerformanceGoalNotificationsReport page, under PerformanceGoalNotificationsTemplate, click Edit.

  6. On the Opening PerformanceGoalNotifications.rtf dialog box, select Save File and click OK to save the document to your local hard drive. Save the template with the name UpdatedPerformanceGoalNotifications.rtf to distinguish it from the original template.

Editing Prompts and Headers in the Template

To modify workflow email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedPerformanceGoalNotifications.rtf template in Microsoft Word with the Template Builder installed, if not already open. The document contains all notifications for the goal management business process.

  2. Scroll to the notification with the header Realign the Goal ALIGNED_GOAL_NAME Because the Goal GOAL_NAME was Canceled.

  3. Place the cursor in front of the Description header text.

  4. Enter Goal. The text now reads Goal Description.

  5. In the header Realign the Goal ALIGNED_GOAL_NAME Because the Goal GOAL_NAME was Canceled, place your cursor after Realign, enter Your, and delete the. The text now reads Realign Your Goal ALIGNED_GOAL_NAME Because the Goal GOAL_NAME was Canceled.

  6. Save the document.

  7. Proceed to the task Previewing the Document.

Previewing the Document

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 emails sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the PerformanceGoalNotificationsDM_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. At the top 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/Workflow Notification Subtemplate.rtf?>.

  5. From the BI Publisher tab in 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 in the Ribbon, click Validate Template in the Tools group.

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

  9. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes that exist in the predefined data model. You will add the Goal ID and Category Meaning data model attributes to the template.
  1. Open the UpdatedPerformanceGoalNotifications.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the PerformanceGoalNotificationsDM_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Scroll to the Aligned Goal Canceled notification.

  7. Place the cursor after Goal Name and press the Enter key.

  8. On the new line, enter Goal ID.

  9. Place the cursor after the data code GOAL_NAME and press the Enter key to enter a new line.

  10. On the BI Publisher tab, in the Insert section, click the 123 Field button to open the Field dialog box.

  11. In the GOALDETAILS folder, select GOAL_ID and click Insert. The field appears in the document.

  12. Place the cursor after the data code Goal Description and press the Enter key.

  13. On the new line, enter Goal Category.

  14. Place the cursor after the data code DESCRIPTION and press the Enter key to enter a new line.

  15. On the Field dialog box, in the GOALDETAILS folder, select CATEGORY_MEANING and click Insert. The field appears in the document.

  16. Click Close to return to the PerformanceGoalNotifications.rtf template.

  17. Preview the template using the steps in the Previewing the Document task.

  18. Save and close the document.

  19. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report Layout to the Oracle BI Publisher Catalog

You must perform this task to use the modified report layout for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog

  3. On the Catalog page, in the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under the PerformanceGoalNotificationsReport, click Edit.

  5. On the Performance Goal Notifications Data Model page, on the right side of the page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Performance Goal Notifications Template.

  8. In the Template File field, browse for the modified UpdatedPerformanceGoalNotificationsTemplate.rtf template on your local drive, select the template, and click Open.

  9. In the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box and return to the Performance Goal Notifications Data Model page.

  12. On the right side of the page, click View a list to open the Layout page.

  13. In the row for the Updated Performance Goal Notifications Template, select the Default Layout check box.

  14. On the right side of the page, click the Save Report icon.

Configure Notifications in Career Development Using Reports

This example shows how to configure workflow email and in-app notifications for the career development business process using Oracle Business Intelligence (BI) Publisher reports. You use Microsoft Word to edit the .rtf template used for notifications. You can modify the BI Publisher templates only if you have the BI Administrator role.

The following table summarizes key decisions for this scenario.

Decisions to Consider This Example

Which template do I update?

CareerDevelopmentFYINotification, for changes to worker development goal content

Do I add prompts and headers to the template?

Yes

Do I add data model attributes to the template?

Goal ID

Which language do I use for the .rtf template?

English (United States)

Summary of the Tasks

Configure a career development notification by:

  1. Exporting the data model XML file.

  2. Downloading the report layout template.

  3. Editing prompts and headers in the template.

  4. Previewing the document.

  5. Adding data model attributes to the template.

  6. Uploading the modified report layout to the BI Publisher catalog.

If you only want to add or edit prompts and headers in the template, use tasks 1, 2, 3, 4, and 6. To only add data model attributes to the template, use tasks 1, 2, 4, 5, and 6.

Prerequisites

  1. Download and install the Oracle BI Publisher Desktop: http://www.oracle.com/technetwork/middleware/bi-publisher/downloads/index.html.

  2. Download and install the Template Builder for Word to use Microsoft Word to edit the layout templates. To download, install, and set up Template Builder for Word, see Creating RTF Templates by Using BI Publisher 11g Template Builder for Word: http://www.oracle.com/webfolder/technetwork/tutorials/obe/fmw/bi/bip/tb4word/tbwordbip.htm.

  3. To preview the configured templates, download a local copy of the subtemplate that applies to your custom own report layout template:

    • Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

    • Click Catalog.

    • In the BI catalog, go to Shared Folders > Common Content > Templates for the predefined subtemplate.

    • Click Edit for Workflow Notification Subtemplate.

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

    • Save the subtemplate .rtf file to your computer.

  4. Click Catalog to open the Catalog page.

Exporting the Data Model XML File

In this task, you export the XML file that includes the data model attributes predefined for the notifications. Perform this task to enable previewing your modified template. This task is also required if you intend to add data model attributes to the template.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog to open the Catalog page.

  3. In the Folders section, expand Shared Folders > Human Capital Management > Workflow Notifications and select Data Models to display the data models in the right pane.

  4. Under CareerDevelopmentFyiDM, click Edit to open the Diagram tab on the CareerDevelopmentFyiDM Data Model page.

    Note: To ensure that all data sets include requested elements with null values in the output XML data, do the following:
    • In the Data Model section, select Properties.

    • In the Properties section, select Include Empty Tags for Null Elements.

    • In the Data Model section, select Data Sets.

    Note: To add data model attributes to the template, perform steps 5 and 6. Otherwise, skip to step 7.

  5. Click the Data tab.

  6. Enter the following attributes for an existing goal that are key attributes and enable you to pull in all the goal attributes:

    • GoalID

    • NotificationType

  7. Click View to see the sample data in the report, and all the available attributes.

  8. Click Export to open the Opening CareerDevelopmentFyiDM dialog box.

  9. Select Save File and click OK.

  10. Save the CareerDevelopmentFyiDM_.xml file to a local drive.

Downloading the Report Layout Template

In this task, you create a copy of the report layout template in the Custom folder, and download a copy of the template to your local hard drive to modify it.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator role to open the Oracle Business Intelligence Home page.

  2. Click Catalog to open the Catalog page.

  3. In the Folders section, expand Shared Folders > Human Capital Management and select Workflow Notifications to display the templates in the right pane.

  4. Under CareerDevelopmentFYINotification, click More, and then select Customize. A copy of the CareerDevelopmentFYINotification is created automatically in the Custom folder.

  5. On the CareerDevelopmentFYINotification page, under CareerDevelopmentFYINotification, click Edit.

  6. Save the template to your local drive with the name UpdatedCareerDevelopmentFYINotificationLayoutrtf to distinguish it from the original template.

Editing Prompts and Headers in the Template

To modify workflow email and in-app notifications, you edit a local copy of the .rtf report layout templates in Microsoft Word.
Note: The exact steps can vary depending on your version of Microsoft Word.
  1. Open the UpdatedCareerDevelopmentFYINotificationLayout.rtf template in Microsoft Word with the Template Builder installed, if not already open. The document contains all notifications for the career development business process except approval notifications.

  2. Scroll to the notification with the header Development Goal Added.

  3. Place your curser at the end of the Development Goal Added header.

  4. Enter to Your Development Plan. The text now reads: Development Goal Added to Your Development Plan.

  5. Place the cursor at the end of the text PPERFORMERNAME added development goal GOAL_NAME for you..

  6. Enter a new sentence: You can access the goal to track your development.

  7. Save the document.

  8. Proceed to the task Previewing the Document.

Previewing the Document

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 emails sent to users.
  1. In the Ribbon, open the BI Publisher tab and click Sample XML within the Load Data group.

  2. Browse to and select the CareerDevelopmentFyiDM)_.xml file you downloaded to import sample data from the data model.

  3. In the Data Loaded Successfully dialog box, click OK.

  4. At the top 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/Workflow Notification Subtemplate.rtf?>.

  5. From the BI Publisher tab in 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 in the Ribbon, click Validate Template in the Tools group.

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

  9. Save your changes in Word.

Adding Data Model Attributes to the Template

In this task, you add to the report template attributes that exist in the predefined data model. You will add the Goal ID and Category Meaning data model attributes to the template.
  1. Open the UpdatedCareerDevelopmentFYINotificationLayout.rtf template in Microsoft Word with the Template Builder installed, if not already open.

  2. Select the BI Publisher tab.

  3. In the Load Data section, click Sample XML.

  4. In the dialog box to select XML data that appears, browse to open the CareerDevelopmentFyiDM_.xml file you saved in the Exporting the Data Model XML File task and click Open.

  5. In the Data loaded successfully dialog box, click OK.

  6. Scroll to the Development Goal Added notification.

  7. Place the cursor after the sentence: PPERFORMERNAME added development goal GOAL_NAME for you. and press the Enter key.

  8. On the new line, enter Goal ID:.

  9. Enter a space after Goal ID:

  10. On the BI Publisher tab, in the Insert section, click the 123 Field button to open the Field dialog box.

  11. In the DATA_DS folder, select PGOALID and click Insert. The field appears in the document.

  12. Click Close to return to the UpdatedCareerDevelopmentFYINotificationLayout.rtf template.

  13. Preview the template using the steps in the Previewing the Document task.

  14. Save and close the document.

  15. Proceed to the task Uploading the Modified Report Layout to the Oracle BI Publisher Catalog.

Uploading the Modified Report Layout to the Oracle BI Publisher Catalog

You must perform this task to use the modified report layout for notifications.
  1. Sign in to the Oracle Business Intelligence Publisher server with the BI Administrator Role to open the Oracle Business Intelligence Home page.

  2. Click Catalog to open the Catalog page.

  3. In the Folders section, expand Shared Folders > Custom > Human Capital Management and select Workflow Notifications.

  4. Under CareerDevelopmentFYINotification, click Edit.

  5. On the CareerDevelopmentFYINotification Data Model page, on the right side of the page, click Add New Layout to open the page with the Create Layout and Upload or Generate Layout sections.

  6. In the Upload or Generate Layout section, click the Upload icon.

  7. In the Upload Template File dialog box, in the Layout Name field, enter Updated Career Development Notifications Template.

  8. In the Template File field, browse for the modified UpdatedCareerDevelopmentFYINotificationLayout.rtf template on your local drive, select the template, and click Open.

  9. On the Upload Template File dialog box, from the Type list, select RTF Template.

  10. From the Locale list, select English (United States).

  11. Click Upload to open the Processing dialog box.

  12. On the CareerDevelopmentFYINotification Data Model page, on the right side, click View a list to open the Layout page.

  13. In the row for the Updated Career Development Notifications Template, select the Default Layout check box.

  14. On the right side of the page, 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.

FAQs for Analyses and Dashboards

What are subject areas, dimensions, attributes, facts, and metrics?

Information for your analytics is grouped into related functional areas called subject areas that contain fact and dimension folders with metrics and columns you can add to your analyses.

Dimension folders include the grouping of dimensional attributes for the subject area. Columns (such as date of birth or name) that are grouped for a dimension are known as attributes. Fact folders contain formulas for getting calculated numeric values, such as counts, sums, and percentages.

What's the relationship between dimensions and fact in a subject area?

A subject area is based around a single fact. The dimensions are all related to each other through the fact only. The fact is automatically included in any query that's created, even if none of the measures in the fact appear in the analysis.

What's a common dimension?

A common dimension is shared across multiple subject areas. For example, Time, Department, and Location are common dimensions. When constructing a cross-subject area analysis, only common dimensions can be used.

How can I determine which dimensions are shared across two subject areas?

If the dimensions exist in both subject areas, they're common dimensions, and are often among the first folders in a subject area. You can join any subject areas you have access to in Answers, but analyses are subject to the normalized data structure. Unless the underlying tables are joined by design, joining subject areas in Answers results in errors.

How can I identify subject areas to create analyses?

All OTBI subject area names end with the words "Real Time".

Can I change the columns in subject areas?

You can use only the available subject areas and their dimensions and facts. You can use other The data elements that are provided out of the box are the only ones that the customers can make use of. You can potentially use BI-enabled flexfields to analyze any column in the transactional tables.

Do analyses query transactional tables to display data?

Analyses run real-time queries of transactional tables through View Objects. Oracle Fusion data security, flexfields, user interface hints, lists of values, and other metadata are delivered through the View Objects.

What's a dashboard?

A dashboard is a container page to display analyses, reports, and other objects. Administrators can create shared dashboards for groups of users with common responsibilities or job functions. Personalized views can be created based on a user's permissions.