...
Calculated Indicators enable organizations to perform mathematical calculations from two or more 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.
...
Here are a couple of common terms we’ll use when setting up and managing Aggregated Calculated 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
| Status | ||||
|---|---|---|---|---|
|
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
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. |
| Info |
|---|
System Admin Note: If you want to use Calculated Indicators functionality in Lightning Web Component make sure ‘Lightning Web Security for Lightning web components and Aura Components’ is enabled in ‘Session settings’. |
Calculated Project Indicators can be set up for any numeric Project Indicator. This feature enables organizations to perform the following functions:
...
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 Fill out the fields in the popup and select “Calculated” for the “Type of Results” field select Calculated. Fill out other required information to create a new Project Indicator.
...
.
Remember that the “Data Type” can only be Number, Percent or Currency when setting up Calculated Indicators.
On clicking “Save and Next”, the Calculation Formula popup will appear where user you can create the formula used to calculate results for this Project Indicator.
...
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 “Select an OperationOperation”picklist to select the desired operation.
...
Continue navigating between the dropdown and select additional Project Indicators or operators as needed. Users You can also enter numerical values from their keyboards to create more complex formulas as well.
| Note |
|---|
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. |
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.
| Info |
|---|
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
| Status | ||||
|---|---|---|---|---|
|
...
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
...
We do not recommend editing the following fields once Results have been created for a particular indicator since it might lead to data inconsistencies.
...
Disaggregation by group
...
This will` open the “Customize Calculation” popup where the source indicators or operators can be edited.
<Confirm with PG Should we put a note about not editing calculation formula after result records have been generated to avoid data inconsistencies?>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.
| Info |
|---|
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
...
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. <add link for 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 Indicatorstable. 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.
| Info |
|---|
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
| Info |
|---|
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. |
...
Click on the Update Resultsbutton to run a batch update for all calculated Calculated and Aggregated indicators, as shown in the screenshot below.
| Info |
|---|
Note, this This button will not display if there are no aggregated or calculated indicators in the Selected Indicators table. |
A pop-up popup will display to confirm the batch. Click “Confirm” to run the batch.
| Info |
|---|
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.
| Info |
|---|
Time to wait: We recommend that users don’t Update Results or Submit Results 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. |
| Note |
|---|
Ensure that the source project indicators are active before updating results. If source project indicator(s) are deactivated or deleted, new Result records will not be created or updated. |
Calculating Results for Calculated Indicators Dependent on other Calculated Indicator(s)
...
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.
| Info |
|---|
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.
...
| Info |
|---|
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.
...
| Info |
|---|
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
| Status | ||||
|---|---|---|---|---|
|
The logic for creating Aggregated 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 “Aggregation Criteria” Formula popups have a slightly different interface.
To update Aggregated Indicator results 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” or wrench icon “refresh icon” next to the corresponding aggregated 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
...