This page covers:
Related pages:
Calculated Indicators in Amp Impact
Calculated Indicators enable organizations to perform mathematical calculations from source Project Indicators. For example, an organization might need to track the percentage of a population that was vaccinated with the formula (Number of people vaccinated/Total population)* 100. In this example, they used the results from two other (source) Project Indicators to perform the calculation.
Amp Impact comes with two options for displaying and managing Calculated Result data: Visualforce and Lightning Web Component. Depending on which option your organization uses, you would need to navigate to different sections to ensure the steps outlined here corresponds with what youâll see in your system. Check with your System Administrator if youâre unsure which option you are using.
Calculated Indicators Terminology
Here are a couple of common terms weâll use when setting up and managing Aggregated Indicators in Amp Impact:
Term | Description |
---|---|
Calculated Project Indicator | A project indicator for which results are calculated by using source project indicator(s) in a mathematical formula. The operations available to create formulas are â+,â â-,â â*,â and â/.â Users may choose these operations from a dropdown picklist or may type them directly into the formula box. In addition to this, users may also type numbers or decimal points into the formula box. |
Dependent Calculated Project Indicator | A calculated project indicator that includes one or more calculated indicators in its formula. |
Source Project Indicator | A project indicator for which results are entered directly by the user on the AddResults page. This type of project indicator is used in the formula/calculation for a calculated project indicator. |
Batch | Users can run batches to process a bulk amount of data. âBatch is used to run large jobs (think |
Create Calculated Project Indicators LIGHTNING WEB COMPONENT
Calculated Indicators are only available as a LWC from Kalausi (v1.34) or later. If your organization is using the Visualforce ManageIndicators page, the interface will be slightly different. The logic for setting up Calculated Indicators is still the same. Reach out to your System Administrator if you have questions about creating Aggregated Indicators.
Calculated Project Indicators can be set up for any numeric Project Indicator. This feature enables organizations to perform the following functions:
Add
Subtract
MultiplyÂ
Divide
Custom formula using any of the operators above and numerical values
In the example below, the Calculated Project Indicator â Cost per solar lamp installation is created using a formula with source Project Indicators -> âCost of solar lamp installations / Number of solar lampsâ.
Since the Calculated Project Indicator requires two or more source Project Indicators to perform the calculation, the first step is to set up these indicators.
Create Source Project Indicators
Here are the steps to create Project Indicators.
When creating source Project Indicators ensure that they:
have the same reporting frequency,
have the same geographic level, and
have the same level of disaggregation as the intended Calculated Indicator.
Create a Calculated Project Indicator
Navigate to the Manage Indicators page and click on the âAdd New Custom Indicatorâ button.
For the âData Typeâ field select from Number, Currency, or Percent. For the âType of Resultsâ field select Calculated. Fill out other required information to create a new Project Indicator.
If the Data Type is Milestone, Qualitative or Picklist, you will receive an error message.
On clicking âSave and Nextâ, the Calculation Formula popup will appear where you can create the formula used to calculate results for this Project Indicator.
Create the Calculation Formula
Once the Calculation Formula popup opens, the user can either create a formula immediately or select âCancelâ. Selecting âCancelâ will save the Project Indicator with no calculation formula, allowing the user to return and set the formula at a later time.
In the Calculation Formula popup, use the âSelect Indicatorâ picklist to select the first source Project Indicator. Only active Project Indicators with the same geographic level, reporting frequency, and disaggregation level are shown in the picklist.
Use the âSelect an Operationâ picklist to select the desired operation.
When creating a calculated Project Indicator that involves division in the formula, ensure that the âNumber of Decimal Points Allowedâ field for that Project Indicator has been set to either 1 or 2.
Continue navigating between the dropdown and select additional Project Indicators or operators as needed. You can also enter numerical values from their keyboards to create more complex formulas as well.
Alphabets and other special characters (#, & etc) typed on the keyboard WILL NOT be displayed on the calculation formula popup.
Only numbers and the 3 mathematical operators (+,-,*) are allowed as input. The â/â operator can only be selected via the picklist since it is a Salesforce keyboard shortcut to search.
An incomplete formula - for example, âNumber of lamps +â will not be saved. If the user tries to save an incomplete formula, an error message will appear in response to the formula that is not mathematically possible. We recommend avoiding illogical formulas to ensure accurate results.
After clicking âSave and Exitâ popup, a banner will display and confirm the successful creation of the calculated indicator. The new Project Indicator will appear in the âSelected Indicatorsâ table on the Manage Indicators page. If a user clicks on the âXâ in the right-hand corner of the popup, or selects âCancelâ, before saving then the popup will close and the indicator will save with no formula entered.Â
The header, body text, operators in the picklist and button labels in the âCustomize Calculationâ popup are controlled by custom labels. Reach out to your System Administrator to know more.
Manage Calculated Indicators LIGHTNING WEB COMPONENT
Edit Existing Calculated Indicators
Click on the âEditâ option in the dropdown located next to the particular Project Indicator in the âSelected Indicatorsâ table.Â
In the popup, edit the field you want to, (for example: Guideline). In order to edit the Calculation Formula, click on âSave and Edit Calculation
This will` open the âCustomize Calculationâ popup where the source indicators or operators can be edited.
Once a Project Indicator is deactivated, it cannot be used in the formula for a calculated Project Indicator. The calculation formula popup will not display the deactivated source Project Indicator when the user clicks into the search bar to create the formula. If the user types a deactivated Project Indicator in the search bar, the message âNo matching records foundâ will display in the dropdown.Â
Additionally, if a calculated Project Indicator uses an source indicator in its formula and the source indicator is later deactivated or deleted, then the user would be notified that the formula contains a deactivated or deleted Project Indicator through a toast message.
Update Calculated Indicator Results
Once the Calculated Indicators are set up, users can choose to run the query and update the indicator results. This can be done in a couple of ways:
For a single Calculated Indicator;
For all Calculated and Aggregated Indicators on the Manage Indicators page;
For all Calculated and Aggregated Indicators on the Add Results page;
For Calculated Indicators dependent on other Calculated Indicator(s).
Before starting, please ensure the following:
The relevant system permissions must be assigned to the user attempting to run the query.
A logical calculation formula has been entered for every Calculated Indicator.
Source Indicators are marked active and Results for source Project Indicators have been entered/calculated. Click here to know how to add results.
Calculate Results for a Single Calculated Indicator
Click on the âUpdate Resultsâ option in the dropdown located next to the particular Project Indicator in the Selected Indicators table. Note that this option will only be shown if the Project Indicator is calculated or aggregated.
A popup will open displaying the date and time of any previously run calculation. It is displayed in the userâs locale. If no calculations have been run previously, then the date and time field will be blank.Â
The header, body text, and button labels in the popup are controlled by custom labels. Reach out to your System Administrator to know more.
Click on âUpdate Resultâ to calculate the result(s) for the Project Indicator.
While the result(s) are being updated, users cannot edit, delete or deactivate the calculated Project Indicator. The following buttons are greyed out on the Manage Indicator page:
The dropdown menu button next to the calculated indicator
âUpdate Resultsâ button
It is also recommended to refrain from using the âUpdate Resultsâ or âSubmit Resultsâ button on the Add Results while the results are being updated.
Once the results are updated:
The buttons will display again
The result(s) will be populated for the corresponding calculated Project Indicator on the Add Results page. Refresh the Add Results page to see the most accurate results. The last calculation date field will also be updated.
Calculate Results for multiple Calculated Indicators Â
Note that this option will calculate results for all calculated and aggregated indicators. If there are no aggregated indicators in the project, then only the results of calculated indicators will be updated.
There are two ways to initiate a batch update for all Aggregated and Calculated Project Indicators: From the Manage Indicators table and from the Add Results page.
Update Results from the Manage Indicators Table
Click on the Update Results button to run a batch update for all Calculated and Aggregated indicators, as shown in the screenshot below.Â
This button will not display if there are no aggregated or calculated indicators in the Selected Indicators table.
A popup will display to confirm the batch. Click âConfirmâ to run the batch.
The header, body text, and button labels in the popup are controlled by custom labels. Reach out to your System Administrator to know more.
On confirmation, the batch runs for all aggregated and calculated indicators in the project.
While the batch is processing, users cannot edit or delete the calculated and aggregated Project Indicators. The following buttons are greyed out:
The dropdown menu buttons next to all Calculated and Aggregated Indicator(s)
âUpdate Resultsâ button on the Manage Indicator page.
The user is notified via email when the batch is complete and results are updated.
When batch is complete, the:
The buttons will display again and
The results for the corresponding calculated and aggregated Project Indicator(s) will be populated on the Add Results page. Refresh the Add Results page to see the most accurate results. The last calculation date field will also be updated.
Time to wait: We recommend that users donât update results or submit results via the AddResults page while the batch is running. Users can navigate away from the ManageIndicators page until the batch is completed.
Calculating Results for Calculated Indicators Dependent on other Calculated Indicator(s)
Calculated indicators that are run en masse do not update in any particular order. If a calculated indicator includes one or more calculated indicators in its formula, users will need to perform one of the two actions below:
Option One: Run the batch en masse twice by clicking Refresh Indicators twice. After the second run of the batch, results will be displayed for all calculated indicators.Â
Option Two: Run the batch individually for each calculated indicator based on the hierarchy established by the formula.Â
For example: if calculating â% of households with access to clean waterâ and the formula includes a calculated indicator â# of householdsâ which adds rural and urban households, then be sure to first run the calculation for â# of householdsâ, and then after the first batch, refresh the Add Results page and run the calculation for â% of households with access to clean water indicatorâ.
Update Results from the Add Results Page
Navigate to the Add Results page and click on the drop-down on the right.
In the dropdown, select the option to âUpdate Resultsâ.
A confirmation popup will be displayed to confirm that the Calculated and Aggregated Project Indicator results will be updated for the current Geographic Area and Reporting Period.
The header, body text, and button labels in the popup are controlled by custom labels. Reach out to your System Administrator to know more.
While the batch is processing, users will not be able to submit or update the results for these indicators. The âSubmit Resultsâ and âUpdate Resultsâ buttons will be greyed out.
A clock icon will be displayed next to the Calculated and Aggregated Indicators to display that they are being updated.
We recommend users to refrain from editing indicators and updating their results via the MaangeIndicator page while the the batch is running.
The user is notified via email when the batch is complete and results are updated.
A success message is displayed once the batch is updated. The buttons will display again and users can refresh the Add Results page to see the most accurate results. The last calculation date field will also be updated.
Time to wait: We recommend that users donât edit or update results for Calculated and Aggregated Indicators indicators via ManageIndicators while the results are being updated. Users can navigate away from the AddResults screen until the batch is completed.
Create & Manage Calculated Indicators VISUALFORCE PAGE
The logic for creating Calculated Indicators from the Visualforce page is similar to the LWC described above. The only difference is the user interface for some of the steps:
The âAdd New Custom Indicatorâ and Formula popups have a slightly different interface.
To edit a Calculated Indicator from the Visualforce page, users can click on the âwrench iconâ next to the corresponding indicator.
To update results for a single Calculated Indicator from the Visualforce page, users can click on the ârefresh iconâ next to the corresponding indicator.
Users can also update results for all Calculated and Aggregated Indicators using the âRefresh Indicatorsâ button from the Manage Indicators page.
On the pop-up select âCalculatedâ to update results for only Calculated Indicators