9Analytics on Interfaces

This chapter contains the following:

Analytic Interfaces

These are all the areas on the CX sales interface where your users can view analytics. Some of these pages come prebuilt and can be personalized by your users, and some you need to set up.

You will need to work in a sandbox if you are setting up analytic interface pages for your sales users, such as adding infolet analytics, adding anaytics to side and sub-tabs, adding infolet pages or dashboards. The application requires you to be in a sandbox for most administrative tasks, with the exception of managing analytics on the BI side. But adding the analytics you manage in BI to the user interfaces listed in this topic requires working in a sandbox environment.

Note: When you're working with analytics, you need to ensure that you've completed the setup requirements. The Related Topics at the bottom of this topic takes you a list of what you need to do.
Type Description Visibility

Sales Pages

Includes five blank pages that administrators configure and add prebuilt or custom analytics for any area.

Not visible until administrators enable the Sales Pages in Set System Options.

Sales Infolet Page

Comes prebuilt with role-based analytics and infolets. One page for each role.

Not visible until administrators enable the Sales Infolets in Set System Options.

Object Pages

Analytics can be added to the following object page work areas:

For Sales:

  • Leads

  • Opportunities

  • Forecasts

  • Accounts

  • Households

  • Contacts

  • Activities

    For Service:

  • Service Requests

  • Work Orders

  • Queues

Analytics can be added to the object landing page or object edit page, such as the Opportunities page, or the Edit Opportunities page.

Analytics Page

This page is where users can add analyses themselves by searching for the analysis and making it a favorite.

Administrators make custom analytics available for users on the Analytics page by adding session variables on the analysis. These variables can show data specific to the user signed in and viewing her Analytics page.

Embed Analyses and Dashboards

Allow Safe Domains

You allow 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 allow safe domains.

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, 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 list of allowed domains.

  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.

Sandboxes

You use sandboxes to make application changes and test them without impacting other users in the environment. Wherever possible, make changes to the application in a sandbox rather than making direct changes in the mainline environment. Sandboxes set apart untested configuration changes from the mainline environment. So you can test your changes in the sandbox and then publish it. After publishing, your changes become available in the mainline metadata or other sandboxes after they're refreshed. So everyone can then see your changes in the environment. Mainline metadata is the primary branch of metadata a sandbox is published to.

Why You Need Sandboxes

Today's business landscape is quite dynamic. Companies are expected to respond quickly to address both customer and market needs. So multiple teams need to make application changes at the same time while sharing the same data model and configuration starting point. But you may get conflicts between teams working that way. To avoid such conflicts, sandboxes come in handy.

Here are a few things you can do using sandboxes:

  • Select the configuration tools to enable for your sandboxes while creating them. Since you enable all configuration tools in the same way using the Sandboxes UI, you get a consistent sandbox experience across tools.

  • Restrict access to various sandbox activities for users. For example, you can specify these access rights for your sandboxes:

    • Full access

    • Edit and preview access

    • View only access

  • View just your application changes without having other context layers hide your content.

  • Test your changes in a preview mode that shows you exactly how your application changes would appear in a published sandbox.

  • Refresh and merge sandboxes with latest changes in mainline metadata from other published sandboxes. After merging all changes, you can publish your sandbox.

  • If you register your target environment in your source environment, you can do these additional migration tasks using the Migration UI:

    • Migrate your changes from the test environment to the target environment without manually downloading and uploading the configuration set file.

    • Move only new changes from the source environment to the target environment.

Sandbox Usage

You typically use sandboxes for either of these purposes:

  • Test-Only: You can make application changes using test-only sandboxes, which you don't want to publish to the mainline code.

  • Publish: Once satisfied with the application changes made in the test-only sandbox, you can replicate these changes in a sandbox that you want to publish. And then publish your changes to the mainline code. This sandbox type is also known as the integration sandbox, because teams working in parallel use this sandbox as the final staging point before publication to the mainline code.

Note: Before each patch or upgrade, publish or delete your sandboxes. If you haven't yet completed your work, restart with a new sandbox.

