2Setup and Configuration

This chapter contains the following:

Mapping to Work Areas

Setting Up the Reports and Analytics Panel Tab: Procedure

You can find the Reports and Analytics panel tab in many work areas, and the analytics and reports you see in it depend on the work area. You can define what's available for a specific work area, by mapping reports from the business intelligence (BI) catalog to that work area. In this mapping context, reports refer to both analytics and reports. Your changes apply to all users who have access to the work area you're mapping.

Mapping Reports from Your Work Area

To map reports to the work area that you're in:

  1. Expand the Reports and Analytics panel tab.

  2. Click the Edit Settings icon in the panel tab.

    You see all the reports that are currently mapped to your work area.

  3. Click Select and Add.

  4. Find the report in the catalog and select it.

  5. Click OK.

  6. To remove any mapping, select the report and click Remove.

  7. Save your work.

Mapping Reports to Any Work Area

To map reports to any work area that you have access to:

  1. In the Setup and Maintenance work area use the Map Reports to Work Areas task.

  2. Select the application of the work area you want to map to.

  3. Select the work area.

  4. Click Search and see all the reports that are currently mapped to that work area.

  5. Click Select and Add.

  6. Find the report in the catalog and select it.

  7. Click OK.

  8. To remove any mapping, select the report and click Remove.

    Tip: Click Synchronize to remove all mappings to any reports that are no longer in the catalog. You synchronize all work areas, not just the one you're mapping.
  9. Save your work.

Why can't I see reports when mapping reports to work areas for the Reports and Analytics panel tab?

Either no reports are currently mapped to the work area you select on the Map Reports to Work Areas page, or you don't have access to the reports that are mapped.

Similarly, when you're selecting a report to map, you can see only the reports that you have access to. Ask your administrator to either:

  • Assign you roles that have access to the reports you want to map to work areas.

  • Grant the Reports and Analytics Region Administration Duty to someone who already has access to those reports.

Why can't I see reports when I edit settings for the Reports and Analytics panel tab?

In the Edit Settings window, you might not see a currently mapped report because you don't have access to it.

Similarly, when you're selecting a report to map, you can see only the reports that you have access to. Ask your administrator to either:

  • Assign you roles that have access to the reports you want to map to work areas.

  • Grant the Reports and Analytics Region Administration Duty to someone who already has access to those reports.

Setting Up Currency

Setting Currency Preferences for Analytics: Overview

Oracle Transactional Business Intelligence gives you the ability to set your personal currency preferences, as well as set currency preferences which determine how your analyses display currency and calculate exchange rates.

The user preferences for your cloud offering are set in the cloud environment, and the currency preferences for analyses are set in Oracle Business Intelligence (BI). Both user preferences impact how your report currency is calculated and displayed. Your application administrator sets the corporate currency as the common currency basis for all users.

There are three ways currency is set in cloud and BI environments:

  • User Currency - Set by the business user in Regional settings. This setting applies to the entire application interface for that user only. The currency options available are set by your application administrator.

  • Reports Currency - Set by the business user in BI in My Account settings in the Reports area. The setting applies to that user only and only relevant for report production.

  • Corporate Currency - Set by the application administrator. This setting applies to all users in that company.

Setting Your General User Currency: Explained

User currency settings govern the currency that is used as the default for your application interface. User currency is set in the application and applies to your entire interface for your signed-in session.

To set your user currency:

  1. Navigate to Tools, Set Preferences.

  2. Select General Preferences > Regional.

  3. Select the preferred currency to be used. Available currencies include those set up for your company by your application administrator.

Setting Your Personal Analysis Currency

The analysis currency determines the currency that is used in reports and analyses. It also determines how and when your currency conversion rates are calculated.

To set your currency for reports and analyses:

  1. Navigate to Business Intelligence.

  2. Click Analytics in the navigator menu.

  3. Click Browse Catalog.

  4. Click your user name and and select My Account.

  5. Go to the Preference.

  6. Select your choice in Currency.

The following table describes the currency menu options.

Currency Name Description

Entered Currency

Currency used on a transaction.

<Application> Currency

