2Setup and Configuration

This chapter contains the following:

Overview of Setup and Administration

Tools for Administering Analyses and Reports

You can use several different tools to manage and administer your analytics. Analytics can be reports or analyses, depending on how you intend to display and distribute them.

These components support modification and administration of your analyses and reports:

  • Use the Business Intelligence catalog to interact directly with your reports and analyses. Use this interface to manage permissions, properties, and the organization of your analyses and reports.

  • Use the Oracle Business Intelligence Publisher administration pages to configure settings specific to the running and scheduling of operational reports, such as setting up your delivery servers, managing scheduler work load, and setting run-time properties for reports.

Map to Work Areas

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.

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.

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.

Set Up Currency

Currency and Exchange Rate Settings for Analytics

CX Sales applications let you to decide how currency is shown in the application, as well as preferences for how analytics show currency and calculate exchange rates. Currency can be set in different regional currency types, depending on where you do business and what currency types you want to see.

There are three ways you set up currency:

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

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

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

Note: The time zone preferences that you set in your fuse simplified user interface are inherited in OTBI and will be used as the time zone setting for your existing and new analytics.

Set General User Currency

User currency settings determine the currency used as the default for what you see in your application. User currency applies to your entire interface for your signed-in session.

  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.

Set Analytics Currency

The analytics currency settings determine the currency type that is displayed in all your analytics. It also determines how and when your currency conversion rates are calculated.

  1. Navigate to Business Intelligence.

  2. Click Analytics in the navigator menu.

  3. Click Browse Catalog.

  4. Click your user name and select My Account.

  5. Go to the Preference.

  6. Select your choice in Currency.

This shows the currency display options for users:

Currency Display Type 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.

Set a Default Currency Conversion Option for All Users

By default your currency is converted to the corporate currency with a method we call "User Preferred Currency Using Simple Currency Management". This simple setting provides the best run-time performance because when you run a report, the application doesn't have to look up the rate for each transaction. The currency was converted to your corporate currency at that day's rate when you updated and saved the record. Otherwise, the application cycles through each record at run-time and converts the currency one record at a time to the exchange rate in effect at the time. For more information see, How User Preferred Currency Exchange Works.

But you can also 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.

Set a Global Currency Conversion Profile

Set a global currency conversion method for all your users by creating a currency profile. Only administrators can create currency profiles.

  1. In Setup and Maintenance, go to Manage Profile Options.

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

  3. Click Save and Close.

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

  5. Click Save and Close.

Define Currency Profile Values

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

  1. In the Setup and Maintenance work area, useManage Administrator Profile Values.

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

  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.

How User Preferred Currency Exchange Works

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.

Create the Treasury Conversion Rate Type

You must create a conversion rate type with the name 'Treasury' to generate reports with constant dollar related data.

You can create this conversion rate from the Currency Rates Manager page.

Based on your access permissions, you can access this page either from the

  • Period Close work area; or

  • Functional Setup Manager, with tasks like the Manage Conversion Rate Types and Manage Daily Rates.

For example, to create the Treasury conversion rate from the Period Close work area:

  1. In the Navigator, click Period Close.

  2. In the Period Close work area, from the Tasks panel, select Manage Currency Rates.

  3. From the Actions menu, select Add Row and create the new conversion rate type with the name Treasury.

  4. On the Daily Rates tab, enter the currency rates for the Treasury conversion rate type.

Note: You must set up the constant dollar conversion rate from every currency to CD for all dates in a year. During currency conversion, the "From" currency is taken from the transaction and the "To" Currency will always be CD for constant dollar.

Configure Business Intelligence Publisher

Overview of Report Delivery Servers Management

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.

Navigate to the BI Publisher Administration Page

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.

Configure Report Delivery Servers

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. You can also configure role-based access to delivery servers.

Configure Printers

You can set a default printer for your account and restrict access to a printer by roles.

Set a Default Printer

You can set a default printer for your account so that when you schedule a job with the destination as Printer, this printer is selected. However, you can select another printer assigned to your role.