To make changes to the application, you must first store the changes in an active sandbox. You can either create a sandbox or select an existing one, and make it active. You must activate the configuration tools you want to use in your sandbox. If you plan to use Page Composer in your sandbox and edit pages at a layer other than Site, you need to create a sandbox just for that layer, and activate only Page Composer in it.

Note: You can create up to 20 sandboxes. But, you can increase this limit using the Maximum Number of Sandboxes profile option. In the Setup and Maintenance work area, use the Manage Applications Core Administrator Profile Values task in the Application Extensions functional area.

Create and Activate Sandboxes

Follow these steps to create and activate sandboxes for most configuration tools. For flexfields, use the Manage Descriptive Flexfields task or the Manage Extensible Flexfields task instead.

  1. Click Navigator > Configuration > Sandboxes.

  2. On the Sandboxes page, click Create Sandbox.

  3. Enter a name and description for your sandbox.

  4. In the Publishable field, select Yes or No. If you set this option as No, you can just use your sandbox for testing purposes, but can never publish it.

  5. In the All Tools section, select the tools you want to activate for this sandbox. The context layers for all selected tools are set as Site by default. So the changes you make using these tools affect all users.

  6. If you select Page Composer, you can click the Edit Sandbox Context icon and change the context layer from Site to another layer, for example External. You can find the Edit Sandbox Context icon in the Support Context column.

    Note: If you want to use other tools along with Page Composer in your sandbox, don't change the context layer for Page Composer, even though you can. That's because all tools except Page Composer support only a single context layer, Site. So if you change the context layer for Page Composer from Site to any other layer, all other tools that you might have selected earlier will be deselected.
  7. Click Create to just create the sandbox, or Create and Enter to enter or activate the sandbox after creating it.

