ArticlesR&A: How to Embed xRB Reports on an Account Page Layout or Dashboard

To watch a video walkthrough of this installation, see xRB Account Dashboard Intro.

Appendix

List of Report Components

• See document xRBCREportComponentExport for full detail of queries:

Query to extract components 

• SELECT Name,fferpcore__Json__c,Id,RecordTypeId FROM fferpcore__frb_Reporting_Component_Configuration__c WHERE Name LIKE 'xRB%'

Notes on Process to Convert an xRB Report to Components:

The workflow for using xRB lightning components is a bit awkward:

• create the report & filters 

  • Use a naming convention such as "Workspace Cash Matching"

  • Populate Group field with something to filter on

• Make sure lenses are well named (e.g. xRB_Company_Name_FM as there are two company filters FT and FM)

  • Make sure the API names are kosher (use cntl-e or command-e to show json in lens)

  • Best practice is to name both the label and the API name the same  (for these lenses I named the lens the same as the API name - no spaces)

  • 

• Export it in under Share xRB Report Definitions

  • Sharing a set of reports at the same time facilitates deployment

• Rename the original report (to avoid duplicates)

• Import the report making sure to  check the box for “Import Individual Components”

• The names returned are verbose: e.g. “ExportWorkspace Aging as of Now Outstanding Dual Value - Table Configuration 1”. To make them easier to use:

  • Edit the components you want and CLONE them

  • Rename it to something standard like "xRBCashMatching"

    • No spaces in the name

  • This is the value that will used in the Lightning Component

  • 

FYI You may find renaming lenses on existing reports to be tedious:

• Find the lenses in the xRB report (lens configuration, drill configuration or filter configuration)

• Invoke Analytics Studio to edit

• Then “Clone to New Tab” (we don’t want to rename the original as it may be used elsewhere),  

• Then use Command-e (Cntl-e) to see the code, 

• Edit the label and API name

• Return to the xRB report and replace the lens used.

This process is more than tedious: it is surprisingly difficult to find all of the lenses (I got tripped up on drill lenses). An alternative for this renaming is to directly with the exported JSON file (using Sublime editor).  It is faster than trying to plow through all of the lenses AND correct all of the references to those lenses in the reports.  But the JSON file is pretty ugly, and it takes a while to grasp its structure.