Currency set up in each respective Cloud application as the common Corporate currency used company-wide.

User Preferred Currency using Simple Currency Management

Conversion to User Preferred Currency is performed at the time your run the report, and is calculated from the Corporate currency based on the last time the record was updated and saved or closed.

User Preferred Currency using Advanced Currency Management

Conversion to User Preferred Currency happens on the date your run the report, and uses the currency indicated on the record.

Setting a Default Currency Conversion Option for All Users: Explained

The default setting for the way currency conversion is handled for analytics is the User Preferred Currency Using Simple Currency Management. This simple currency management setting provides the best run-time performance when dealing with currency exchange rate management. But there are cases when your organization might want to standardize the setting for all system users, by setting the default preference to another option, such as CRM Currency or User Preferred Currency Using Advanced Currency Management.

To change the default currency setting for all users, administrators need to add a profile option and a corresponding value. Note that when administrators change the default currency setting for users in their organization, individual users can still override that setting and select their preferred currency in My Account.

The following table shows the profile option code parameters to override the default currency setting.

Profile Code Profile Value Description

BI_DEFAULT_CURRENCY_CONVERSION_METHOD

CRM Currency - Defaults to Application Currency.

BI_DEFAULT_CURRENCY_CONVERSION_METHOD

User Preferred Currency 1 - Defaults to User Preferred Currency Simple Currency Management.

BI_DEFAULT_CURRENCY_CONVERSION_METHOD

User Preferred Currency 2 - Defaults to User Preferred Currency Advanced Currency Management.

Setting the Currency for an Individual Analysis: Procedure

You can set the currency at an analysis level to ensure that the data is displayed in a preferred currency.

Perform the following steps to set the currency for an individual analysis.

  1. Open the analysis in Edit mode for which you want to change the currency.

  2. Open the Advanced tab.

  3. In the Advanced SQL Clauses region, enter one of the following SQL statements in the Prefix field:

    • SET VARIABLE PREFERRED_CURRENCY='Local Currency';

    • SET VARIABLE PREFERRED_CURRENCY='Project Currency';

    • SET VARIABLE PREFERRED_CURRENCY='Contract Currency';

  4. Click Apply SQL.

  5. Click the Save Analysis icon.

    Alternatively, use the Save As icon to save the analysis to a specified location with a new name.

Adding a Currency Profile: Explained

To set default global currency conversion types for all users, administrators create a currency profile. Currency profiles are added in Setup and Maintenance, one of the options available when you click your user name in the Home Page. Only administrators can change global currency preferences by creating profiles.

To Add a currency profile:

  1. In Setup and Maintenance use the Manage Profile Options task.

  2. Click the +(New icon) in Search Results: Profile Options.

  3. Enter the following values:

    • Profile Option Code : BI_DEFAULT_CURRENCY_CONVERSION_METHOD

    • Profile Display Name : BI Default Currency Conversion Method

    • Application

    • Module

    • Start Date : Provide previous day's date to proceed to next step to define values.

  4. Click Save and Close.

  5. In the Manage Profile Options dialog, you see your new profile. Check the Enabled box for Site.

  6. Click Save and Close.

Defining Currency Profile Values: Explained

Once you have created your currency profile, the last step is to define the profile value. This step defines which currency management option is assigned to that profile.

To define a currency profile value:

  1. In the Setup and Maintenance work area, use the Manage Administrator Profile Values task.

  2. In Profile Option Code search for your profile: BI_DEFAULT_USER_CURRENCY

  3. In Manage Administrator Profile Values, Click + (Add icon) .

  4. Select Site as the Profile level.

  5. Enter "User Preferred Currency 2" in Profile Value.

  6. Click Save and Close to close the dialog.

User-Preferred Currency Reporting and Exchange Rates: Points to Consider

The simple and advanced user-preferred currency choices determine how and when your currency exchange rates are calculated for your reports. For both simple and advanced currency management, when you save or close a report, the application sets the exchange rate at that time. The option you choose impacts how quickly your reports are generated at run time. Each case includes trade-offs, as detailed in the examples.

User Preferred Currency using Simple Currency Management