To set a default printer:

  1. Navigate to BI Publisher using the https://<FA_instance_host>/xmlpserver URL.

  2. Click your user name and select My Account.

  3. In the General tab, select a printer from the list and click OK.

Restrict Access to a Printer by Roles

By default, the access to a printer is set to Public, which makes it available to all users. But you can configure which roles can access a printer.

  1. Navigate to the Administration page.

  2. In the Delivery section, select Printer.

  3. In the Printer tab, add a new printer or select an existing one.

  4. In the Access Control section, deselect Public.

  5. Select one or more roles you want to provide access to the printer, and click Move to add them to the Allowed Roles.

  6. Click Apply.

Overview of Report and Delivery Processors

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

Manage Report Processing and Delivery Server Load

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.

Diagnose Report Processing Issues

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.

Configure System Properties for Reports

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

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

FTP and SFTP Delivery Retry Property

By default, if FTP or SFTP delivery fails, another attempt is made to deliver the file to the failed destination 10 seconds later. When you set the Enable FTP/SFTP delivery retry property to False, no retry attempt is made. This setting affects all of the FTP and SFTP delivery requests, and can't be configured for individual servers.

XPT Template Properties

Configure XPT templates by setting the properties described in the table.

Property Name Description Default

XPT Scalable Mode

When you set this property to true, scheduled reports that use the XPT template and include a large amount of data run without memory issues. The first 100,000 rows of data in the report are stored in memory and the remaining rows are stored in the file system.

For reports that contain smaller amount of data, you can set this property to false. So, scheduled reports that use the XPT template are processed in-memory.

true

Enable Asynchronous Mode for Interactive Output

When you set this property to true, interactive reports that use the XPT template make asynchronous calls to Oracle WebLogic Server.

When you set this property to false, interactive reports that use the XPT template make synchronous calls to Oracle WebLogic Server. Oracle WebLogic Server limits the number of synchronous calls. Any calls that are stuck expire in 600 seconds.

true

Overview of Memory Guard Settings

Memory Guard settings for Oracle BI Publisher have default settings optimized for performance.

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.

Use a Dedicated Business Intelligence Publisher Cluster for Critical Jobs

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.

Download Armored PGP Public Key Files

To support encrypted communication channel from the BI Publisher Server to an FTP site, you download a Pretty Good Privacy (PGP) public key file in ASCII armor format and configure your FTP server to use PGP encrypted files in that format.

Download PGP Public File

Download PGP keys in the BI Publisher Administration page.

To download a PGP key in armored format:

  1. Navigate to the BI Publisher Administration page.

  2. In the Security Center section, click the PGP Keys link to open the PGP Keys page.

  3. In the PGP Keys section, click the Download BI Publisher Key [name] (ASCII armored) Download icon.

  4. In the Opening bipublisher@oracle.com.key dialog box, click OK. Enter a name for the key or accept the default in the Save dialog box and click OK.

Upload and Apply PGP Keys for PGP Encryption for FTP Delivery

To secure report delivery through the FTP/SFTP channel, you can encrypt the report using PGP Encryption.

Upload PGP Keys

You upload, test, and delete PGP keys in the BI Publisher Administration page.

To upload PGP keys:

  1. Navigate to the BI Publisher Administration page.

  2. In the Security Center section, click the PGP Keys link to open the PGP Keys page.

  3. In the PGP Keys section, click Browse and select the PGP key file in the Open dialog box.

  4. Click OK.

  5. Click Upload. After the file is uploaded, it is imported into the keystore and its details are visible in the PGP Keys table. If a key with the same ID is imported again, the file is overwritten.

  6. Click the Download icon of the key in the Encrypted Test Output column of the PGP Keys table to download and decrypt a test output file using the secret key of the imported public key. Successful decryption confirms the encryption is working for your keys.

Delete a PGP Key

To delete an imported public key, click the Delete icon.

Apply PGP Encryption to FTP Delivery Channel

