How do I embed a BIP report in the Analytics subtab in a Sales record?

Here's how you can embed a Business Intelligence Publisher (BIP) report in the Analytics tab on the edit pages of any of the sales object records, including accounts, opportunities, and leads. You can use the same procedure on service request and partner pages as well. The report shows information for each individual record. This procedure applies only to pages in the classic user experience. It isn't applicable to Sales in the Redwood user experience.

Here's an overview of the setup:

  1. In Business Intelligence, set the "Is Prompted" filter. This setting displays data specific to the record.

  2. Enable the subtab on the object page.

  3. Add the report to the subtab on the object page.

The following steps use the Opportunities landing and edit pages as an example. You can use these same steps for other sales and service objects, including service request, work order, and queue.

Set the "Is Prompted" Filter

To show data specific to the record, you enable the "Is Prompted" filter on the name or object ID for the report.

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

  2. In the report Criteria subtab, 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 Subtabs

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 subtab is added.

  6. Click the Reorder subtab.

    This shows the Configure subtab option for the edit object page.
    Configure subtab dialog for edit object page.
  7. Click OK.

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

Add Analytics to Edit Object Subtabs

The final step is to add an analysis to the Edit Object subtab you've 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 subtab 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 subtab.

  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's "#{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 prepopulated 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}