Add OTBI Reports to Compensation Pages

Introduction: ................................................................................................................................................. 1
Summary of Areas, Impact, Method, and Approach: ................................................................................... 2
Documentation and Samples ........................................................................................................................ 2
Explanation of Session Variables: ................................................................................................................. 3
Session Variables........................................................................................................................................... 4
Workforce Compensation: ............................................................................................................................ 5
Workforce Compensation Sample Reports: ................................................................................................. 5
Workforce Compensation alternate methods to add reports:..................................................................... 7
Workforce Compensation - Individual Worker Display ................................................................................ 8
Adding a Dashboard to the Workforce Compensation Landing Page ........................................................ 10
Compensation Info:..................................................................................................................................... 15
Sample Report for Compensation Info: ...................................................................................................... 17
Salary ........................................................................................................................................................... 18
Individual Compensation ............................................................................................................................ 20
Total Compensation Statement: ................................................................................................................. 21

Introduction:

There are multiple methods to add OTBI reports to compensation pages. Some methods are specific to
a particular business process or task. Follow along to understand the variations and requirements of
each.

Summary of Methods to add Reports:

Methods
-Configuration
-Page Composer: Add Content using Report Object
-Page Composer: Add Content using Web Page
-Rich Text Editor: via Report Link
Summary of Areas, Impact, Method, and Approach:

Compensation Area Sub-area Impact Method Approach

Workforce View Reports Configuration Configure reports for managers or All custom and delivered reports
Compensation admins will be in one place under View
Reports, or View Administration
Reports.
Worksheet Configuration Rich Text Editor: via Report Link Custom report is a link on the
worksheet itself.
Landing Page Personalization Page Composer: Add Content using Custom dashboard on the landing
Report Object page.
Individual Worker Configuration Configure reports on pages for IWD Best approach of these 3 for IWD
Display
Personalization Page Composer: Add Content using
Report Object
Personalization Page Composer: Add Content using
Web Page
Compensation Info Personalization Page Composer: Add Content using
and Salary Report Object
Personalization Page Composer: Add Content using
Web Page
Individual Personalization Page Composer: Add Content using Same as above
Compensation Report Object
Personalization Page Composer: Add Content using Same as above
Web Page
Configuration Rich Text Editor: via Report Link
Total Compensation Configuration Rich Text Editor: via Report Link
Statement

Documentation and Samples

You can refer to some documentation and samples listed here.

Item Location
Release Readiness Workforce Compensation: Add OTBI Dashboards
Release Readiness Enhanced Ability to Add OTBI Reports in Salary and Individual Compensation Pages
Sample Report Sample Report: Workforce Compensation Dashboard
Sample Report Sample Report: Display an OTBI Report on Compensation Info
Explanation of Session Variables:

You will see references to 'session variables' as we look at methods to add reports. By way of
introduction, session variables are used by pages to read OTBI analysis filter prompts. This means when
the analysis displays on the page, it will return rows that are contextually relevant to what is already
displayed on the page. (Sometimes referred to as page context or page parameter.)

For example, the plan and cycle on a worksheet page can be filtered in an OTBI report, when the
following filter prompts for plan and cycle are added to the analysis.
Session Variables

Session Variables – WFC Individual Worker View Only OTBI Column from Workforce Compensation SAs
Worker Person ID: #{sessionScope.iWorkerPersonId} "Worker"."Person ID"
Worker Assignment ID: #{sessionScope.iWorkerAssignmentId} "Worker"."Assignment ID"
Worker Person Event ID: #{sessionScope.workerPersonEventId} "Compensation Person Details."Person Event Identifier"
Plan Id: #{sessionScope.planId} "Compensation Plan Details"."Plan Identifier"
Period Id: #{sessionScope.periodId} "Compensation Plan Cycles"."Cycle Identifier"

Session Variables – WFC

Plan ID: #{sessionScope.planId} "Compensation Plan Details"."Plan Identifier"
Period ID: #{sessionScope.periodId} "Compensation Plan Cycles"."Cycle Identifier"
Worker Person Event ID: #{sessionScope.workerPersonEventId} "Compensation Person Details."Person Event Identifier"
Logon Person ID: #{sessionScope.logonPersonId} "Worker"."Person ID"
Logon Assignment ID: #{sessionScope.logonAssignmentId} "Worker"."Assignment ID"
Acting Person ID: #{sessionScope.actingPersonId} "Worker"."Person ID"
Acting Assignment ID: #{sessionScope.actingAssignmentId} "Worker"."Assignment ID"