To create an FTP channel:

  1. Navigate to the BI Publisher Administration page.

  2. In the Delivery section, click the FTP link to open the FTP page.

  3. Add a new FTP Server, using the user name and the password and private key password set when you created the PGP key. The Filter Command field is read-only and is updated automatically when you select a PGP key.

  4. Click Test Connection.

  5. Select the PGP Key ID of the key you uploaded from the list.

  6. If you want PGP encrypted output in ASCII armored format on the destination FTP server, select the ASCII Armored Output check box. The Filter Command is updated with a -a option.

  7. Select the true check box for Sign Output to sign the encrypted document. If you select this check box, a -s parameter is added to the existing filter command.

  8. Test the connection again. The FTP delivery channel can now be used in a scheduled job.

Configure the Email Addresses and Whitelist Email Domains for Notifications

Use the Delivery Configuration Options page to set e-mail addresses and restrict email delivery to whitelisted email domains for report deliveries and notifications from BI Publisher.

To configure the email address and whitelist domains for delivery:

  1. Log in as an administrator.

  2. In the BI Publisher home page, click Administration, and then click the Delivery Configuration tab.

  3. Enter the email addresses in the Email From Address and Delivery Notification Email From Address fields.

  4. Enter the email subject text in the following fields:

    • Success Notification Subject

    • Warning Notification Subject

    • Failure Notification Subject

    • Skipped Notification Subject

  5. Enter the domains, separated by a comma, you want to allow email to in the Email Domain Whitelist field. The default, *, allows all domains.

  6. Click Apply.

Upload and Manage Configuration-Specific Files

Use Upload Center to upload and manage the configuration-specific files for font, digital signature, ICC profile, SSH private key, and SSL certificate.

To upload and manage configuration-specific files:

  1. From the BI Publisher Administration page, click Upload Center.

  2. Click Browse and select the file you want to upload.

  3. Select the configuration file type.

    Note: A digital signature file should have a .pfx or .p12 extension. Signature files with other exceptions fail to upload due to incorrect extension.
  4. If you want to overwrite an existing file with the new file, select Overwrite.

  5. Click Upload.

  6. To manage the uploaded files, use the Filter By Type field to filter the files in the table.

Use Non-Standard Fonts

If you want to use non-standard fonts, you can upload them using either the Upload Center tab on the System Maintenance page, or the Font Mappings tab on the Runtime Configuration page. Fonts uploaded through either are listed in the other.

You can map a font for a report or globally. If you map fonts at the report level, then map fonts at the globally, the report-level fonts override the newer fonts. You can change this in the report properties.

Set Up and Configure Auditing and Monitoring

BI Publisher logs statistics about user activity using that can be reported on in reports. An administrator can set the level of auditing and monitoring or turn them off.

Logged User Events

Important report publishing events are logged in the audit database, including the following. You can control the level of auditing.

  • Tracks the start and end time of request events for reports (normal and scheduled).

  • Tracks the relationship between requested start time, report execution events (data processing, bursting, rendering, and delivery), and request end events for report requests

Access Audit Records

To access audit records:

  1. Configure the AuditDB data source.

    1. Click Administration.

    2. Click the JNDI Connection.

    3. Click Add Data Source, and enter:

      • Data Source Name: AuditDB

      • JNDI Name: jdbc/AuditViewDataSource

    4. Click Test Connection to confirm the connection.

    5. Click Apply.

  2. Create a data model.

    1. In the Home page, click New and select Data Model.

    2. Click New Data Set and select SQL Query.

    3. In the Edit Data Set dialog box, select AuditDB in the Data Source list.

    4. Accept the default, Standard SQL, in the Type of SQL list.

    5. Enter the following SQL statement:

      SELECT IAU_TSTZORIGINATING, IAU_INITIATOR, IAU_EVENTTYPE, IAU_RESOURCE from BIPUBLISHER_V 
      ORDER BY IAU_TSTZORIGINATING DESC
    6. Click OK.

    7. Click Save to save the data model.

    8. Click View Data.

    9. In the Data tab, click View.

    10. Click Save As Sample Data.

    11. Click Save to save the data model.

    12. Click Create Report.

  3. Create a simple report with table layout.

