Add Results: Customization Options
This page covers:
- 1 Add Results Components
- 2 Add Results: Lightning Web Component Lightning Web Component
- 3 Add Results Data Entry Guidelines Lightning Web Component
- 4 Result Record creation when Project Indicators are disaggregated by multiple custom groups Phoenix Release v1.45
- 5 Entering Result Values for a Project Indicator Lightning Web Component
- 6 Customize Submit Results for Review Process Lightning Web Component
- 7 Considerations for the Refresh Functionality Lightning Web Component
- 8 Add Results: Visualforce Page Visualforce Page
- 9 Enable Submit button on Add Results page of Reporting Period Visualforce Page
- 10 Add Results Components: Customize Field Sets Lightning Web Component Visualforce Page
- 11 Add Results: Custom Permissions Nashira v1.38 onwards
Add Results Components
The Add Results feature comes with two customization options that organizations can choose from: Lightning Web Component or Visualforce Page.
Visualforce: is a page-centric web application model. A markup language like HTML is used for designing the layout of pages.
Lightning Web Component (LWC): a new app-centric model that provides business and datalogics to develop dynamic web applications meant for desktop and mobile devices. Because they’re built on code that runs natively in browsers, LWC are lightweight and deliver exceptional performance.
Organizations on earlier releases of Amp Impact might be using Visualforce pages to create and manage indicators. With Amp Impact’s Indus (Winter 2022) release, the Add Results page was rebuilt as a Lightning Web Component (called addResults).
Refer to the https://verasolutions.atlassian.net/wiki/spaces/AIEP/pages/3732406327 page to learn more about the Add Results Components.
Add Results: Lightning Web Component Lightning Web Component
Design attributes control the display of various buttons/components on the Add Results page.
Navigate to Add Results and click on the gear icon → Edit Page
2. This will take you to the Lightning App Builder. Clicking on the Add Results component will show the list of design attributes on the right side of the page.
The following design attributes are available. Check/Uncheck them based on the table below:
Design Attribute | Related UI Element | UI if True | UI if False |
|---|---|---|---|
Hide Submit? | Controls the display of | Submit button is not displayed on the Add | Submit button is displayed on the Add |
Hide Comments? | Controls if comments | Comments related | Comments related to |
View Only Mode? | Controls whether the | Results cannot be | Results can be edited. |
Hide Refresh? | Controls the display of | Refresh button is | Refresh button is not |
Hide Targets | Controls the display of | Targets for the Project | Targets for the Project |
Hide Baseline | Controls the display of | Baseline for the Project | Baseline for the Project |
Hide Validation | Controls the behavior of | Add Results page | Add Results page flags a user if the value entered in the input field is outside of the validation range. |
Hide Hyperlink in First | Controls if Project | Project indicators | Project indicators are |
Round Off digits for | Defines the round-off | NA | NA |
Don’t allow | Controls if the Project | Project Indicator results | Project Indicator results |
Hide Stoplights? | Controls the display of | Stoplights do not appear next to Project Indicators on the Add Results table. | Red/Yellow/green |
Hide Results Download Button | Controls if the Excel | Results cannot be | Results can be |
Hide Upload Button | Controls if the Excel | Results cannot be uploaded via an Excel sheet. | Results can be uploaded via an Excel sheet. The upload icon will be visible. |
Hide Document Upload | Controls the display of the Attach icon. | Attach icon does not | Attach icon displays on |
Disable Geographic Area Hierarchy Jarvis onwards | Controls whether Geographic Area hierarchy (parent-child relationships) is displayed in the Geographic Area picklist. | All Geographic Areas will display in an ascending alphabetical order in the picklist. | Parent - child hierarchy will be shown in Geographic Areas in the picklist. |
Hide Update Results Button KALAUSI ONWARDS | Controls the display of the Update Results button on the page | Button is not displayed | Button is displayed |
Retain formatting of qualitative Results on download/ upload LIBERTAS ONWARDS | Controls the display of HTML tags and characters on the downloaded template | HTML characters are displayed for downloaded results. | HTML characters are not displayed for downloaded results. |
Lock Comments after submitting Results | Controls if the comments are editable after submission of Results | Comments cannot be On download, comments would be displayed as white cells. | Comments can be |
| |||
Refer to the https://verasolutions.atlassian.net/wiki/spaces/AIEP/pages/3732406327 page to know more about these features.
Information Icon Pop-Up Fields
Each Project Indicator has an information icon in the Project Indicator column. Hovering over the icon displays a pop-up with additional information stored on the Project Indicator record. By default, “Objectives”, “Guidelines”, “Disaggregation Group”, “Cross-Disaggregated by Sex”, and “ Calculation Factor” are shown are shown. The information icon pop-up is controlled through the “ampi__ADD_RESULTS_INFO_POPOVER” fieldset and this is where the desired pop-up fields can be defined.
Project Indicator Order
By default, all of the Project Indicators on the Add Results table are listed in alphabetical order of their “Indicator Definition” field.
To specify a different order in which the Project Indicators will display, use the field “STAR Project Indicator Order” on Project. This is a picklist field with values based on the fields that are available on the Project Indicator object. Choose a value in this field to display Project Indicators in alphabetically ascending order according to the selected field. This field will alter the order of the Project Indicators both on the Set Targets
and the Add Results component.
For example, if the Project Indicators on Add Results need to be displayed as per the ascending order of related Objectives that they are related to, select Objective in the “STAR Project Indicator Order” picklist on the Project record.
In order to use the “ampi__STAR_Project_Indicator_Order__c” field, it should be added to the relevant page layout on the Project object.
Additionally, the Project Indicators on the Add Results table can be sorted by clicking on the Project Indicator column header. They can be shifted from ascending (a-z) to descending (z-a) and vice versa by clicking on the Project Indicator column header.
Result Frequency and Geographic Area Dropdown Displays
The list of available Project Indicators that are available for entering Result data is determined by the “Result Frequency” and “Geographic Area” selections. This is defined on the Project Indicator level.
All Project Indicators which have a related Project Indicator Reporting Period record child to a parent Reporting Period record with the same Result Frequency as selected in the Result Frequency dropdown, and a related Project Indicator Geographic Area record child to the selected Geographic Area will be displayed on the table.
The “Result Frequency” dropdown will display the values in the “Result Frequency” field of all active Reporting Periods which have a child Project Indicator Reporting Period record related to one of the current Project’s Project Indicators.
The two fields that determine the frequency of Result data of a Project Indicator are the “Result Frequency” and “Reporting Frequency” picklist fields. For more information on setting Frequency values refer to the Manage Indicators section. If an organization tracks a Project Indicator’s Results and Results at the same frequency (Annual), they can choose to set only the “Reporting Frequency” field to Annual. That is, if the “Result Frequency” field is left blank, the “Reporting Frequency” field will be referenced as the Result Frequency.
Reporting Periods are primarily sorted and shown in ascending order by their “Reporting Period End Date” field.If multiple Reporting Periods with the same Reporting Period End Date value exist, they will then be sorted in descending order by their Reporting Period Start Date. By default, the Reporting Period displayed first in the dropdown will be the first one recorded according to “End Date”.
The Project can have a different default Results Reporting Period. On the "Reporting Period" dropdown, this Reporting Period will be displayed first. To select a different default Result Reporting Period, you must:
Ensure that the “Default Results RP Id” field is displayed on the Page Layout.
Navigate to the Reporting Period to display by default and copy the 18-digit Salesforce ID found in the URL of the record.
Navigate to the Details page of the Project and paste the 18-digit ID into “Default Results RP Id” field.
The “Geographic Area” dropdown displays the values in the “Name” field of all active Geographic Areas that have a corresponding child Project Indicator Geographic Area record related to the current Project’s Project Indicators.
It also displays parent Geographic Areas that have a child Project Indicator Geographic Area record related to the current Project’s Project Indicators.
Geographic Areas are displayed in alphabetically ascending order.If a Geographic Area has a parent Geographic Area, it is grouped and sorted alphabetically under its parent Geographic Area with other Geographic Areas at the same hierarchical level.
If parent Geographic Areas displayed in the dropdown do not have a corresponding Project Indicator, they are grayed out to indicate that they cannot be selected.
Add Results LWC is supported in systems with less than 50,000 catalog Geographic Areas.
Search Bar and Filter Customization
As the text is entered into the Quick Search Bar, the search functionality filters down to those Project Indicators whose Indicator Definition or the fields added to the filterset contain the searched phrase. The search also accepts special character inputs.
Click on the “Show More Filters“ button to filter Project indicators on the Add Results table on the basis of the following fields available out of the box:
Indicator Definition
Data Type
Thematic Area
Disaggregation Group
The fields that filter Project Indicators are controlled using the ampi__ST_SEARCH_FILTERS fieldset. The fields can be changed by updating the fields in the fieldset.
The Project Indicators will only be filtered according to the values entered when “Apply filters” button is clicked. When the “Clear Filters” button is clicked, the filters are all cleared and the table reverts to display all Project Indicators.
Please note that when Quick Search and Filters are used together, the table displays only those Indicators which match both criteria: the text in the quick Search Bar and specified filter criteria.
Add Results Data Entry Guidelines Lightning Web Component
The Add Results component allows users to enter Results for a Project Indicator across multiple Reporting Periods on the same table.
If no Results had been previously entered for a Project Indicator for that Geographic Area and Result Frequency, the Result data is saved into a new Result record. If Results had previously been entered for a Project Indicator for that Geographic Area and Result Frequency, the Result data is updated in the existing Result record. The Result record is not deleted but the Result data is cleared if the values are removed from the Add Results table.
The following table references the fields where Result data is stored on the Result record:
Data Type | Field |
Number, Currency, Percent, Numerator/Denominator | Result Value |
Milestone | Result Milestone Value |
Qualitative | Result Qualitative Value |
Picklist | Result Qualitative Value (if Picklist Indicator is not mapped to numbers) Picklist Result Numeric Value (if Picklist Indicator is mapped to numbers) |
For non-disaggregated Project Indicators, Result data is auto-saved for each input field after the user enters a value and clicks out from the data input cell.
Disaggregated Result Data
The Add Results table also allows you to capture Results for Project Indicators that are Disaggregated by Sex, Age, Income, etc. The fields that control disaggregation of Result data on the Add Results table are:
Results are Disaggregated?
Cross-Disaggregation by Sex
Disaggregation Group
Disaggregation Type (as of Phoenix v1.45 release)
These fields are populated while creating or editing a Project Indicator.
Disaggregated Project Indicators for different data types have different displays.
Comparing Results with Target/Baseline data on the addResults table:
With the ability to set Target Frequencies and Disaggregation levels differently from Result Reporting Frequencies (Refer to this section), the Add Results table displays accordingly:
When Targets and Results have the same Frequency
If the Target Frequency is the same as the Reporting Frequency, and Targets and Results have the same level of Disaggregation, then the Add Results page includes a column that displays Targets to the left of the column that displays input fields where you enter Results. This allows for easy comparison between Targets and Results.
When Targets and Results have different Frequencies
If the Target Frequency for a Project Indicator is different than the Reporting frequency (value in “Target Frequency” field is different from the value in “Reporting Frequency” field), then the Targets for this Project Indicator will not display on the Add Results table. For such a case, the table will appear as follows:
Quasar (v1.47) onwards you can compare your Results against Targets that are set at a lesser frequency. The Target column on the addResults table will now contain a small "pill" that displays the name of the Reporting Period that the target value is being derived from. You can learn more about this here.
However, the user would have to set up Reporting Period Hierarchies in order to view Targets from varying frequencies on the addResults LWC table. Learn how to setup hierarchies here.
When Targets and Results have the same Frequency but different Disaggregation
If the Target Frequency is the same as the Reporting Frequency, but Targets and Results have different levels of Disaggregation, then the Targets for this Project Indicator will display on the Add Results table as follows:
Disaggregated Indicator with same Frequency but Calculate Total set to Don’t Sum Total
For Quantitative Disaggregated Indicators where “Calculate Total” field is set to Don’t Sum Total, the Targets/Baseline will be shown with the message ‘SUMMARY NOT AVAILABLE’. To see the individual disaggregated values, click on the pencil icon. It will open a pop-up where individual disaggregated values for both Targets/Baseline and Results will be displayed.
Result Record creation when Project Indicators are disaggregated by multiple custom groups Phoenix Release v1.45
As of the Phoenix Release (v1.45), users can disaggregate a Project Indicator using multiple custom Disaggregation Groups. The “Disaggregation Type” field determines how these groups are structured—either in a Nested or Stacked manner—and directly affects the number of result records created.
Result Record creation for Nested Disaggregation
In Nested disaggregation, each combination of values across all groups results in a unique result record.
For Example a Project Indicator disaggregated by:
Age Group: 2 values (18–30, 31–55)
Locality: 3 values (Rural, Urban, Metro)
Household Income: 4 values (Up to 50K, 51K–70K, 70–100K, 100K+)
Total Result Values = 2 × 3 × 4 = 24
ie
Total Result Values = # of values in Group 1 × # of values in Group 2 × # of values in Group 3
Please keep load limits in consideration while disaggregating Project Indicators in a nested manner. Ensure that the number of result records do not exceed 500 result records per Project Indicator or that will cause delays in loading.
Result Record creation for Stacked Disaggregation
In Stacked disaggregation, values across all groups are stacked vertically, and each disaggregation value contributes one result record.
For Example a Project Indicator disaggregated by:
Age Group: 2 values (18–30, 31–55)
Locality: 3 values (Rural, Urban, Metro)
Household Income: 4 values (Up to 50K, 51K–70K, 70–100K, 100K+)
Total Result Values = 2 + 3 + 4 = 9
i.e
Total Result Values = # of values in Group 1 + # of values in Group 2 + # of values in Group 3
Entering Result Values for a Project Indicator Lightning Web Component
Results can be captured for Project Indicators in a variety of qualitative and quantitative data formats. By default, the first column displays the value saved in the Indicator Definition field. The format of these input fields varies based on the Project Indicator’s Data Type and Result Type.
For Quantitative Indicators, where Calculate Total is set to Don’t Sum Total phoenix v1.45
Results for each disaggregated value are displayed. Total values are not displayed in an additional row or column. The following table displays how the disaggregated pop-up looks when the Project Indicator is disaggregated.
Disaggregation Type | How the disaggregated values are displayed in the popup |
|---|---|
Cross-Disaggregated by sex | User can enter the results for Male, Female and Unknown values. For Percent and Numerator/Denominator data types an additional Summary Value (across Male, Female and Unknown values ) can be entered by the user.
|
Disaggregated by a custom group | Total /Summary Values are not displayed for Number, Currency, Percent and Numerator/Denominator data types. |
Disaggregated by a custom group and sex | Total values (both row and column totals) are not displayed for Number and Currency Data Types. For Percent and Numerator/Denominator data types, user can input an additional Summary Value for each disaggregated value (across Male, Female and Unknown values). |
Disaggregated by multiple group in a nested manner | Total columns are not shown between the Disaggregation Groups for Number, Currency, Percent and Numerator/Denominator data types. |
Disaggregated by multiple groups in a stacked manner | Total of all Disaggregation Values for a Disaggregation Group are not displayed on the Disaggregation Group header for Number, Currency, Percent and Numerator/Denominator data types. If targets are not disaggregated, the target value will not be displayed inside the popup. |
Disaggregated by multiple groups in a nested manner and cross disaggregated by sex | User can enter Male, Female and Unknown targets for each Disaggregation Value in a nested manner. Totals (both row and column totals) are not displayed for all data types. For Percent and Numerator/Denominator data type, user can input an additional Summary Value for each disaggregated value (across Male, Female and Unknown values). |
Disaggregated by multiple groups in a stacked manner and cross disaggregated by sex | User can enter Male, Female and Unknown targets for each Disaggregation Value in a stacked manner. Total of all custom disaggregation values for Male, Female and Unknown values are not displayed on the Disaggregation Group headers for all data types.
For Percent and Numerator/Denominator data type, user can input an additional Summary Value for each disaggregated value (across Male, Female and Unknown values). |
For Quantitative Indicators, where Calculate Total is set to Sum Total
a. Indicators of Number, Currency and Numerator/Denominator Data Type
Cross-Disaggregated by sex | User can enter the results for Male, Female and Unknown values. For Numerator/Denominator data type, an auto calculated Summary Value is displayed as an additional column. The Summary Value is auto-calculated as a sum of numerators divided by the sum of denominators of the individual male, female and unknown values. Stoplights will be displayed against the Summary Value, if targets are captured at the same level of disaggregation and frequency. |
Disaggregated by a custom group | Total of all the disaggregation values is auto-calculated and displayed for Number Currency Data and Numerator/Denominator data types. When Hide Total toggle is active the total is hidden. For numerator denominator, the Total is auto-calculated using (Sum of all numerators/Sum of all denominators) * Calculation Factor for each disaggregated value. If the targets are not disaggregated, the target value is displayed on the header.
|
Disaggregated by a custom group and sex |