The advantage of this option is performance - the application doesn't have to look up the rate for each transaction because when you close or save a record, the application converts it to your corporate currency at that day's rate. When you run the opportunity report, the application multiplies that value by your preferred currency exchange rate for the date you run the report. This eliminates the need for the application to cycle through each record, and calculate the corresponding exchange rate to your preferred exchange rate at the time that record was closed or last saved. It simply takes the value on record for the original transaction exchange to corporate currency, and multiplies it by your preferred currency exchange rate at the time your run the report.

As an example of user preferred currency using simple currency management, a user updates and saves or closes an opportunity record with associated revenue of one million Indian Rupees on January 31st with an exchange rate of 0.01403 Rupees to one US Dollar. The user then runs an opportunity report in US Dollars on March 31st. In the report, the US Dollar Corporate Currency is set at the January 31st rate it was saved at, in this case reporting as $14,030, or one million multiplied by 0.01403. Finally, an opportunity report on March 31st in Euros uses the March 31st conversion rate for US Dollars to Euros of 0.75017 to convert the recorded US Dollar amount into Euros, in this example one million multiplied by 0.1403, which is the January 31st Rupee to US Dollar exchange rate, multiplied by 0.75013, which is the March 31st rate for Euros. This requires less processing, because the January 31st Rupee to US Dollar exchange rate, while not exact on March 31st, is used as the basis for the calculation of the March 31st opportunity revenue conversion to Euros at the later exchange rate.

The following figure describes an example of user preferred currency using simple currency management.

User preferred currency using simple currency management.

User Preferred Currency using Advanced Currency Management

This option provides a more precise exchange rate, since it goes through each record to determine the rate on the date the record was updated or closed. The downside of this option is performance. Your reports will take longer to run. The application has to cycle through each record and match currency exchange rates to the date the record was closed or updated and saved.

As an example of user preferred currency using advanced currency management, a user updates and saves or closes an opportunity record with associated revenue of one million Indian Rupees on January 31st, when an exchange rate of 0.01050 Rupees to one Euro applies. The user then runs an opportunity report on March 31st. In the report, the User Preferred Currency of Euros is applied, using the March 31st Rupee to Euro rate of 0.01052, requiring calculation during report processing to resolve the opportunity to 10,520 Euros. Finally, an opportunity report on March 31st in Euros again uses the March 31st conversion rate for Euros.

The following figure describes an example of user preferred currency using advanced currency management.

User Preferred Currency using advanced currency
management.

Why do I see amounts of zero in analyses?

The currency exchange rates might not be set up correctly. For example, you choose EUR as your preferred currency in general preferences, and your corporate currency is USD. Amounts in analyses are displayed in EUR after conversion from USD, based on the current exchange rate. But if the exchange rate between EUR and USD isn't set up, or if the conversion fails for any reason, then the amounts show as zero. If this happens, contact your help desk.

Configuring Business Intelligence Publisher

Managing Report Delivery Servers: Overview

Oracle Business Intelligence Publisher, the report generation and delivery engine, requires configuration and tuning to deliver reports to users.

Report requests are received by Publisher from:

  • Oracle Enterprise Scheduler

  • The Reports and Analytics work area and panel tab

  • Application pages

Requests submitted through Oracle Enterprise Scheduler are processed by the Oracle BI Publisher scheduler. Requests submitted through the Reports and Analytics work area or panel tab can be either real-time online requests or scheduled requests. Requests submitted through an application may call Oracle Enterprise Scheduler or may return report request results directly back to the application page.

Oracle BI Publisher is configured to accept requests from Oracle Applications Cloud. However, before you can deliver report documents to their destinations, you must define the delivery servers in Oracle BI Publisher. Use the Oracle BI Publisher Administration page to define your delivery servers.

Once delivery servers are defined, you can further configure the number of report processor and delivery threads to best handle your processing and delivery requirements. In addition, you can configure report properties for the delivery servers or at the report level to tune performance of your reports. To diagnose report processing issues, BI Publisher provides a set of scheduler diagnostics.

Navigating to the Oracle BI Publisher Administration Page: Procedure

You use the Oracle BI Publisher Administration Page to perform most tasks related to report delivery and performance.