Configure Auditing and Monitoring Levels

Administrators can configure auditing and monitoring in the BI Publisher Server Configuration page.

To manage auditing and monitoring:

  1. Click the Administration link.

  2. In System Maintenance, click Server Configuration.

  3. In the Monitor and Audit section, select the appropriate option:

    • To enable both auditing and monitoring, select Enable Monitor and Audit, and select Medium from the Audit Level list.

    • To disable both auditing and monitoring, deselect Enable Monitor and Audit.

    • To disable auditing and enable monitoring, select Enable Monitor and Audit, and select None from the Audit Level list.

  4. Click Apply.

Configure Deep Links

Register Business Intelligence to Support Deep Linking

Deep linking lets you to navigate from an analysis on the interface pages to specific attributes and objects in your work areas so that you can work with them directly. What does that mean? It means that if you are looking at an analysis on leads, for example, you can click a record on the analytic and go edit the lead record on the edit object page. To support deep links, use the Setup and Maintenance work area to register the Business Intelligence Server as a third-party application.

Register Business Intelligence Server as a Third-Party Application

To register the BI Server:

  1. Use the Manage Third Party Applications page.

  2. Click Create.

  3. Enter AnalyticsApp as the application name.

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

  5. Enter Analytics Server as the Partner Name.

  6. Click Save and Close.

Create Deep Links

Create deep links in your analytics that let you navigate from an analytic to specific attributes and objects in your transactional pages to work with them directly.

  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.

Configure Deep Links in Oracle Product Lifecycle Management Cloud

For products that come under Oracle Product Lifecycle Management (PLM) Cloud, the URLs that are supplied for deep links in the Create New Action dialog box of Oracle Business Intelligence Enterprise Edition (OBIEE) use the following format: Base URL + Generic Part of Link + Object-Specific Arguments.

The URLs contain these elements:

  • An application-specific base URL, such as https://demo.oracleserver.com/.

  • A generic part, which is the same for all links: fscmUI/faces/deeplink?.

  • Object-specific arguments, which are provided in the objType&action&objKey format.

An example of a complete, case-sensitive URL is as follows: https://demo.oracleserver.com/fscmUI/faces/deeplink?objType=CHANGES&action=EDIT&objKey=changeObjectId=<CHANGE_ID>

The following table lists the objects that are supported for deep links in the Innovation to Commercialization lifecycle process of Oracle PLM Cloud. For each object, the corresponding arguments are provided.

Object Object-Specific Argument

Change

objType=CHANGES&action=EDIT&objKey=changeObjectId=<CHANGE_ID>

Concept

objType=CONCEPTS&action=EDIT&objKey=conceptId=<CONCEPT_ID>

Idea

objType=IDEAS&action=EDIT&objKey=ideaId=<IDEA_ID>

Item (opens in Oracle Product Development Cloud)

objType=ITEMS&action=EDIT&objKey=itemId%3D<INVENTORY_ITEM_ID>%3BorgId%3D<ORGANIZATION_ID>

Note: The object-specific argument should be manually entered as provided in the URL field after the parameters are defined. A placeholder should be used in place of the INVENTORY_ITEM_ID parameter value in the format required by OBIEE. The orgId parameter must be explicitly set to the ID of your organization.

Manufacturer

objType=MFRS&action=EDIT&objKey=partyId=<TRADING_PARTNER_ID>

Note: The link works for only those manufacturers that are created in Oracle Product Development Cloud.

Manufacturer Part

objType=MPN&action=EDIT&objKey=tpItemId=<TP_ITEM_ID>

Note: The link works for only those manufacturer parts that are created in Oracle Product Development Cloud.

New Item Request

objType=NIRS&action=EDIT&objKey=changeId%3D<NEWITEMREQUEST_ID>%3Bmode%3DviewOrEdit

Note: The object-specific argument should be manually entered as provided in the URL field after the parameters are defined. A placeholder should be used in place of the NEWITEMREQUEST_ID parameter value in the format required by OBIEE.

Portfolio

objType=PORTFOLIOS&action=EDIT&objKey=bvForPortfolioId=<PORTFOLIO_ID>