• Global Search & Replace has its own challenges

  • Be careful replace strings that are sub-strings of other items

  • Be careful with up/low case selection in Sublime (one toggle will match up/low to the string of the source rather that the target value

Notes on Removal of VF Pages from Account Page Layout

Once the xRB Account reports are on their tabs, several legacy VF pages can be removed from the main Account Detail Page layout.

• The following screenshot step through a sample removal

• Before removal:

• Before removal - scrolling down on page shows 3 VF pages

  

To Edit specific page layout, Go to Edit Page (under Setup menu pick) and click on the Detail page panel in the editor.  This will display the “previewed” Salesforce page layout - click on it to edit and it will open in a new tab.

Then scroll down on page to find sections: 

xRB Account Dashboard Filter Configuration

xRB Account Dashboard Report Configuration

Package.xml for Lightning Page, Lenses and Analytics (Wave) App

Link to package xml zip file: xRB Dashboard Lenses and App.zip

Package xml for lightning page and lenses

<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">;
    <types>
        <members>xRB_Component_Lenses</members>
        <name>WaveApplication</name>
     </types>
     <types>
        <members>xRB_Account_Name_FT</members>
        <members>xRB_Account_Name_Matching_FM</members>
        <members>xRB_Aging_as_of_Now_Outstanding_Dual</members>
        <members>xRB_Cash_Matching_1_0</members>
        <members>xRB_Company_Name_FT</members>
        <members>xRB_Company_Name_FM</members>
        <members>xRB_DrillLens_dual_FT</members>
        <members>xRB_Dual_TB_2_Revenue</members>
        <members>xRB_Dual_SIN_only</members>
        <members>xRB_FT_Dual_Not_Match_V1</members>
        <members>xRB_GLA_Name_FT</members>
        <members>xRB_Matched_Days_to_Pay_FM</members>
        <members>xRB_Matching_Date</members>
        <members>xRB_Matching_Ref_Name_Matching_FM</members>
        <members>xRB_TRANSACTION_DATE</members>
       <members>xRB_Workspace_Account_Profile</members>
        <name>WaveLens</name>
    </types>
    <types>
       <members>xRB_Account_Dashboard_V2</members> 
       <name>FlexiPage</name>
    </types>
    <version>64.0</version>
</Package>

xRB_Account_Dashboard Component for flexipage (this is just the lightning page piece)

<?xml version="1.0" encoding="UTF-8"?>
<FlexiPage xmlns="http://soap.sforce.com/2006/04/metadata">;
    <flexiPageRegions>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>defaultProfile</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBAccountProfile</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>recordPageFilterConfiguration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Account Profile</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens6</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBAccountBalance</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>recordPageFilterConfiguration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Account Balance</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>defaultProfile</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBAccountRevenue</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>recordPageFilterConfiguration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Revenue</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens5</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBAsOfAging</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Aging</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens4</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>defaultProfile</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBCashMatching</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>recordPageFilterConfiguration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Cash Matching</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens2</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>defaultProfile</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBDaystoPay</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>recordPageFilterConfiguration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Days to Pay</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_multiLens</componentName>
                <identifier>fferpcore_frb_multiLens3</identifier>
            </componentInstance>
        </itemInstances>
        <name>main</name>
        <type>Region</type>
    </flexiPageRegions>
    <flexiPageRegions>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>configuration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBFilterAccountName</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Account Name</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_queryFilter</componentName>
                <identifier>fferpcore_frb_queryFilter</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBFilterCompanyName</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Company Name</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_queryFilter</componentName>
                <identifier>fferpcore_frb_queryFilter2</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentInstanceProperties>
                    <name>configuration</name>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>profile</name>
                    <value>xRBFilterTransactionDate</value>
                </componentInstanceProperties>
                <componentInstanceProperties>
                    <name>title</name>
                    <value>Transaction Date</value>
                </componentInstanceProperties>
                <componentName>fferpcore:frb_queryFilter</componentName>
                <identifier>fferpcore_frb_queryFilter3</identifier>
            </componentInstance>
        </itemInstances>
        <itemInstances>
            <componentInstance>
                <componentName>fferpcore:frb_waveConnector</componentName>
                <identifier>fferpcore_frb_waveConnector</identifier>
            </componentInstance>
        </itemInstances>
        <name>side</name>
        <type>Region</type>
    </flexiPageRegions>
    <masterLabel>xRB Account Dashboard V2</masterLabel>
    <template>
        <name>fferpcore:exp_flexiTmplCollapseRight</name>
    </template>
    <type>AppPage</type>
</FlexiPage>

Alternative to Package.xml: Use of Change Sets

It is possible to deploy metadata between sandbox and production environments using the Salesforce Change Set utility.  The image below shows the elements of the package.xml in a Change Set:

How to Create a Workspace

Create Permission set for Component Record Types & Assign to Admin

1. Create Permission Set “xRB Component Record Types” with access to all record types and fields
    
   
   

2. Assign it to the System Administrator creating the dashboard

Import Source Reports

The Account dashboard does not directly reference xRB reports but rather the xRB Components created from these reports. These components are not user friendly (they contain JSON code) and so a series of reports is imported to xRB to illustrate the construction of the components. These components will be created in the next step, but first import the reports: 

1. Download the JSON that will be used to import the reports here: xRB Account Dashboard Reports for Deployment
2. Navigate to the Report Builder app
3. Open the Share xRB Report Definitions tab
   1. If the tab is missing, the permission set “xRB - Share Reports” needs to be assigned
4. Open the Import sub-tab
5. Open files and upload the JSON file
6. Select all six reports and click on Import (bottom of page) to get all 6 reports
   • Workspace Account Revenue
   • Workspace Account Balance
   • Workspace Aging as of Now Outstanding Dual Value
   • Workspace Account Profile
   • Workspace Document Days to Pay
   • Workspace Cash Matching Detail  
7. Create a view to xRB reports sorting on the Group value of “Deployment”

Use Datastream to Load xRB Report Component Configurations

The report lighting components have been built using these sample reports.

1. Using the worksheet Datastream xRB Report Component, load components to be used in xRB Account Dashboard
    
2. On the Foundation’s Datastream page, ensure the Record Type column is populated
   1. If it is not populated, the permission set “xRB - Share Reports” needs to be assigned
   2. Assign it to the user
   3. Delete the imported records
   4. Reattempt

Deploy Lightning Page and Lenses for xRB Account Dashboard Using Package.xml

Package.xml is a technology used to deploy Salesforce metadata from one org to another. It is an alternative to the mechanism available within Setup for Change Sets. The xRB Account Dashboard will be deployed using the tool called Salesforce Workbench. While typically deployments are done across orgs related to each other (production/ sandboxes), they can also be done independently and so this package.xml can be deployed in any org. 

Some organizations have strict controls on who can deploy metadata across orgs. As assurance, in this instance the package.xml is only extracting data about a lightning page layout and does not hold any proprietary information. No other components are included. For such organizations, this package.xml can be deployed to a sandbox environment and the organization’s usual change management procedures can be followed in deploying to the production environment. This article essentially sets up the dependencies needed for the dashboard to work.

How to Deploy the Package:

A package.xml file was created to capture the Lighting Page for the dashboard and related lenses. This package.xml file is in shown in the appendix. We will not be using this package.xml file directly, but rather zip file that contains the metadata associated with this xml file. Workbench is used to retrieve and deploy the zip file containing the metadata requested in the package.xml file:

1. Start up the workbench: the URL is https://workbench.developerforce.com/login.php
   • An example of the metadata is shown just below the package.xml file
2. Download this zip file here: xRBAccountDashboardPackageV3retrieve.zip
3. When prompted, enter the type of org (production/ sandbox) and login credentials
4. Navigate to the menu bar and click migration > Deploy
    
   
   
5. The deployment screen provides a prompt to choose the file; select Single Package > Next
6. In the Choose File dialogue, upload the file downloaded above
7. The next screen confirms the file and prompts to deploy
    
   
   
8. The following screen provides a status during deployment (it will confirm creating the page and adding 16 lenses)
    
   
   
   1. If there is an error on xRB_Workspace_Account_Profile.wlens then ignore it
9. Activate the lighting page by navigating to Setup/ Lightning App Builder > find the page xRB Account Dashboard V2
    
   
   
10. Edit the dashboard and activate it for all users
11. Add it to an app so it shows up in navigation
    

Steps to Test

1. Navigate to Analytics Studio
2. Open the xRB Component Lenses app
   1. There should be 15 lenses
   2. This app is set for all users to have “Manager” access (this is to make deployment easier)
   3. Users can add an admin as a manager (and may power accounting users) and then change the all user access to “Read Only”
3. Navigate to the app in which the dashboard is installed
4. Open the xRB Account dashboard
   1. Filter on an account
      1. Users may need to go to Analytics Studio to edit the lens “xRB_Dual_TB_2_Revenue” to set the filter to capture revenue line items
      2. The default value is “Sales Revenue”
         
         
         

Special Feature: Add Export Capability to Dashboard

1. On the xRB Dashboard from the same menu as Setup, select Edit Page
2. On the page in the left menu, search for the widget named Report Builder Actions
3. Drag this component to the top of the filters panel above Account Name

The Report Builder Actions is now available with an Export button

 

Workflow for Displaying Reports on the Account Record Page Layout

Account Page Layout

Now that the report's lightning components are in place, it is possible to place these components onto record page layouts such as an account page. 

1. Use a parameter on the Analytics Report Table widget (that is dragged on the screen for Record Page Filter)
2. The value in this field for the Account page is: { "datasetField": "AccountName", "filterBy": "Name" }
    

Screenshot Examples

 

How to Edit the Page Layout

If an end user does not have a license to see accounting data, they will be unable to see the data on the account page. It is best practice to limit the users seeing these tabs to accounting users. Lightning pages can be activated at the app level (e.g. a custom app called Acme Accounting), and so only those using the app will see the report data.  

Note that this process assumes that the standard app "Accounting" has been cloned by the customer (or its implementation consultant) to “FM General Ledger”. Making changes to the managed app is restricted. The steps below are using the example app "FM General Ledger".

Find Account Tab Edit Layout

1. Navigate to Apps > Accounts tab
2. Search for a good sample account
    
   
   
3. Click Edit Page
    
   
   
4. Add a tab to the Account tabs, for instance between the Contacts and Opportunities in the above example
5. Then add another layer of tabs underneath it
   
   
   
6. For tab label, choose Custom (topmost)
7. Enter a label value such as “Account Balance”
8. For the nested tabs, in the left menu, find the Tabs widget and drag it into the new tab
9. Add/rename three tabs on the right Tabs Account Balance attribute column for “Account Balances”, “Days to Pay”, and “Cash Matching"
   
   
   
10. Search for components starting with “Analytics”
11. Drag the Analytics Data Connector widget onto the page
    1. This connector is blank and only has to be added once to a page
       
       
       
12. Drag three of the Analytics Report Table widget into the Account Balance tab
13. For each of them, enter the profile name of the report component: “xRBAccountBalance”, “xRBAccountRevenue”, and “xRBAsOfAging”
14. It is critical to also include the Record Page Filter: { "datasetField": "AccountName", "filterBy": "Name" }
    
     
15. Add the Analytics Report table “xRBDaystoPay” to the Days to Pay tab
16. Add the Analytics Report table “xRBAsOfAging” to the Aging tab

Enable Export

1. Drag the Report Builder Actions component to the bottom of the tab (below the tabs component) 
   

Activate

After saving the page, it must also be activated for the app (or set of apps) users intend to use. Users without access to accounting will see errors if they can see these tabs.

1. Navigate to the App Default tab within Activation
    
   
   
2. Select the app(s) to expose it to

This article provides a detailed guide on embedding xRB reports on an account page layout or dashboard. This article also includes instructions embedding the components used to build the dashboard onto an Account record page. The xRB Account Dashboard combines 6 xRB account level reports onto a single page. It is designed to replace several visualforce page components on the account page layout. A print to PDF export looks like this: Sample xRB Dashboard.