Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Docs per SFDO-Community/declarative-lookup-rollup-summaries #1300 #71

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/Architecture/calculates.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,9 @@ In this mode, DLRS would not run instantly. When the Rollup Definition is deploy
* For example, if you set up a DLRS to count the number of open cases per account and you know that most clients would report a case infrequently and that the account executive reports on the number of open cases for their accounts once a month, you would set up the schedule to run every two weeks or before a certain date in the month.
* If you want to review the records awaiting processing, it’s easy to create a report based on the Lookup Rollup Summary Schedule Items object.

### Merged Records and Scheduled Items
Merged records may create scheduled items because it was a problem to recalculate the rollup in real-time for that scenario. When records are merged, the system may not be able to immediately recalculate the rollup due to the complexity and potential conflicts that can arise during the merge process. Therefore, the system creates scheduled items to handle the recalculation at a later time, ensuring that the rollup is accurately updated without causing performance issues or errors during the merge.

## Realtime
In Realtime mode, DLRS installs an Apex trigger on the child object. This means the rollup runs immediately when a child record is created or updated, and the target fields are edited. It only triggers if the Field to Aggregate or Criteria fields of the Rollup job are changed.

Expand Down
1 change: 1 addition & 0 deletions docs/Installation/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ has_children: false
- **Check Existing Apex Tests.** This tool dynamically deploys Apex Triggers and Apex tests, please make sure your Sandbox and Production org tests are all fully working before you attempt to use this tool. Otherwise usage of this tool will be blocked until you resolve such errors. If you have an org with triggers on the sObject that will contain the roll up result, installation into sandbox is VERY HIGHLY recommended so that after Lookup Rollup Summary records are added/enabled, you should rerun all testmethods to ensure nothing has broken as your before/after update triggers on the parent sObject will re-execute.
- **Existing Tests on Parent Objects**. This tool will update the indicated fields on your Parent objects when it senses activity on Child objects. Ensure any Apex Triggers you have written on your Parent objects are written with best practices around bulkification in mind. If in doubt be sure to perform significant testing.
- **Realtime vs. Scheduled**. This tool can become resource intensive when combined with other declarative and development based automations. It provides several realtime and scheduled options including Scheduled Apex and Flow Scheduled Actions. If you are running into platform limitations consider using one of the scheduled options available. [See How and When DLRS Calculates](https://sfdo-community-sprints.github.io/DLRS-Documentation/Architecture/calculates.html) for additional information.
- **Merged Records and Scheduled Items**. Merged records may create scheduled items because it was a problem to recalculate the rollup in real-time for that scenario. When records are merged, the system may not be able to immediately recalculate the rollup due to the complexity and potential conflicts that can arise during the merge process. Therefore, the system creates scheduled items to handle the recalculation at a later time, ensuring that the rollup is accurately updated without causing performance issues or errors during the merge.

## Usage Information and Known Issues

Expand Down
4 changes: 3 additions & 1 deletion docs/User Guide/scheduling_rollups_v2_21.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,9 @@ The **Watch for Changes and Process Later** Calculation Mode Roll-ups will not r

The **Realtime** Calculation Mode requires the deployment of a child trigger to run your rollup whenever a child record is saved.

### Merged Records and Scheduled Items
Merged records may create scheduled items because it was a problem to recalculate the rollup in real-time for that scenario. When records are merged, the system may not be able to immediately recalculate the rollup due to the complexity and potential conflicts that can arise during the merge process. Therefore, the system creates scheduled items to handle the recalculation at a later time, ensuring that the rollup is accurately updated without causing performance issues or errors during the merge.

## Developer / Invocable by Automation Calculation Modes
Simply choose "Save and Activate" in the path. Your rule is now ready to be called by a flow or Apex code, or to be scheduled using the instructions above.

Expand Down Expand Up @@ -84,4 +87,3 @@ This will take you to the Manage Apex Trigger page. Scroll to the bottom of the
Once you have deployed the trigger, please choose "Activate" on the path at the top of the window. This will activate the rollup rule. Rollups will be updated in realtime as records are created or updated.

<img src="../assets/images/v2_21/dlrs_beta_v2_21_path_realtime_02_save_activate.png" width="100%" alt="DLRS Beta Rule Activation - Path - Realtime Calculation Mode">