Proposal

objType=PROPOSALS&action=EDIT&objKey=productProposalId=<PROPOSAL_ID>

Quality Action

objType=ACTIONS&action=EDIT&objKey=actionId=<ACTION_ID>

Quality Issue

objType=ISSUES&action=EDIT&objKey=issueId=<ISSUE_ID>

Requirement Specification

objType=REQUIREMENTS&action=EDIT&objKey=requirementId=<REQUIREMENT_ID>

In the preceding table, the parts of the object-specific arguments that are in boldface must be manually inserted into the links in the URL field of the Create New Action dialog box after the parameters are defined. The angle brackets and the enclosed text are placeholders for the ID columns that must be manually specified in the Define Parameters group of the dialog box. The resulting link in the URL field, including the placeholders that are dynamically inserted for parameter values by OBIEE, should be similar to the following: https://demo.oracleserver.com/fscmUI/faces/deeplink?objType=@{1}&action=@{2}&objKey=changeObjectId=@{3}

Note: Ensure that the values in the ID columns in your analyses don't have decimal values or commas. Deep links that use ID columns with decimal values or commas don't work for Oracle PLM Cloud.

FAQs for Deep Links

Why did a deep link open to a blank page?

You may not have access to the linked object, or the URL entered for the action is incorrect, for example lacking the environment or the Object ID name.

  • Check the URL you entered for the action. It may be missing the environment name or the Object ID name.

  • Check the URL parameters, the spelling of the action, and that you're using the right key in the object's analysis.

Do I have to display the ID for my object?

No, you can add it, format the column as a number with zero decimals, and then hide the column.

Can I display actions for some users and not others?

Yes, you define conditions for the action to display.

Set Up the Delivery Channel

Set Up the Delivery Channel and Enable Encryption

BI Publisher supports Oracle WebCenter Content as the recommend delivery channel for delivering reports for distribution. You can use the provisioned connection to deliver files from BI Publisher to WebCenter Content, or configure a custom connection to deliver Pretty Good Privacy (PGP) encrypted files from BI Publisher.

Using the Default Connection

By default, a provisioned WebCenter Content connection, FA_UCM_Provisioned, uses a provisioned FUSION_APPS_OBIA_BIEE_APPID user to connect to WebCenter Content with security groups and accounts to support the most common use cases.

Creating a Custom Connection

If you have specific requirement to access WebCenter Content using user credentials other than FUSION_APPS_OBIA_BIEE_APPID, or if you want to use PGP key encryption, you can add a custom connection.

When you create a custom connection for WebCenter Content, it must use the same Uniform Resource Identifier (URI) as the provisioned connection, but should have its own user name and password.

To create a custom connection:

  1. In the BI Publisher Administration page, navigate to the Content Server tab in the Delivery section, and click Add Server.

  2. Enter the same URI used by the provisionedFA_UCM_Provisioned WebCenter Content server.

  3. Enter the server name, URI, user name, and password.

  4. Leave Enable Custom Metadata deselected. Custom metadata is not used.

  5. Click Test Connection to ensure that you can connect.

  6. Click Apply.

Configuring File Encryption

You can use PGP encryption to secure the file delivery.

To use PGP encryption:

  1. Upload the PGP public keys to import the PGP keys of WebCenter Content.

    1. Navigate to the Security Center section in the BI Publisher Administration page.

    2. Click PGP Keys to open the PGP Keys page.

    3. In the PGP Keys section, click Browse and select the PGP key file in the Open dialog box.

    4. Click Upload. The uploaded file is imported into the keystore and its details are visible in the PGP Keys table. If a key with the same ID is imported again, the file is overwritten.

    5. Click Download for the key in the Encrypted Test Output column of the PGP Keys table to download and decrypt a test output file using the secret key of the imported public key. Successful decryption confirms the encryption is working for your keys.

  2. Enable delivery of PGP encrypted files in a custom connection to WebCenter Content.

    1. Navigate to the Delivery section and the Content Server page.

    2. Select the custom content server connection you want to configure.

    3. Select the imported key by its ID from the PGP Keys list and verify that the GPG command is populated in the Filter Command.

    4. Click Apply.