Here are a few things to know about activating tools in your sandbox.

  • If you try to use a configuration tool in a sandbox without activating the tool in it, you get a message prompting you to activate the tool. You can add more tools to your sandbox later also.

  • To create and manage saved searches and make UI adjustments (for example, change a table's column width) just for yourself, you must leave your sandbox before making these changes. But if you want to make these changes for others too, then make the changes with Page Composer open, in which case you also must be in a sandbox.

Activate Existing Sandboxes

Follow these steps to activate a sandbox.

  1. Click Navigator > Configuration > Sandboxes.

  2. From the list of sandboxes, if available, find the one you want to activate, and click the Enter Sandbox icon for that sandbox. Your sandbox is activated, and you can see its name on the sandbox bar before the global header. You can use the options available on the sandbox bar to quickly do some activities, such as view sandbox details, publish the sandbox, or leave the sandbox.

After you're done making changes to the application, publish the sandbox to make your changes available to all users. You must have the Administer Sandbox (FND_ADMINISTER_SANDBOX_PRIV) privilege to publish sandboxes. Remember, you can't make further changes in the sandbox once you publish it.

Before you start, do these tasks:

  • Test or validate your changes in the sandbox in preview mode before actually publishing it. If you made changes using Page Composer, don't forget to close it before testing. To preview your changes, on the sandbox bar before the global header, click Sandbox Mode, and select Preview as if Published (Context: All).

    Note: You can see the sandbox bar only when you're in an active sandbox.
  • Resolve all conflicts flagged in the merge log of your sandbox.

To publish a sandbox:

  1. Click Navigator > Configuration > Sandboxes.

  2. On the Sandboxes page, click the name of the sandbox you want to publish.

  3. Click Publish.

    Note: You might not be able to publish your sandbox because of various reasons. For example, you haven't yet made any changes in your sandbox, or the Control Publish Sandbox Action in Production Environment profile option (FND_ALLOW_PUBLISH_SANDBOX) is set to No.
  4. Click Continue to Publish. The sandbox is published to the mainline metadata.

  5. Click Done.

Infolets

Overview of Infolets

An infolet is a small interactive widget that gives you key information and shows you what's going on in the areas you work on. You might also find something that you need to follow up on. You can use infolets arranged in tabs in the Analytics section of your home page. If you're using a panel or banner layout, use the page control icons to use the infolets.

Here are a few things to know about infolets.

  • Infolets have a front view, and might have a back and expanded view. Use the Back View, Front View, and Expanded View icons at the bottom corners of an infolet to open these views.

  • Your current infolet view persists as the default view the next time you sign in. For example, if you viewed a back view of the infolet in your last session, you will see the same view by default in your next session.

  • Some infolets might also contain links to detailed reports. You can click anywhere in the infolet area to drill down to the detailed report.

  • You can also personalize the infolets. For example, you can move or hide them on the infolets page.

  • If you don't see infolet pages on your home page, then your administrators must have disabled them to show on the home page.

Note: Some SCM or Procurement Cloud infolets might function differently from other infolets.

Here's how an infolet page looks.

A page showing infolets.

Personalize Infolets

You can personalize the infolets on your infolets page, such as you can edit their titles and views, move them, or hide or show specific infolets on the infolets page.

Edit Infolet Titles and Views

  1. Click the Actions icon on the top right corner of the infolet, and select Edit Title and Views.

  2. Edit the infolet title, and enable or disable the infolet views.

  3. Click Save and Close.

Reorder Infolets

You can change the position of an infolet within an infolet page.

  1. Click the Infolet Repository icon, and select Reorder Infolets.

  2. In the Reorder Infolets dialog box, select the infolets, and use the arrows to reorder them.

    Tip: To select multiple infolets, press the Ctrl key, and then select them.
  3. Click Apply.

Hide or Show Infolets

To hide an infolet from an infolet page, click the Infolet Repository icon, and deselect the infolet from the list of infolets.

Tip: Alternatively, click the Actions icon on the top right corner of the infolet, and select Hide.

To show a hidden infolet on an infolet page, click the Infolet Repository icon, and select the infolet from the list of infolets.

Configure Infolets

You can configure infolets that aggregate key information for a specific area, for example, social networking or personal profile. Your users use infolets arranged in tabs in the Analytics section of the home page. Or, if it's a home page with a panel or banner layout, they use the page control icons.

If your users don't find infolet pages on the home page, you can enable them by using the Home Configuration tab in the Structure work area. Let's look at some tasks you can do to configure infolets.

  • Create infolets.

  • Add content to infolets. For example, you can add a task flow or a performance tile report, and if an infolet contains a performance tile report, then you can add a link to a detailed report in the same infolet.

    Note: In the context of infolets, a report is an analysis, not a BI Publisher report.
  • Edit infolets. For example, edit infolet content and add, change, or remove link to detailed report.

  • Delete infolets.

But before you start creating and editing infolets, here are a few things to keep in mind:

  • You can add analyses from the catalog to an infolet, but not BI Publisher reports, or other objects like filters or prompts.

  • To create or edit infolets, you must first either create and activate a sandbox, or activate an existing one. But make sure the sandbox has the Page Composer tool selected. If you want to make changes in a context layer that isn't the default layer, Site, you must create a separate sandbox just to use Page Composer in it. You can then change the context layer from Site to the other layer. For example, to create or edit infolets for a user with a specific job role, you must select the Job Role context layer.

  • You can validate your changes in the sandbox in preview mode before you publish it.

Use infolet pages to create infolets. You can create an infolet, add content to it, and link detailed reports. For some product-specific infolet pages, you can't create infolets.

  1. Activate a sandbox that has the Page Composer tool in it.

  2. Open an infolet page.

  3. Click your user image or name in the global header, and on the Settings and Actions menu, select Edit Pages.

  4. Click the Infolet Repository icon, and select Create Infolet.

    Note: If you can't find the Create Infolet menu item, it means you can't create infolets for this page.
  5. Enter a title for the infolet and set its views.

    • Specify the dimensions for the front view.

    • Enable or disable the back view.

    • Enable or disable the expanded view, and specify its dimensions. The dimensions of the front and the back views must be the same, but the expanded view must be bigger because it displays more details.

  6. Click Save and Close. You can now add content to infolets.

Add Content to Infolets

You can add content to the infolet's front, back, or expanded view. You can't add a business intelligence dashboard to an infolet because a dashboard report is generally bigger than an infolet.

  1. Select the infolet's view that you want to add content to.

    Note: To open infolet's back view, click the Back View icon on the bottom right corner of the infolet. And to open expanded view, click the Expanded View icon on the bottom right corner of the infolet's back view.
  2. Click Add Content on the infolet. You can find this button on any of the infolet's views, but only if you don't have any existing content in that view.

  3. Search and select a performance tile or a task flow, and click Add. You can browse the business intelligence (BI) catalog to find the analytics and reports that you want to add.

  4. Close the Add Content dialog box. You can now add detailed reports to the infolet.

Link Detailed Reports to Infolets

To provide detailed information about a subject matter on an infolet, you can add a link to a detailed report. After you add the link, your users can click anywhere in the infolet area to drill down to that detailed report. The detailed report doesn't replace the existing infolet content.

First, add a performance tile report to the infolet content, and then follow these steps:

  1. Click the Actions icon on the top right corner of the infolet, and select Link Detailed Report.

  2. On the Detailed Report page, click Add Content.

  3. Search and select a report, and click Add to add it to the infolet.

  4. Close the Add Content dialog box.

  5. Click Done. You can now publish the sandbox.

Publish the Sandbox

  1. Preview the infolet's front view, drill down to the detailed report, and then preview the back and the expanded views.

  2. After you made changes, click Close to leave Page Composer.

  3. Test your changes and publish the sandbox to make the new infolet available to your users.

Edit and Delete Infolets

On the infolet page, use the options available on each infolet to edit infolet content and delete infolets.

  1. Activate a sandbox that has the Page Composer tool in it.

  2. Open an infolet page.

  3. Click your user image or name in the global header, and on the Settings and Actions menu, select Edit Pages.

    Note: After you're done making changes, click Close to leave Page Composer, test your changes, and publish the sandbox.
Edit Infolet Content

  1. Click the Actions icon on the top right corner of the infolet, and select Edit Content.

    Note: To edit the infolet content of the back or expanded view, open the view and use the Actions icon on that view.
  2. Click Add Content to replace the existing content of the infolet.

  3. Search and select a performance tile or a task flow, and click Add. You can browse the business intelligence (BI) catalog to find the analytics and reports that you want to add.

  4. Close the Add Content dialog box.

Edit Title and Views

To edit title and views of an infolet, click the Actions icon on the top right corner of the infolet, and select Edit Title and Views.

Edit or Remove Detailed Report

You can edit or remove the detailed report.

  1. Click the Actions icon on the top right corner of the infolet, and select Edit Detailed Report.

  2. On the Detailed Report page, you can edit or remove the detailed report.

    • To edit, click Edit Report and make changes to the detailed report.

    • To remove, click Remove Report.

  3. Click Done.

Edit Infolet Visibility

You can show or hide an infolet on the infolet page. To edit the visibility settings of an infolet, do these steps:

  1. Click the Actions icon on the top right corner of the infolet, and select Edit Visibility.

  2. Select one of these options:

    • Yes: The infolet appears on the infolet page.

    • No: The infolet doesn't appear on the infolet page.

    • EL Expression: The evaluation of the EL expression decides whether the infolet appears on the infolet page.

Delete Infolets

To delete an infolet, click the Actions icon on the top right corner of the infolet, and select Delete.

Caution: You can't easily retrieve an infolet once you delete it. But if you have accidentally deleted any infolet, don't worry. Contact My Oracle Support at https://support.oracle.com.

FAQs for Infolets

Why don't I see infolets in the Analytics section of the home page?

That's probably because the infolet page is hidden. Change the visibility setting of the infolet page using the Home Configuration page of the Structure work area. To open this page, click Navigator > Configuration > Structure, and then click the Home Configuration tab.

How can I rename an icon for an infolet page in the page control on the home page?

You can rename an icon for an infolet page using the Home Configuration page of the Structure work area. To open this page, select Configuration > Structure from the Navigator menu, and then click the Home Configuration tab.

What's the difference between a performance tile report and a detailed report added to the infolets content?

Performance tile report shows data in the small infolet format. When you add a performance tile report to an infolet, users can see only the summary information about the subject matter. But this report doesn't provide detailed information.

To provide detailed information about the subject matter on the same infolet, add a link to a detailed report. Users can click this link to gather more information.

Analytics on Object Pages

Analytics on Object Pages

Administrators can add analytics to object landing and edit pages. The object landing pages are the pages sales teams interact with every day like the Opportunities, Accounts, or Contacts pages. When you add analytics to the tabs in these pages users can see analytics specific to the record they select.

For the object landing pages there are two steps:

  1. Enable the Analytics tab.

  2. Add an analytic to the enabled tab.

For the edit object pages, there are three steps:

  1. Set the "Is "Prompted" filter on the analytic in BI.

  2. Enable the Analytics tab.

  3. Add the analytic to the enabled tab.

Note: The Service Request and Work Order landing pages don't have the option for adding analytics.

Enable Analytics Tabs for Object Landing Pages

The analytics tabs on your object pages don't show by default. Administrators must enable the tabs before they can add analytics to object pages.

Enable Landing Page Analytics Tabs

This uses the Opportunities object landing page as an example. The steps are the same for all of the object landing pages.

  1. In Navigator click Structure.

  2. Choose Opportunities.

  3. On the analytics row, change the value for visible column to "Yes."

  4. Click Save and Close.

Add an Analysis to the Object Landing Page

After the analytics tab is enabled, administrators add the analytic to the landing page tab. This procedure uses the Opportunity landing page as an example. The procedure is the same for all object edit and landing pages.

Add an Analysis to the Opportunity Landing Page Tab

  1. In a specific opportunity, select the Analytics tab. You enabled this tab in the previous section.

  2. At the top of the Home Page click the arrow next to your name and select Edit Pages.

  3. Select Job Role and choose the role to which your change should apply. Any analytics you add in this context apply only to the role you define here.

  4. In Opportunities on the analytics tab click Add Content and navigate to the analysis you want to show on the Opportunity page.

  5. Click Add next to the analysis and close the dialog. The analysis is now added to the Analytics tab.

Enable Sub Tabs and Add Analytics to Object Edit Pages

There are three steps to adding analytics to object edit pages.

  1. Set the "Is Prompted" filter in the analytic in Business Intelligence. This step is used when the requirement is to view contextual data specific to the record selected.

  2. Enable the sub tab on the object page.

  3. Add the analysis to the sub tab on the object page.

All of these steps are done using the Opportunities landing and edit pages. You can use these same steps for any of the object pages listed as analytics work areas in the sub table at the start of this section.

For service, the Service, Work Order, and Queue pages use the same procedures.

Set the "Is Prompted" Filter

For analytics to show on your user Opportunity pages you enable the "Is Prompted" filter on the name or object ID for the analysis. Adding this filter adds an analytic with data that relates only to the opportunity your user is currently viewing.

  1. Open an existing analysis, or create a new analysis in BI.

  2. In the report Criteria sub tab, select the Filter icon for the appropriate column. Under Operator, select is prompted. Leave the other options blank.

  3. Click OK.

Enable Object Edit Page Analytics Sub Tabs

This procedure uses the Opportunity object landing page as an example. The procedure is the same for all object edit pages.

  1. In Navigator click Application Composer.

  2. Select Sales from the Application drop-down list.

  3. Expand Standard Objects and go to Opportunity.

  4. Under Opportunity click Pages.

  5. Under Detail Page Layouts copy the standard layout or select an existing created layout where the Analytics sub tab is added.

  6. Click the Reorder sub tab.

    This shows the Configure sub tab option for the edit object page.

    Configure sub tab dialog for edit object page.
  7. Click OK.

  8. Click Done. The Analytics sub tab now shows on the Edit Opportunity page.

Add Analytics to Edit Object Sub Tabs

The final step is to add an analysis to the Edit Object sub tab you have just enabled. When an analysis is added to the object page, it shows data specific to the signed in user's transaction record. The specific data shows because of the "is prompted" filter being set in the analytic which passes parameters from the transaction record to the analytic. A parameter is visible in the analytic when a filter prompt is added.

  1. At the top of the Home Page click the arrow next to your name and select Edit Pages. The Edit Pages dialog appears.

  2. Select Job Role and choose the role to which your change should apply. Any analytics you add in this context apply only to the role you define here.

  3. In Opportunities on the analytics sub tab click Add Content and navigate to the analysis you want to show on the Opportunity page.

  4. Click Add next to the analysis and close the dialog. The analysis is now added to the Analytics sub tab.

  5. Next step you want to either save the default parameters, or add parameters specific the object your are working with.

    Click Parameters.

    This shows the Parameters button on the Edit Opportunity analytic.

    Parameter button
  6. The parameter used is pageFlowScope variable and is set by default for Opportunity, Leads, Partners, Service Request and custom object pages. For example, in the case of Opportunity the parameter is #pageFLowScope.biFilterName_OpportunityOpportunityId. In the case of Service Request it is "#{pageFlowScope.biFilterName_ServiceRequestServiceRequestId}" . If for any reason the parameter field is blank, insert the variable manually and save it.

    This shows the parameter value of

    #pageFLowScope.biFilterName_OpportunityOpportunityId on an Edit Opportunity ID analytic column
    ..#pageFLowScope.biFilterName_OpportunityOpportunityId on an Edit Opportunity ID analytic column.

    Parameters
  7. For the objects that aren't pre-populated with the pageFlowScope parameters, you can use one of these sessionScope variables depending on which object page you're on, and the columns available in the analytic.

    • Customer ID: #{sessionScope.zcmAnalyticsCustomerId}

    • Contact ID: #{sessionScope.hzAnalyticsContactPartyId}

    • Contact Name: #{sessionScope.hzAnalyticsContactName}

    • Lead ID: #{sessionScope.mklAnalyticsLeadId}

    • Opportunity ID: #{sessionScope.mooAnalyticsOpportunityId}

    • Partner ID:#{sessionScope.zpmAnalyticsPartnerId}

Expose the Refresh, Export, and Print Links on Tabs

When you're working with analytics on tabs on your interface objects, you have the option of exposing the Print, Export, or Refresh links for the analytics you add to the tabs. This provides your users with handy tools for managing analytics on their object pages.

This shows the Refresh, Print, and Export links on an analytic from a tab on the Analytics page.

Action links on the analytics landing page.

How to Expose the Refresh, Export and Print Links

To expose the links for refresh, export, and print on analytics from object tabs, you modify the component properties in Page Composer.

  1. Highlight the analytics tab and click the Edit Component Properties wrench icon.

    This shows the Page Composer option to modify component properties for a analytics tab.

    Analytics tab properties.
  2. In Component Properties dialog, go to View Report Links.

  3. In the View Report Links field,, the following values can be entered:

    • Add "r" to expose the Refresh link.

    • Add "f" to expose the Print link.

    • Add "d" to expose the Export link.

    • Add more than one of these options separated by a comma: r,f,d.

      This shows the View Report Links option.

      View Report Links.

Paths and Links to Analytics

Your analytics are stored in BI. You are expressing that analytic that's stored in BI in a different location. So when you add an analytic to an infolet, you need to define that path to the analytic. Navigating away from the page takes you out of editing mode, so it makes sense to get the pathway before you add it to the infolet.

Find Analytic Pathways

  1. From the Navigator, click Reports and Analytics.

  2. Click the directory icon on the Reports and Analytics page.

  3. Go to Sales, Embedded Content, and navigate to the analytic.

  4. Highlight the analytic you want, right-click and click More.

  5. Under your analytic name, click More, then Properties.

  6. From the General area, go to Location and copy the path.

    The path is your report location for your sales infolets.

  7. Click OK.

    Repeat the steps 1 through 6 to find your tile analytics.

ADF Contextual Event Action

Administrators can set the ADF Contextual Event action on the object name or other attribute columns of an object to enable drilling down. When this action is set, the drilling down feature works on the analytics you add to the object tabs, Sales Infolet pages, sales pages, or Analytic page. Users click the column name to see the details for that particular record.

These are the available objects:

  • Opportunity

  • Contact

  • Account

  • Activity

  • Partner

  • Deal

  • MDF Budget

  • MDF Request

  • MDF Claim

  • Business Plan

  • Business Plan Objective

  • Leads

  • Queues

  • Work Orders

  • Service Requests

  • Assets

Set the ADF Contextual Event

You can add this event to any analytic you build as long as it has an identifier for the record. In this case the identifier is Customer ID. For this example you build an analytic that shows Account and Opportunity details.

  1. Create a new analysis from the subject area Sales-CRM Pipeline.

  2. From the Subject Area pane, drag the following columns onto the Selected Columns editing palette:

    • From the Customer dimension, select "Name".

    • From the Customer dimension, select "Customer Row ID".

    • From the Opportunity dimension select "Name".

    • From the Opportunity dimension select "Opportunity ID".

    • From the Facts folder, under Pipeline Facts, select "Opportunity Revenue".

  3. Click the settings gear icon for Customer Name.

  4. Choose Column Properties.

  5. Choose the Interaction tab.

  6. Under Value, Primary Interaction, choose Action Links.

  7. Click the + icon to add a new action.

  8. Click the running man action icon with the + on it. A list of actions comes up.

  9. Choose ADF Contextual Event. Click OK.

    This figure shows the ADF Contextual Event option.

    ADF Contextual Event
  10. In the Column Properties dialog, check Do not display in a dialog if only one action link is available at runtime.

    This figure shows the ADF Contextual Event action link dialog.

    ADF Contextual Event.
  11. Click OK.

  12. Repeat steps 3 through 9 for the Opportunity Name column.

Viewing the ADF Contextual Event Action

The analytic to which you added the ADF Contextual Event can be added on the interface. Using the ADF Contextual Event action, users now have the option to view the additional details of a particular object, or make changes to details on an object pages.

To set your analytic an edit object page, do the following:

  1. Enable the analytic tab on the Accounts page and add the newly created analytic.

  2. Click the Customer Name from the BI report and it opens up the detail page for a particular customer as a dialog box. You can close the dialog box and open up any customer name or opportunity name to get a detail page dialog box.

This shows the drill-down detail for the Edit Account object when the ADF Contextual Event action is added.

Edit account with ADF contextual event

USER_PARTY_ID Session Variable

You can configure analyses to show user-specific analytic data on user Analytics pages. This is done by adding session variables to the analytic. Adding a session variable, such as USER_PARTY_ID tells the application to show only the data that's specific to the signed in user. The variables exist for each user for the duration of a browsing session and expire when the user closes the browser or signs out. There are two types of session variable: system and non-system. Session variables are primarily used when authenticating users against external sources such as database tables or LDAP servers. If a user is authenticated successfully, session variables can be used to set filters and permissions for that session.

Add USER_PARTY_ID

To add session variables you select the gear icon on the column name. Then you select New Filter. The USER_PARTY_ID is used on the Employee Login ID column since it tells the application to only show data in this analytic specific to the logged in employee. There are several other session variables and you can choose from the options available when you click in that field.

This shows the New Filter option for adding a session variable that shows an analysis for a signed in user.

Add session variable to analytic.

Deep Linking

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're 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.

Set Up Deep Linking Using Business Intelligence Features

Deep page linking lets your users drill down on a record without leaving the page. You can add deep page linking for records in most custom objects in CX Sales in Business Intelligence. When users click the custom object name, or any record with an associated ID value, it opens up a separate window to provide further detail on that record.

There are three parts to deep page linking:

  1. Defining an action link.

  2. Constructing the deep link URL.

  3. Updating the deep link URL and parameters to navigate to a selected record.

Define an Action Link

You can add a deep page URL to any column of an analysis created for a custom object by adding an action link from column properties. Note that the analysis must have a column that holds the identification of the record, such as Record ID in the case of a custom object.

  1. Create or open an analytic that contains a column for the name of the document. Select the gear icon on the column and then from the drop-down list choose Column Properties.

    As an example of this, say there is a custom object called Product Documents. For deep page linking, we want to add the deep URL/deep link to the column that holds the identification of the record. In the following figure, since there is a Product Document column, it would be the Document name that holds the ID of that record.

  2. In Column Properties, select the Interaction tab.

  3. Under Value, for Primary Interaction choose Action Links from the drop-down list.

  4. Click the + icon to add an action link.

    This shows the New Action, Navigate to a Web Page option.

    New action, Navigate to a Web Page link.
  5. Click Create New Action and then from the drop-down list select Navigate to a Web Page.

    This shows the Create New Action for a deep page link.

    deep page link create new action

Construct the deep Link URL

You add your specific URL to the action field. These steps show you how to determine the correct URL for your environment. These URLs are examples only.

  1. Add the deep link URL to the Create New Action field. There are deep page links patterns available for objects which can be found by going to Related Topics at the bottom of this section and clicking deep Page Links: Explained. In this example, you take the deep URL pattern for the Custom Object, which in this case is called Product Docs. To create a deep link to a default summary page tab for a custom object use the deep link URL pattern in the following example:

    https://<hostname>:<port>/<application>/faces/FuseOverview?fndGlobalItemNodeId=CRM_CUSTOM_CARD_<XXXX>&fndTaskItemNodeId=CRM_CUSTOM_TAB_<XXXX>&fnd=%3BsubTabName%253DSUMMARY%253BObjectId%253D<YYYY>%253B%3B%3B%3Bfalse%3B256%3B%3B%3B

    Replace XXXX with the custom object's API name, for example, ProductDocs_c. Obtain the API name from the object overview page (click the object's node in the Custom Objects tree in Application Composer).

    Replace the YYYY with the custom object's primary key in the database. In this case, the custom object primary key .comes from the Record_Id column, as shown in the following example:

    https://<hostname>:<port>/<application>/faces/FuseOverview?fndGlobalItemNodeId=CRM_CUSTOM_CARD_ProductDocs_c&fndTaskItemNodeId=CRM_CUSTOM_TAB_ ProductDocs_c&fnd=%3BsubTabName%253DSUMMARY%253BObjectId%253D300100057476089%253B%3B%3B%3Bfalse%3B256%3B%3B%3B

    Note that you can test the URL by replacing the host name with your actual host name and using a valid record value in place of <YYYY>. Put the URL in a browser to see if the record details page appears and the URL is valid.

  2. Once you have determined that the URL is valid, the next step is to embed this URL in the analytic and ensure that the object ID, represented in these instructions as <YYYY> is dynamically retrieved from the analytic whenever the Product Docs name is clicked. When you have added the URL click Define Parameters. The next part of these instructions is to construct the deep link URL.

