...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
The AddResults Lightning Web Component is a table that displays the Project Indicators available for Result data inputs. The Project Indicator data setup will determine which Project Indicators are available for Result data inputs by Result Frequency and Geographic Area.
This page details the customization options for the elements in the AddResults Lightning Web Component.
AddResult Table Customization Options
Project Indicator Hyperlinks
By default, the Project Indicators in the Add Results table are hyperlinked to their related records. Mark the “Hide Hyperlink in First Column?” design attribute on Lightning App Builder as TRUE to remove the hyperlink and display the Project Indicators as plain text.
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”, and “Cross-Disaggregated by Sex” are shown. The information icon pop-up is controlled through the “ampi__SET_TARGETS_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.
Remove Target or Baseline Values from AddResults Table
By default, Target values are visible on the Add Results table. Set the “Hide Targets Column?” design attribute on Lightning App Builder to TRUE to hide the column. This will ensure that Target values will not be displayed in the Add Results table.
...
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
| Info |
|---|
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.
...
| Info |
|---|
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
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 | 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) |
Non-Disaggregated Result Data
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
These fields are populated while creating or editing a Project Indicator.
Result values will be Disaggregated only when the “Results are Disaggregated?” checkbox field is marked as TRUE while creating/editing an Indicator on the Manage Indicators page. If the “Cross-Disaggregation by Sex” checkbox field is marked as TRUE or the “Disaggregation Group” field has a value, but the “Results are Disaggregated?” checkbox field is marked as FALSE, Results and Baseline will be Disaggregated, but Results will not be disaggregated.
...
| Info |
|---|
Historical data remains when users change the “ampi__Results_Are_Disaggregated__c” field from TRUE to FALSE. For example, if the Results and Results for a Project Indicator are Disaggregated by group (ampi__Results_Are_Disaggregated__c is set to TRUE) and Results have already been included, then the Results input for the disaggregation values remain if Results_Are_Disaggregated__c is changed to FALSE. |
Disaggregated Project Indicators for different data types have different displays.
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:
...
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.
...
Entering Result Values for a Project Indicator
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
Targets/Baseline 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 | |
Disaggregated by Group | |
Cross-Disaggregated by Sex and Disaggregated by Group |
Once Disaggregated values are entered, a pencil icon will be displayed on the Add Results table. “SUMMARY NOT AVAILABLE” is shown on the Target column.
For Quantitative Indicators, where Calculate Total is set to Sum Total
Indicators of Number and Currency Data Type
The pop-up will display Total value(s) of Results in an additional row or column or both. Total value(s) for Results are auto calculated. Total value of Targets/Baseline is also displayed along with the individual disaggregated Target/Baseline values. 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 | |
Disaggregated by Group | |
Cross-Disaggregated by Sex and Disaggregated by Group |
The Total value for Results will be shown on the Add Results table as a hyperlinked value. The users can click on the hyperlinked value to view/ update the Results.
Indicators of Percent Data Type
Level of Disaggregation | How the disaggregated values are displayed inside the popup | How the total value/ icons is displayed on the Set Targets table |
Cross Disaggregated by Sex | The pop-up will display an input field for Total Result value (Summary Value) for Results in an additional column. Total Target/ Total Baseline value that was entered while setting Targets/Baseline is also displayed along with the individual disaggregated Target/Baseline values. | Until the Total value is not entered, a pencil icon is displayed on the Add Results table. Once a Total value is entered, it is visible on the Add Results table as a hyperlinked value. |
Disaggregated by Group | The pop-up will display Total value for Results as an additional row on top of the disaggregated values.The Total Percent value is auto-calculated as a sum of the individual disaggregated values. Total value that had been entered while setting Targets/Baseline is also displayed along with the individual disaggregated Target/Baseline values. | Once Results for disaggregated values are entered, the Total value is displayed as a hyperlink on the Add Results table. |
Cross Disaggregated by Sex and Disaggregated by Group | The pop-up allows users to set a Total (Summary Values) of each row of Results. Once these Total (Summary Values) of rows are entered, their sum is auto-calculated and displayed as a Total value in an additional row on the top. Total of all Male, Female and Unknown values in also shown in the row on top. Total value that had been entered while setting Targets/Baseline is also displayed along with the individual disaggregated Target/Baseline values. | A pencil icon is displayed when Results are entered for each level of disaggregation. Once a Total value (Summary Value) is entered, it is shown on the Add Results table. When all Total values (Summary Values) for Results are entered, the sum of all Total values is displayed on the Add Results table |
...
For Qualitative Indicators
For Qualitative Indicators, the pop-up accepts rich text input. The users can scroll vertically and horizontally within the pop-up. Targets for each disaggregated value are also displayed. They are not editable.
Once a Result is entered, a pencil icon is displayed on the Add Results table. For Target/Baseline values, “SUMMARY NOT AVAILABLE” is displayed under the Target/Baseline column on the Add Results table.
...
For Milestone/Picklist Indicators
For Milestone/Picklist Indicators, the pop-up displays a dropdown for all the disaggregated values.It also allows users to scroll vertically and horizontally. Once a Result is entered, a pencil icon is displayed on the Add Results table.
C
Set Up Validation Ranges
Validation ranges for Indicators facilitate better data quality. This feature allows users to set a minimum and maximum value for Quantitative Indicators (where Data Type is either Number, Currency, or Percent) to be able to check if the values entered in the input fields are within the range of expected values. To utilize this feature, the fields “Validation Range Minimum” and “Validation Range Maximum” must be populated on Project Indicators.
By default, Validation Ranges are enabled in the Add Results table. Mark the “Hide Validation Ranges?” design attribute as TRUE on the setResults component in Lightning App Builder to disable them.
In order to set validation ranges while creating and/ or editing a Project Indicator, please ensure that fields “Validation Range Minimum” and “Validation Range Maximum” are available in the ampi__ADD_NEW_INDICATOR_POPUP fieldset on the Indicator object and/ or EDIT_PROJECT_INDICATOR_POPUP fieldset on the Project Indicator object
If the result value entered is less than the value set in the Validation Range Minimum” field or more than the value set in the “Validation Range Maximum” field on the Project Indicator, a warning message appears at the top of the page and the input field is highlighted with an orange border. Please note that the result value is still saved in the Result record.
...
Users can click on the “x” on the warning message notification when it first appears and continue entering Result values. The message will not reappear if another value is entered outside the expected range once the warning message has been closed by the user, until the component is refreshed or if the user navigates away from the Add Results component, returns to it and adds another value that is out of range.
Customize Submit Results for Review Process
Once data entry is complete for Results for a given Reporting Period, the “Submit” button can be used to lock the Results.
...
By default, the “Submit” button is visible on the Add Results component. Mark the “Hide Submit?” design attribute as TRUE on Lightning App Builder to hide the button.
Users are able to submit Results for multiple Reporting Periods. For example, a user may need to submit Results for Chile for quarter 2 and the semi-Annual report. They can select multiple Reporting Periods, enter data and then submit.
Users have the option to create workflows that trigger certain actions on the click of the Submit button. For example, clicking on the Submit button can set a specific Status and generate an email notification. On Click of “Submit’ on the Add Results page, Result_Status__c = Submitted, thus making the Add Results page uneditable. To make the page uneditable when any other status is selected, the Result_Status__c field can also be configured through a workflow to edit the Results_Locked__c field which can lock the Result input fields for the selected Reporting Periods and Geographic Area (un-editable so that users can no longer make any changes to the data entered).
On the Add Results page, the Results are locked out and display as read-only when
Result_Locked__c = TRUE ,or
Result_Status__c = Submitted for the selected Reporting Period(s).
Considerations for the Refresh Functionality
Click the Refresh icon (as displayed in the screenshot below) on the Add Results component to load and reflect the latest data on the Add Results component along with all the Results that have been previously recorded. For example, if the Project Indicator Definition is edited or a Geographic Area is marked Inactive, these changes will be reflected once the Add Results component is refreshed.
The Add Results table will load with the previous selections made on the “Result Frequency” and “Geographic Area”dropdowns. It will also preserve the scroll position on the Add Results table (both horizontal and vertical).
...
If any changes are made on Manage Frameworks, Manage Indicators, or Add Results (either the Visualforce pages or the Lightning Web Component for all three), then the Add Results Lightning Web Component will display a warning message alerting the user that the data on that page is not updated with the most accurate data.
The user can then click on the Refresh icon to reload the component and display any data updates made on the related components.
...