Deliver Content

Use a scheduled job to deliver content and documents.

Scheduling a Job to Deliver Content

To schedule a job to deliver documents:

  1. In BI Publisher, click Create and select Report Job.

  2. In Schedule Report Job, on the General tab, click search for the Report field.

  3. In the Open dialog box, navigate to and select the report, and then click Open.

  4. In Schedule Report Job, in the Frequency list on the Schedule tab, select the option to use for this report.

  5. (Optional) In Schedule Report Job, on the Output tab, select Compress output prior to delivery to compress the output for all formats except HTML. When the output is delivered, it's compressed except for zipped PDF format in all delivery channels and HTML Output format in the Email delivery channel. If the delivery destination is Email, reports are attached to emails in <Name>_<Output Format>.zip format.

  6. In Schedule Report Job, on the Output tab, choose Content Server in the Destination Type list.

  7. Click Add Destination.

  8. Select the server from the Server list.

  9. Select the WebCenter Content security group to assign to the report.

  10. (Optional) Select an account within the Security Group to assign to the report.

  11. (Optional) Select the Folder Path to deliver files to an existing folder in the content server.

  12. (Optional) Enter a value for Author. If you don't enter an author, your user name is used for the Author metadata in WebCenter Content.

  13. (Optional) Type a Title for the report. If you don't enter a title, the layout name is used for the title.

  14. Enter the file name to assign to the delivered document on the remote server, for example, myreport.pdf.

  15. Ensure that you don't include files with the same name in one folder. The File Name field is used as the Native File Name in WebCenter Content. If you don't supply a file name value, the Output name is used.

  16. (Optional) Type a description to include with the document in WebCenter Content.

  17. Deselect Include Custom Metadata.

  18. Click Submit.

  19. In the Submit dialog box, type a name in the Report Job Name field, and click OK.

  20. Click Home and navigate to the Report Job History page to verify the report delivery status.

Defining a Bursting Query to Deliver to Deliver Content

Bursting is a process of splitting data into blocks, generating documents for each block, and delivering the documents to one or more destinations. The data for the report is generated by executing a query once and then splitting the data based on a key value. For each data block, a separate document is generated and delivered. The bursting query is a SQL query that you define to provide the required information to format and deliver the report.

To deliver reports to WebCenter Content, define the bursting job with WCC as the delivery channel, and configure the parameter values as shown in the table.

Parameter Value

DEL_CHANNEL

Delivery channel. Specify WCC for WebCenter Content.

Parameter1

Server name

Parameter2

Security group

Parameter3

Author of the file

Parameter4

Account (Optional)

Parameter5

Title

Parameter6

Output file name

Parameter7

Comments (Optional)

Parameter8

Content ID (Optional) If you specify the ID, it must be unique. If you don't specify the ID, a unique ID is generated.

Parameter9

Custom metadata, set as true or false. Specify false.

Parameter10

Folder Path

Note: Ensure that you don't include files with the same name in one folder and that the Content ID is unique.

The following is a sample query for bursting reports:

select distinct
	select distinct
		product_status as "KEY", -- Split Key from data model SQL
		'BurstTemp' TEMPLATE, -- Report template name
		'en-US' LOCALE,
		'PDF' OUTPUT_FORMAT, -- Output type
		'WCC' DEL_CHANNEL, -- To send to content server
		'Custom_UCM' PARAMETER1, -- Content server name
		'CRMStage' PARAMETER2,	 -- Security group
		'hcm.user' PARAMETER3,	-- Author of the file
		' PARAMETER4,	 -- Account (Optional)
		'Test_Burst' PARAMETER5, -- Title
		Product_Status|| TestFile.pdf'PARAMETER6, -- Output File name
		Product_Status PARAMETER8, -- Content ID (Optional)
		'false' PARAMETER9, -- Custom metadata (Optional)
		'/Contribution Folders/Test12311/Check' PARAMETER10	 -- Folder path to deliver files
