Example: Roll Up Financial Accounts of a Household
Create a record rollup definition that rolls up the financial accounts of all the members of a household.
Required Editions
| Available in: Lightning Experience |
| Available in: Professional, Enterprise, and Unlimited Editions where Financial Services Cloud is enabled |
| User Permissions Needed | |
|---|---|
| To create and activate a record rollup definition: | Record Aggregation Access AND Modify All Data AND Customize Application |
| To sync record rollup definitions: | Record Aggregation Access permission AND Modify All Data permission AND Customize Application permission AND Data Pipelines Base User permission set |
| To create a schedule-triggered flow and run a record rollup definition: | Record Aggregation Access permission AND Modify All Data permission AND Customize Application permission AND Data Pipelines Base User permission set |
| To customize a Lightning record page: | Record Aggregation Access permission AND Modify All Data permission AND Customize Application permission AND OmniStudio Admin permission set |
| To view the rolled up records: | Record Aggregation Access permission AND OmniStudio User permission set |
Get Started with Rolling Up Financial Accounts of Adams’ Household
Assign users the necessary permission sets and object permissions. Create a record rollup definition and activate it. Sync record rollup definition details with Data Processing Engine. Create a schedule-triggered flow for the record rollup definition and run the flow. The flow executes the Data Processing Engine definition associated with the record rollup definition.
- Assign permission sets for record rollup definitions.
- Enable Data Pipelines.
- Create a record rollup definition and sync the definition details.
- Sync record rollup definition details.
- Periodically run record rollup definitions by using schedule-triggered flows.
- Customize Lightning Pages to view record rollup results.
- View record rollup results.
Assign Permission Sets for Record Rollup Definitions
Assign permission sets to set up and manage record rollup definitions.
- From Setup, in the Quick Find box, enter Users, and then select Users.
- Click a user’s name.
- Under Permission Set Assignments, click Edit Assignments.
-
Based on the user persona, add these permission sets:
USER PERSONA PERMISSION SET Admin Financial Services Cloud Extension OR FSC Sales
AND
OmniStudio Admin
AND
Data Pipelines Base User
Financial Advisors or Relationship Managers Financial Services Cloud Extension OR FSC Sales
AND
OmniStudio User
- Save your changes.
Enable Data Pipelines
To create and manage record rollup definitions, enable Data Pipelines in Setup.
- From Setup, in the Quick Find box, enter Data Pipelines, and then select Get Started. To find Data Pipelines in Setup, the Data Pipelines Base User permission set must be assigned to you.
- Enable Data Pipelines.
Create a Record Rollup Definition and Sync the Definition Details
Create a record rollup definition to roll up the financial accounts of all the members of a household. Activate the definition, and sync the definition details to generate a Data Processing Engine definition.
- From Setup, in the Quick Find box, enter Rollup Definitions, and then select Record Rollup Definitions.
- To create a record rollup definition, click New Rollup Definition.
-
Enter these details, and click Next.
- Name: Financial Information for a Household
- Description: Roll up the financial accounts of all the members of a household.
- Rollup Source Object: Financial Account
- Rollup Target Object: Party Relationship Group
-
To add the Account Contact Relation object and relevant join fields, click
.
Note The Party Relationship Group object isn’t directly linked to the Financial Account object. To establish a link between the Party Relationship Group and the Financial Account, add the Account Contact Relation object. - For each object, specify the join fields to join records with the previous and next objects as listed in this table, save the changes and activate the definition.
| Object | Next Object | Join Field with Next Object | Previous Object | Join Field with Previous Object |
|---|---|---|---|---|
| Party Relationship Group (Rollup Target Object) | Account Contact Relation | AccountId | NA | NA |
| Account Contact Relation | Contact | ContactId | Party Relationship Group | AccountId |
| Contact | Financial Account Party | AccountId | Account Contact Relation | ContactId |
| Financial Account Party | Financial Account | FinancialAccountId | Contact | AccountId |
| Financial Account (Rollup Source Object | NA | NA | Financial Account Party | Id |
Sync Record Rollup Definition Details
Sync the record rollup definition details to generate a Data Processing Engine definition.
- From Setup, in the Quick Find box, enter Rollup Definitions, and then select Record Rollup Definitions.
-
Click Sync Rollup Definitions.
Note When you sync the details for the first time, a new Data Processing Engine definition is created. Any subsequent sync operation updates the same Data Processing Engine definition.
Periodically Run Record Rollup Definitions by Using Schedule-Triggered Flows
After you activate and sync record rollup definitions, you must run the Data Processing Engine associated with active record rollup definitions to get the aggregated records. To account for any recent updates, create schedule-triggered flows and periodically run the active record rollup definitions.
- From Setup, in the Quick Find box, enter Flows, and then select Flows.
- Click New Flow.
- Select Start From Scratch, and click Next.
- Select Schedule-Triggered Flow.
- Set a schedule so that the Data Processing Engine associated with active record rollup definitions runs according to the specified schedule.
- Drag and drop an action element and connect it to the flow.
- In the Filter By section, select Type.
- Select Core Action.
- Search for and select the Run Record Aggregation Batch Processing Definition action.
- Specify a label and API Name.
-
Specify the rollup definition ID that you created earlier as the execution reference ID.
To get the rollup definition ID:
- From Setup, in the Quick Find box, enter Rollup Definitions, and then select Record Rollup Definitions.
- Click the record rollup definition that you created earlier.
- Copy the rollupDefinitionId from the URL and enter it as the execution reference ID.
- Click Done.
Customize Lightning Pages to View Record Rollup Results
To show record rollup results in a clear and organized format, add the ShowRecordRollupResults component to the rollup target object’s record details page.
- From the App Launcher, select Party Relationship Groups or Accounts.
- Click the household record that you associated the aggregated financial account records with.
- Click Edit Page.
- In the Related tab section, drag the Flexcard component from the Components panel to the Lightning page canvas location where you want to position the component on the record page.
-
In the Properties pane, select these values:
- Flexcard Name: ShowRecordRollupResults
- Record Aggregation Definition Name: Select the record rollup definition that you created earlier.
- Save your changes.
- If your page is new, activate the page.
View Record Rollup Results
View record rollup results in a clear and organized format on the household record details page.
- From the App Launcher, select Party Relationship Groups or Accounts.
- Click the relevant household record.
- To view the record rollup results in a clear and organized format, click the relevant tab.