Section Assignment ID Person ID

SALARY / OTBI: "Worker"."Assignment ID" "Worker"."Person ID"
My Team > Change Salary #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
My Client Groups > #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
Change Salary
My Client Groups > Salary #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
History
Salary in GHR Flow of #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
Local and Global Transfer
Salary in GHR Flows such #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
as Promote, Transfer,
Change Assignment
Salary section in GHR #{pageFlowScope.assignmentId} #{pageFlowScope.personId}
Flows such as New Hire,
Add Pending Worker
INDIVIDUAL "Worker"."Assignment ID" "Worker"."Person ID"
COMPENSATION / OTBI:
Me > Manage Personal
#{pageFlowScope.pAssignmentId} #{pageFlowScope.pPersonId}
Contribution
My Team > Individual
#{pageFlowScope.pAssignmentId} #{pageFlowScope.pPersonId}
Compensation
My Client Groups >
#{pageFlowScope.pAssignmentId} #{pageFlowScope.pPersonId}
Individual Compensation
My Client Groups >
Administer #{pageFlowScope.pAssignmentId} #{pageFlowScope.pPersonId}
Compensation
IC in GHR flows Promote,
Transfer, Change #{pageFlowScope.pAssignmentId} #{pageFlowScope.pPersonId}
Assignment, New Hire
COMPENSATION INFO / "Worker"."Assignment ID" "Worker"."Person ID"
OTBI
My Team >
#{pageFlowScope.responsiveModuleMap.AssignmentId} #{pageFlowScope.responsiveModuleMap.PersonId}
Compensation Info
Workforce Compensation:

Let's look at Workforce Compensation.

Rule number 1
Be sure to save your analyses in /shared/Custom/Human Capital Management/Compensation

Navigate to Workforce Compensation Plans -> select your plan -> Configure Reports

Notice there are two tabs for Manager Reports and Administration Reports. You can add reports to
either. At the bottom of this page there is a section for adding OTBI reports. This will only see the
reports added in the above navigation.