from products

Chunk Data for Large XML Reports

To support distributed processing for large and long-running reports, you can enable chunking of report data.

If you enable data chunking, the data model pre-processor uses a designated split key to split large amounts of XML data into several chunks of data of manageable size. The layout processor outputs individual XML data chunks and merges them to generate a consolidated final report output.

Limitations

Before enabling chunking, you should understand its limitations and recommended uses. Data chunking:

  • Is best suited for listing reports. The most straightforward application is a listing report with a table with no cross-referencing.

  • Supports sorting, grouping, aggregation, and cross-referencing operations only within the individual chunked output. The merged output doesn't support these data operations.

  • Supports page numbering, running totals, and other functions only within the individual chunked output, and each is reset with each chunked output.

  • Supports RTF, XPT, and eText output formats.

    Format Notes

    RTF

    Each chunked output starts from a new page.

    XLSX

    Each chunked output is on a separate sheet.

    E-Text

    Each chunked output is appended while generating final output.

  • Doesn't support the multiple output formats. If you select chunking during scheduling, multiple outputs aren't allowed.

  • Isn't supported for online reports.

Enable Chunking

You enable chunking for an instance, set chunking and a split key for a data model, and then set chunking and a chunk size for a report.

To enable chunking for an instance and set a default chunking size:

  1. From the BI Publisher Administration page, click Properties.

  2. Select True for Enable Data Chunking. The default is False.

  3. Enter a chunk size. The default is 300MB, and valid chunk sizes are 100MB to 300MB.

  4. Click Apply.

To enable chunking for a data model:

  1. In the Data Model Editor, select Chunking.

  2. Select Enable Chunking.

  3. Select an attribute in the Split By list.

  4. Click Save.

Once you have enabled chunking for your reports, specify chunking when you schedule the report job.

  1. In Schedule Report Job, on the General tab, select Use XML Data Chunking.

  2. Specify an output. Chunked jobs can have only one output.

  3. Click Submit.

Consolidated Output with Attachments from a Bursting Job

A bursting job splits data, generates reports, and delivers the reports to one or more destinations. When you create a bursting job, you have an option to create a consolidated output. The consolidated output combines all the reports from a bursting job in a single consolidated PDF file. If the bursting output format is zipped PDF (PDFZ), then a consolidated PDFZ output is created. If the reports of the bursting job include attachments, then the consolidated output also includes the attachments of all the reports.

When the consolidated output is a PDFZ file, it includes a docindex.xml file that provides an index of all PDF outputs and attachments in the consolidated PDFZ file.

Limitation