Use the Oracle BI Publisher Administration page to:

  • Configure delivery servers

  • Manage report and delivery processors

  • View scheduler diagnostics

  • Set system properties and report runtime configuration properties

Request the Oracle Applications Cloud security administrator to assign the BI Platform Administrator duty role (BI stripe) to the person responsible for administering BI analyses, dashboards, and BI Publisher reports. Administration tasks include security permissions for objects, organizing objects into folders, accessing log files, and several other tasks.

Navigating to the Administration Page

To navigate to the Oracle BI Publisher Administration page:

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

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

  3. In the Catalog page, click Administration, then click Manage BI Publisher.

Configuring Report Delivery Servers: Procedure

Set up the report delivery servers to support printing.

Configuring Servers

To configure delivery servers:

  1. From the BI Publisher Administration page, click Delivery Configuration.

  2. Enter values in the Delivery Configuration Options tab to set general properties for email deliveries and notifications.

  3. To configure a delivery server, click the appropriate tab.

Understanding the Report and Delivery Processors: Overview

When Oracle Enterprise Scheduler initiates a job, it is picked up by the BI Publisher scheduler queue.

  • Job Processor: Listens for requests from the scheduler queue. When the job information is received, the job processor executes the data model (and splits the data for bursting jobs), stores the data in the shared temporary folder, and sends the report metadata to the report queue.

  • Report Processor: Listens for requests from the report queue. When the report information is received, the report processor generates the report documents, stores it in the shared temporary folder and puts the delivery information in the delivery queue.

  • Delivery Processor: Listens to the delivery queue and handles the delivery of reports for its channel. The delivery processors are:

    • Email Processor

    • File Processor

    • FTP Processor

    • Print Processor

    • WebDAV Processor

    • Fax Processor

Managing Report Processing and Delivery Server Load: Procedure

Manage the processors in the BI Publisher Scheduler Configuration page.

Managing Processing and Server Load

By default, each processor is enabled and the thread count for each is set to five. For each managed server that is running in the BI cluster, a table for that instance's processors is displayed. Use the table to enable or disable processors for the instance and configure the thread counts.

To configure processor threads:

  1. From the BI Publisher Administration page, click Scheduler Configuration.

  2. In the Cluster Instances region of the Scheduler Configuration page, enter the Number Threads value in the processor configuration table.

  3. All processors are automatically set to use the number of threads defined in the Threads Per JMS Processor value of the JMS Configuration region of the page. Enter a value in the Number Threads column to change the value from this default.

After performing the scale-out procedure, configure the processor threads for each cluster instance using the same steps.

Diagnosing Report Processing Issues: Procedure

The Scheduler Diagnostics page provides the runtime status of the scheduler. Among others, it provides status of its JMS configuration, JMS queues, cluster instances, scheduler Database, and Oracle Enterprise Scheduler.

Diagnosing Issues

To access the Scheduler Diagnostics page:

  1. Navigate to the Oracle Business Intelligence Publisher Administration page.

  2. In the System Maintenance group, click Scheduler Diagnostics.

Configuring System Properties for Reports: Procedure

Use the Oracle BI Publisher Runtime Configuration page to set the system-level runtime properties for reports.

Configuring Reporting Properties

To access the Runtime Configuration page:

  1. Navigate to the Oracle Business Intelligence Publisher Administration page.

  2. In the Runtime Configuration group, click Properties.

Changing Memory Guard Settings: Procedure

Memory Guard settings for Oracle BI Publisher have default settings optimized for performance. To change Memory Guard settings from the defaults, log a service request with details in the Memory Guard request template.

Reviewing Memory Guard Settings

To Review Memory Guard Settings:

  1. Click Properties.

  2. Click Manage BI Publisher.

  3. In the Runtime Configuration, click Properties.

  4. The Memory Guard settings set thresholds for report size and runtimes.

Changing Memory Guard Settings

To change the Memory Guard settings, review the process described in MyOracle Support (Doc ID 2199494.1). Use the provided Customer Memory Guard Change Request Template to provide details of the changes you want and attach it to a service request for review by Oracle Support.