Build your analysis with the filter prompts such as cycle identifier, as mentioned in the Explanation of
Session Variables section. (An exception to this is, if you do want users to access a report where they
can see ANY plan or cycle within the report. Then don't use the filter prompts.) Otherwise it is best
practice to include the filter prompts so the data reflects the plan and cycle on the worksheet.

Workforce Compensation Sample Reports:

These, and more, are available in Customer Connect

https://community.oracle.com/customerconnect/discussion/24955/sample-report-wfc-prompt-act-as-proxy-report-updated
https://community.oracle.com/customerconnect/discussion/26030/sample-report-workforce-compensation-budget-comparison-report-
updated#latest
https://community.oracle.com/customerconnect/discussion/613531/sample-report-average-compa-ratio-for-workforce-compensation

Summary of session variables available for Configure Reports:

1. Logon Person ID: #{sessionScope.logonPersonId}

2. Logon Assignment ID: #{sessionScope.logonAssignmentId}
3. Plan ID: #{sessionScope.planId}
4. Period (Cycle) ID: #{sessionScope.periodId}
5. Acting Person ID: #{sessionScope.actingPersonId}
6. Acting Assignment ID: #{sessionScope.actingAssignmentId}

Restrictions, tips or limitations:

-Reports have to be saved in the folder path /shared/Custom/Human Capital
Management/Compensation.
-Start your analyses for Workforce Compensation, with a Workforce Compensation Subject Area. You
can cross join this with another subject area if desired. Always test your analyses thoroughly.
-Use filter prompts for the session variables, and that is why you need to start with a WFC SA. When
you add a filter prompt, you may need to select 'More Columns' to see these, if you have not included
them in your analysis.
-Note you can get away with specifying only cycle and not plan in your prompts, and this is because
cycle identifier is unique per plan, even if the name is exactly the same.
-You may want to make all your columns non-drillable to help prevent users from drilling and possibly
getting confused about the results. This is set in the column properties Interaction tab.
-Use table prompts to help users toggle data like Worksheet Manager Name or Budget Pool Name. This
is useful for filters that aren't exposed as session variables. For example, if you are building an Act as
Proxy manager style of report, you can use Worksheet Manager Name as a table prompt, so the user
can toggle to that manager, and see results for them.
-With this method, all the custom and delivered reports will be in one place in the Landing page Reports
icon.

What is a filter prompt? Dashboard prompts, and prompts that are located in the prompt tab, aren't
read by the session variables, which are only going to look at filter style prompts on the Criteria tab.
This is an example of the Filter Prompt.
What is a table prompt? It's added here in the Results tab of an analysis:

Remove Drill from Interaction, illustration

Workforce Compensation alternate methods to add reports:

Rich Text Editors: via Link

You can add reports to Information. Type 1. Navigate to Workforce Compensation Plans -> select your
plan -> Configure Worksheet Display -> Configure Task Layout -> select the Information tab. Also Enable
Worksheet Information in Configure Default Worksheet Display.
Type 2. Or, in Configure Plan Information, Enable, enter Task Name, and create a link in User-Defined
Text.
Now select the link icon, and add the Link Info and Target. Adding the link info will allow you to create a
friendly name for the report and add the URL for the report. Specifying the target will allow the report
to open in a new window. Simply use the report link from the Advanced tab in OTBI, as the URL.
Type 1. This will appear under Plan Name on the worksheet as follows:

With this method, the report link will be right on the worksheet, and the manager does not have to
navigate away. You can always add reports to both the View Reports task icon, as well as here on the
worksheet.

Type 2. Appears within the icon when you use this method.

Workforce Compensation - Individual Worker Display

You can configure reports to appear here by navigating to Workforce Compensation Plans -> select your
plan -> Configure Individual Worker Display -> Page Content. You can either add a new section or use
existing sections. This method works quickly and easily.
Sample Report for Individual Worker Display:

This is available on Customer Connect

https://community.oracle.com/customerconnect/discussion/613530/sample-report-individual-worker-
view-for-workforce-compensation

Summary of session variables available for Configure Reports:

The session variables available for use as filter prompts for this method are listed here.
Worker Person ID: #{sessionScope.iWorkerPersonId}
Worker Assignment ID: #{sessionScope.iWorkerAssignmentId}
Worker Person Event ID: #{sessionScope.workerPersonEventId}
Plan Id: #{sessionScope.planId}
Period Id: #{sessionScope.periodId}

Restrictions, tips or limitations:

-Keep in mind IWD is all about one person. Be sure to use the correct filter prompts to take advantage
of the session variables. Person and Assignment Identifiers can be found in the 'Worker' folder.
-When you add a filter prompt, you may need to select 'More Columns' to see these, if you have not
included them in your analysis.
-Build or start your analysis using the Workforce Compensation subject area. Cross join the WFC SA with
other subject areas to add more info.
-You may want to make all your columns non-drillable to help prevent users from drilling and possibly
getting confused about the results. This is set in the column properties Interaction tab.

Other methods to add reports to the Individual Worker Display:

Page Composer: via Add Content by using the Report Object, or via Web Page
Both these methods are more advanced, with Web Page being the most technical.

Adding Content by using the Report Object:

Use the Workforce Compensation subject area as previously mentioned. Use the session variables by
adding filter prompts into your analysis. Save the report in a shared folder.

Enable and enter into a sandbox. Select 'Page Composer' in the Sandbox tools.
Be on the Individual Worker Display page, then in Settings and Actions, select Edit Pages.
Select Add Content. We will be using the Report and Analytics object.
Select the 'Reports and Analytics' folder.
Navigate to the folder where the analytic is saved and click on 'Add' to add the report.
Close and move from the Add Content tab to the Select tab. Select the 'Parameters' button available on
top right corner. This will show available filters or session variables.
Use the respective expression in the Value 1 field and click Save. For example:
Worker Person ID: #{sessionScope.iWorkerPersonId}
Worker Assignment ID: #{sessionScope.iWorkerAssignmentId}
Plan Id: #{sessionScope.planId}
 Period Id: #{sessionScope.periodId}
This will pick the value from the current session to display the current worker record.

Adding Content by using a Web Page:

Instead of selecting a Report and Analytics object as in the previous method, select Components, and
then Web Page. While still in Add Content, use the spanner or wrench icon located at the upper right.
Add the report URL here in the Source box, and a friendly name for the report. Note this method can be
complex, when there are binding parameters that need to be passed. A knowledge of how to build this
URL is required, for example:

Get the report link from the Advanced tab of your analysis. Right click on the report name hyperlink
that is directly above the Analysis XML box and select copy link.
https://fuscdrmsmc194-fa-
ext.us.oracle.com/analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Manage
ment%2fCompensation%2fIndividual%20Worker%20View%20v3&Options=rmf

Remove the beginning and replace with ../../

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fIndividual%20Worker%20View%20v3&Options=rmf

Remove the end &Options=rmf

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fIndividual%20Worker%20View%20v3

Now add any bindings to the end, such as Assignment ID

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fIndividual%20Worker%20View%20v3&Action=print&col1=%22Worker%22.%22Assignment
%20ID%22&val1=#{pageFlowScope.responsiveModuleMap.AssignmentId}

We can use:
#{pageFlowScope.responsiveModuleMap.PersonId} or
#{pageFlowScope.responsiveModuleMap.AssignmentId}

Adding a Dashboard to the Workforce Compensation Landing Page

Instead of adding an analysis, here we discuss adding a dashboard. Now you can add OTBI reports with
dashboards in Workforce Compensation. Dashboards provide better support for prompts. Currently
you can only use table style prompts, which are simple toggles that don’t allow multi-select. This new
enhancement uses page composer to add OTBI content including dashboards, on the Compensation
Landing Page. First create your analysis. Next create your dashboard prompts. Finally create a
dashboard and add both. Screen shots below explain how.

Workforce Compensation Dashboard as seen in OTBI:

Objects needed for Dashboard as seen in OTBI:

Using the Sandbox steps screen shots:

Tips for session variables here in the dashboard:
To ensure data integrity, take care that filter prompts in your analysis, match dashboard prompts.
Session variables only read filter prompts. They don't notice dashboard prompts. You will need both.
By using only Period (Cycle) ID, you can skip Plan ID, because cycle IDs are always unique to a plan.
Reference below list for the session variables and their respective Expression Language (EL).
Logon Person ID: (#{sessionScope.logonPersonId})
Logon Assignment ID: (#{sessionScope.logonAssignmentId})
Plan ID: (#{sessionScope.planId})
Period (cycle) ID: (#{sessionScope.periodId})
Acting Person ID: (#{sessionScope.actingPersonId}) (when switched to a different manager)
Acting Assignment ID: (#{sessionScope.actingAssignmentId}) (when switched to a different manager)

They can be left blank to show all the values in the dropdown, or default them from the context using
the ELs above.

Recommendation: Here are how you use 2 bindings for proxy and cycle
&Action=print&col1=%22Worker%22.%22Assignment%20ID%22&val1=#{sessionScope.actingAssignmentId}
&Action=print&col1=%22Compensation%20Plan%20Cycles%22.%22Cycle%20Identifier%22&val2=#{sessionScope.periodId}
Compensation Info:
Use Page Composer and the Web Page method for adding reports. Let's add some assignment info,
from Worker Assignment Event Real Time.

Enable and enter into a sandbox. Select 'Page Composer' in the Sandbox tools.
Be on the Compensation Info page, then in Settings and Actions, select Edit Pages.
In the Structure tab, click on the 'Show Current and Future', to get you in the general area.
Increase the Dock size if you need more space.
Directly above 'Show Current and Future' highlight 'panelGroupLayout: default' and select the plus sign.
Select Components and select Add on the Web Page object. Close.
Next navigate away from the Structure tab, to the Add Content tab.
Find the new web page and click on the spanner/wrench in the upper right.
Type in a friendly name and then select Source. Within Source you will paste a URL, or use Expression
Builder to do so. The URL must be constructed like this.

Take the report URL from the Advanced tab in OTBI. Right click on the report name hyperlink that is
directly above the Analysis XML box, and select copy link. It'll look like this.

https://fuscdrmsmc194-fa-
ext.us.oracle.com/analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Manage
ment%2fCompensation%2fAssignment%20Info&Options=rmf

Now remove the beginning and replace with ../../

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fAssignment%20Info&Options=rmf

Remove the ending from &Options=rmf

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fAssignment%20Info

Finally add a binding, such as Assignment ID

../../analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Management%2fComp
ensation%2fAssignment%20Info&Action=print&col1=%22Worker%22.%22Assignment%20ID%22&val1=
#{pageFlowScope.responsiveModuleMap.AssignmentId}

We can use
#{pageFlowScope.responsiveModuleMap.PersonId} or
#{pageFlowScope.responsiveModuleMap.AssignmentId}
Sample Report for Compensation Info:

This is available in Customer Connect

https://community.oracle.com/customerconnect/discussion/613719/sample-report-display-an-otbi-
report-on-compensation-info

Restrictions, tips or limitations:

-Use Assignment ID from the Worker folder only, when creating your filter prompts in the analysis.
Assignment IDs from other folders will not work.
- When you add a filter prompt, you may need to select 'More Columns' to see these, if you have not
included them in your analysis.
-You may want to make all your columns non-drillable to help prevent users from drilling and possibly
getting confused about the results. This is set in the column properties Interaction tab.
-This may require different placement on the page using Page Composer, for multiple assignments,
because the report doesn't appear when the assignment switcher is present on Comp Info.
Salary

-You can use the same steps as Compensation Info, for Salary.

Steps for adding a report on Salary: Let's add some assignment info from the Worker Assignment Event
Real Time subject area. We'll add this sample report from customer connect, because it already has an
Assignment ID filter: https://community.oracle.com/customerconnect/discussion/613719/sample-
report-display-an-otbi-report-on-compensation-info

Enable and enter a sandbox. Select 'Page Composer' in the Sandbox tools. Be on the Change Salary page
for a person, then in Settings and Actions, select Edit Pages. In the Structure tab, click 'Salary Details',
and use Confirm Task Flow Edit, to get you in the correct area. Increase the Dock size if you need more
space. Select panelGroupLayout: vertical under Salary Details and Edit Task Flow, as shown below.

Place your cursor on panelGroupLayout: vertical and click the plus sign. Click Open on the Reports and
Analytics folder. Navigate to your report under BIPresentation Server, to the folder where you saved it.
Select Add to add your report. Close the Add Content box. Your report is now on the page. Also select
Close on the upper right. It will look like this.
The report as it appears on the page under Salary Details:
Individual Compensation

-Individual Compensation has one more method available. You can add a report link in the Rich Text
Editor. Use the Plan Info tab to add a report to an Individual Compensation Plan. First enter some user
friendly name for your report. Now select the link icon in the toolbar, and add the Link URL. Simply use
the report link from the Advanced tab in OTBI, as the URL. Slide the toggle to open the report in a new
tab (recommended). Click the green checkmark. Save.
Total Compensation Statement:

Use the Rich Text Editors and the report link method. Let's add some info from the Payroll Balances Real
Time subject area, to the Descriptive Text of a Category.

In your analysis, be sure to use the following filter to display only the data for the person looking at the
statement:
"Worker"."User Name" = VALUEOF(NQ_SESSION.USER)
While in OTBI, copy the report URL from the Advanced tab in OTBI. Right click on the report name
hyperlink that is directly above the Analysis XML box, and select copy link. It'll look something like this.

https://fuscdrmsmc194-fa-
ext.us.oracle.com/analytics/saw.dll?Go&Path=%2fshared%2fCustom%2fHuman%20Capital%20Manage
ment%2fCompensation%2fPayroll%20Balances&Options=rmf

Next in TCS, select the Category that you want to add the report to and navigate to the Descriptive Text
tab. First type a friendly name for this link in the Rich Text Editor. For example, Payroll Balances
1/1/2020 to 12/31/2020. Next while highlighting that friendly name, click on the Add Link icon. Enter
the report URL exactly as taken from OTBI. Save and generate statements as usual.

Users need to right click on that, to select open in new tab. (It's not exactly the same method as the
Workforce Compensation or Individual Compensation Rich Text Editor.)
Restrictions, tips or limitations:

-Use the NQ_SESSION.USER filter prompt, to be sure to display only rows relevant for the person's
statement. This can be entered as a SQL prompt too, like this: "Worker"."User Name" =
VALUEOF(NQ_SESSION.USER)
-Be sure to use a between dates filter in OTBI to select rows that are relevant for your statement period.
For example in this case, I used between 1/1 and 12/31/2020.
-You may want to make all your columns non-drillable to help prevent users from drilling and possibly
getting confused about the results. This is set in the column properties Interaction tab.
-If people forget to right click and open the report in a new tab, the back button will still work fine.