Update the deep Link URL and Parameters

The define parameters fields are populated with some prompts and values already. The purpose of these steps is to ensure that the object ID is defined as a parameter.

This shows some Prompt and Value fields on the Create New Action page.

Add parameters and values for deep linking

To update the deep link URL and parameters:

  1. Because you're changing the value of the ID only, delete the default parameters and leave only one parameter mapped to the ID.

  2. Update the first parameter by renaming the Prompt value to ObjectId and set the value to a column value by selecting the record ID from the drop-down list. For example ProductDocs_c.Id.

  3. Paste the URL again in the URL field and replace the ID of <YYYY> value with @{1} as shown in the following example:

    https://<hostname>:<port>/<application>/faces/FuseOverview?fndGlobalItemNodeId=CRM_CUSTOM_CARD_ProductDocs_c&fndTaskItemNodeId=CRM_CUSTOM_TAB_ ProductDocs_c&fnd=%3BsubTabName%253DSUMMARY%253BObjectId%253D@{1}%253B%3B%3B%3Bfalse%3B256%

    This shows the result of the Edit Action page when the correct values are added.

    Edit action dialog with deep page link
  4. Check Hidden.

  5. Click Ok.

  6. Click OK to edit the Action Link window. The Column Properties window appears.

  7. Click the Data Format tab.

  8. Check the Override Default Data Format and select Number for Treat Number As.

  9. Click OK and save.

  10. Select the Results tab. Now the document name column shows the link. When users click the link, they're taken to that record detail in simplified page.

    This shows an analysis with deep links from the document name column. This analysis with links to drill-down detail can be viewed on the Analytics page or any analytics tab.

    deep links in an analytic

These same steps can be performed for any of the standard objects for sales and service using the deep link format and embedding links in the BI analyses.

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.

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

Embed Analyses and Dashboards

Allow Safe Domains

You allow 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 allow safe domains.

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, 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 list of allowed domains.

  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.