The PDFZ output format isn't suitable if you want to:

  • Enable password protection for the compressed PDF output.

  • Use the PDF splitting feature in the RTF template. The index.xml and index.html files in the consolidated output don't have the corresponding catalog index if you use the splitting feature in the RTF template.

  • Generate individual files from the consolidated PDFZ file.

  • Retain the page numbers of all the reports and attachments in the consolidated PDFZ file. The page numbers change because the reports and attachments are merged in the PDFZ file.

  • Include angular brackets (<>) or special characters (such as &,',", and so on) in the index variables. The XML parser doesn't support these characters.

Note: It is recommended that you don't create a single consolidated PDF output of extremely large size. You must assess the size of PDF attachments, individual outputs through bursting, and count of associated jobs to avoid creating extremely large consolidated output file.

Embed Analyses and Dashboards

Whitelist Safe Domains

You whitelist safe domains to approve access to specific content. For security reasons, external content can't be added to reports and reports can't be embedded in other applications unless it's safe to do so. Only administrators can add safe domains to the white list.

Only authorized users may access the content. Except in cases where Single Sign On (SSO) is enabled, users are prompted to sign in when they access content on safe domains. After you have added a safe domain to the white list, users need to sign out and sign back in to access content from that source.

  1. Click Navigator > Reports and Analytics.

  2. Click Browse Catalog.

  3. Click the Administration link on the BI Home page.

  4. Click the Manage Safe Domains link.

  5. To allow users to embed their analyses in content located on other domains, enter the name of the safe domain as well as the port. Here are a few formats you can use for port names:

    • www.example.com:<port number>

    • *.example.com:<port number>

    • https:

  6. Select the types of resources you want to allow and block any resource types you think aren't safe. For example, to allow embedding, select Embedding.

Embed Your Content in Other Applications

You can embed your reports in other non-Oracle applications and portals. This is a good way to share content and data among multiple systems. When other users click on embedded content, if you don't have single sign-on, they might have to sign in again to see the content.

Before you can embed a report in other applications or portals, your administrator must add the URL for the target applications or portal to the domain whitelist.

  1. Obtain the URL of the analysis or dashboard you want to embed.

    1. Go to the catalog and open the analysis or dashboard.

    2. In the URL displayed in the browser's address bar, delete "Portal", so that your URL resembles this example, then copy the URL.

      Content Example URL

      Analyses

      http://example.com:<port number>/analytics/saw.dll?Go&Action=prompt&path=%2Fshared%2F<folder>%20<analysis name>

  2. Sign in to the target application or portal, then embed the content inside an iFrame and use the copied URL.

Supply Chain Management Repository and Session Variables for Business Intelligence

You can use these repository and session variables in your analyses.

Variable Name Type Usage Offering

CURRENT_DAY

Session Variable

Returns the value of Current Date.

All

CURRENT_MONTH

Repository Variable

Returns the value of Current Month in the YYYY/MM format.

All

CURRENT_WEEK

Repository Variable

Returns the value of the current week in YYYY Weeknnn format.

All

CURRENT_QUARTER

Repository Variable

Returns the value of Current Quarter in YYYY Q n format.

All

CURRENT_YEAR

Repository Variable

Returns the value of Current Year in the YYYY format.

All

NEXT_MONTH

Repository Variable

Returns the value of Next Month in the YYYY / MM format.

All

NEXT_WEEK

Repository Variable

Returns the value of Next Week in the YYYY Week nn format.

All

NEXT_QUARTER

Repository Variable

Returns the value of Next Calendar Quarter in the YYYY Q nn format.

All

NEXT_YEAR

Repository Variable

Returns the value of Next Year in the YYYY format.

All

PREVIOUS_MONTH

Repository Variable

Returns the value of Previous Month in the YYYY/MM format.

All

PREVIOUS_WEEK

Repository Variable

Returns the value of Previous Week in the YYYY Week nn format.

All

PREVIOUS_QUARTER

Repository Variable

Returns the value of Previous Quarter in the YYYY Q nn format.

All

These variables are available for Supply Chain Management only.

Variable Name Type Usage Offering

CURRENT_MONTH_END_DATE_REP_OTBI

Repository Variable

Returns the current Gregorian month end date.

Supply Chain Management

CURRENT_MONTH_START_DATE_REP_OTBI

Repository Variable

Returns the current Gregorian month start date.

Supply Chain Management

CURRENT_WEEK_END_DATE_REP_OTBI

Repository Variable

Returns the current Gregorian week end date.

Supply Chain Management

CURRENT_WEEK_START_DATE_REP_OTBI

Repository Variable

Returns current Gregorian week start date.

Supply Chain Management

CURRENT_YEAR_END_DATE_REP_OTBI

Repository Variable

Returns the current Gregorian year end date.

Supply Chain Management

CURRENT_YEAR_START_DATE_REP_OTBI

Repository Variable

Returns the current Gregorian year start date.

Supply Chain Management

Last_Quarter_Days_OTBI

Repository Variable

Returns the number of days from the beginning of the last calendar quarter to the current date.

Supply Chain Management

This_Month_Days_OTBI

Repository Variable

Returns the number of days since the beginning of the current calendar month.

Supply Chain Management

This_Quarter_Days_OTBI

Repository Variable

Returns the number of days since the beginning of the current calendar quarter.

Supply Chain Management

ToUOM

Session Variable

Gets the user report-level reporting unit of measure (UOM), and passes it on to the UOM conversion calculation engine.

Supply Chain Management