Using a Dedicated Business Intelligence Publisher Cluster for Critical Jobs: Procedure

For some time-sensitive reports, including for example paycheck and invoice generation, you can use a dedicated Business Intelligence Publisher cluster by setting the report's priority as critical, ensuring that reports are run during critical time windows.

Critical jobs are assigned to a dedicated cluster. To set a report as critical:

  1. Open the report.

  2. Click Properties.

  3. In the Advanced Report Properties in the General tab, select Critical in the Job Priority list.

Determining Which Reports Are Prioritized as Critical

To review which reports have been marked as critical, navigate to Report Job Histories, where critical jobs are highlighted.

Configuring Deep Links

Registering Business Intelligence to Support Deep Linking: Procedure

Deep links in analyses allow you to navigate from analytics to specific attributes and objects in your transactional pages so that you can work with them directly. To support deep links, use the Setup and Maintenance work area to register the Business Intelligence Server as a third-party application.

Registering Business Intelligence Server as a Third-Party Application

To register the BI Server:

  1. Click Navigator > Setup and Maintenance.

  2. Click the Tasks panel tab and click Manage Custom Setup Content.

  3. Click Manage Third Party Applications.

  4. Click Create.

  5. Enter AnalyticsApp as the application name.

  6. Enter the full URL for the BI Server (for example: http://host:port/analytics/saw.dll).

  7. Enter Analytics Server as the Partner Name.

  8. Click Save and Close.

Creating Deep Links in Analyses: Procedure

Create deep links in analyses to navigate from analytics to specific attributes and objects in your transactional pages to work with them directly.

To create deep links in an analysis:

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

  2. Create or edit an analysis. Use a subject area that includes the attribute you want to link to in the transactional pages, and ensure that you include the object ID.

  3. On the Criteria tab, click the Options icon for the attribute column on which you need a deep link and select Column Properties.

  4. Open the Interaction tab in the Column Properties dialog box.

  5. In the Primary Interaction list in the Value section, select Action Links to display the Action Links table.

  6. Select the Do not display in a pop-up if only one action link is available at runtime option.

  7. Click Add Action Link.

  8. In the New Action Link dialog box, enter the link text for the navigation.

  9. Click the Create New Action icon and select Navigate to a Web Page.

  10. In the Create New Action dialog box, enter the URL to navigate to, which references parameters you define in the prompt. For shared analyses://<hostname>/fscmUI/faces/deeplink?objType=@{1}&objKey=<object ID>=@{2}&action=@{3}&returnApp=AnalyticsApp&returnAppParams=PortalGo%26path=</shared/Custom/<folder>/@{6}

    For personal analyses stored in My Folders: //<hostname>/fscmUI/faces/deeplink?objType=@{1}&objKey=<object ID>=@{2}&action=@{3}&returnApp=AnalyticsApp&returnAppParams=PortalGo%26pather=/users/@{5}/@{6}

  11. Click Define Parameters to add corresponding parameters for the URL.

  12. In the Define Parameters section, click Add Parameter to add the following mandatory parameters:

    Name Prompt Type of Value Value Fixed Hidden Notes

    1

    Object Type

    Value

    <Object Type>

    Selected

    Selected

    Used for shared and personal analyses.

    2

    <Prompt Name>

    Column Value

    Column Name in "<table.name>"."<column.name>" format

    Selected

    Selected

    Used for shared and personal analyses.

    3

    Action

    Value

    edit

    Selected

    Selected

    Used for shared and personal analyses.

    4

    returnApp

    Value

    AnalyticsApp

    Selected

    Selected

    Used for shared and personal analyses.

    5

    Logged in User

    Session Variable

    USER

    Selected

    Selected

    Session variable parameter used for personal analysis permissions.

    6

    Report Name

    Value

    Analysis Name

    Selected

    Selected

    Used for shared and personal analyses. The name of the analysis to return to after working in the transactional page.

  13. Click Options to set how the page opens.

  14. In the Action Options dialog box, select Open in New Window to open the page in a new window.

  15. Save your work.

  16. If you have provided the Return Application name, a Return icon is available in the transactional page to return to the analysis.