...
Design attributes control the display of various buttons/components on the Add Results page.
...
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
| 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
| 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
| 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 |
| Info |
|---|
Refer to the Add Results page to know more about these features. |
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
. | |||||||||
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 | ||||||
| |||||||||
| Info |
|---|
Refer to the Add Results 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.
...
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.
...
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
...
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.
...
Please ensure that these fields are added to the “ampi__ADD_NEW_INDICATOR_POPUP” fieldset on the Indicator object and to the “ampi__EDIT_PROJECT_INDICATOR_POPUP” fieldset on the Project Indicator object in order to set their value while creating or editing a Project Indicator.
| Noteinfo |
|---|
Note: Numerator/Denominator type Indicators currently do not indicators support Stoplights . This means you cannot configure visual cues (red, yellow, green) based on performance thresholds for these indicators.from Nashira Release (v1.38) onwards. |
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, Percent, or PercentNumerator/Denominator) to be able to check if the values entered in the input fields are within the range of expected values.
| Info |
|---|
Numerator/Denominator indicators support Validation Ranges from Nashira Release (v1.38) onwards. |
To utilize this feature, the following fields must be populated:
“Validation Range Minimum” and “Validation Range Maximum”
...
for Number, Currency and Percent Indicators
“Validation Range Minimum Numerator”, “Validation Range Minimum Denominator”, “Validation Range Maximum Numerator” and “Validation Range Maximum Denominator” for Numerator/Denominator 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 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
| Status | ||||
|---|---|---|---|---|
|
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.
...
| Info | ||||||
|---|---|---|---|---|---|---|
In order to set validation ranges while creating and/ or editing a Project Indicator, please ensure that fields “Validation Range Minimum” , “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.
For Numerator/Denominator Indicators, please ensure that fields “Validation Range Minimum Numerator”, “Validation Range Minimum Denominator”, “Validation Range Maximum Numerator” and “Validation Range Maximum Denominator” are available in the ampi__ADD_NEW_INDICATOR_POPUP fieldset on the Indicator object and EDIT_PROJECT_INDICATOR_POPUP fieldset on the Project Indicator object. |
...
Customize Submit Results for Review Process
| Status | ||||
|---|---|---|---|---|
|
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).
...
| Info |
|---|
System Admin Note: When the “Override Locked Results” custom permission is assigned to a user they can make edits to the Results even if Result_Locked__c = TRUE |
...
Considerations for the Refresh Functionality
| Status | ||||
|---|---|---|---|---|
|
...
| Info |
|---|
When a user downloads an Excel template, they are given a set of instructions on how to properly set up the Excel sheet for upload. For any additional custom instructions that may be needed for your organization, use the custom labels to add further steps to the sections of the instructions sheet. |
Enable Submit button on Add Results page of Reporting Period
| Status | ||||
|---|---|---|---|---|
|
Out of the box, the Submit lightning action button displays to the Digital Experience user but throws an error when clicked if the Add Results Visualforce page is configured on the Reporting Period record page.
Enable the Submit lightning action for the Digital Experience user by following the steps below:
Navigate to the permission set assigned to Digital Experience user
Click on Apex Class Access
Add the apex class SubmitReportModal_CTRL
...
the sections of the instructions sheet. |
Enable Submit button on Add Results page of Reporting Period
| Status | ||||
|---|---|---|---|---|
|
Out of the box, the Submit lightning action button displays to the Digital Experience user but throws an error when clicked if the Add Results Visualforce page is configured on the Reporting Period record page.
Enable the Submit lightning action for the Digital Experience user by following the steps below:
Navigate to the permission set assigned to Digital Experience user
Click on Apex Class Access
Add the apex class SubmitReportModal_CTRL
...
Add Results Components: Customize Field Sets
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
This section details how to customize the field sets on Add Results Lightning Web and VisualForce Components.
Indicator info popover displayed by hovering on the info icon
This fieldset controls the fields displayed shown in the pop-up displayed when users hover over the information icon next to a Project Indicator.
...
Object | Field set name | Default Behaviour |
|---|---|---|
ampi__Project_Indicator__c | ADD_RESULTS_INFO_POPOVER | As of Nashira release (v1.38) The following fields are available out of the box:
|
Up till the Mira (v1.37) release, all columns in the Results Excel Upload Download template except Indicator, Disaggregation and Reporting Period columns are controlled by this field set.
Fields displayed in search filter panel
This fieldset controls the fields displayed when user clicks the “Show More Filters“ button to filter Project indicators on the Set Targets table.
...
Object | Field set name | Default Behaviour | Additional Comments |
|---|---|---|---|
ampi__Project_Indicator__c | ampi__ST_SEARCH_FILTERS | The following fields are available out of the box:
| It is recommended to include no more than five search filter fields in the Add Result page to be able to view the information in a user-friendly manner. Also note that search filter fields display in alphabetical order. |
Configurable Comment Pop-Up
| Status | ||||
|---|---|---|---|---|
|
| Status | |
|---|---|
|
...
|
...
This section details how to customize the field sets on Add Results Lightning Web and VisualForce Components.
Indicator info popover displayed by hovering on the info icon
...
|
Controls the fields displayed in the pop-up displayed when users hover over the information suer clicks on the Comment icon next to a Project Indicator. It gives users the ability to add custom fields like rich text to facilitate the inclusion of longer comments and content such as images and links.
...
Object | Field set name | Default Behaviour | Additional Comments |
|---|---|---|---|
ampi |
_ |
_ |
Result__c |
ampi__ |
COMMENT_ |
POPUP_ |
ADDRESULT | The following fields are available out of the box:
|
|
|
|
|
|
|
|
|
|
Fields displayed in search filter panel
This fieldset controls the fields displayed when user clicks the “Show More Filters“ button to filter Project indicators on the Set Targets table.
...
Object
Field set name
Default Behaviour
Additional Comments
|
|
|
| The following |
field data types will not be supported:
In order to to mark results as Not Applicable, please ensure the following fields are added to the fieldset:
|
|
|
|
|
|
|
|
It is recommended to include no more than five search filter fields in the Add Result page to be able to view the information in a user-friendly manner. Also note that search filter fields display in alphabetical order.
...
Enabling Dynamic Display of fields in the Comment Pop-up
Fields can be conditionally displayed inside the Comment Pop-up. (ie. certain fields can be conditionally displayed depending upon the value entered in a controlling picklist type of type) Read more about it here.
When using this functionality in the Comment pop-up, ensure that the result record is populated.
Fields/Columns displayed in in the Targets Upload Download Excel template
| Status | |||
|---|---|---|---|
|
...
|
...
|
Controls the fields displayed in the pop-up displayed when suer clicks on the Comment icon next to a Project Indicator. It gives users the ability to add custom fields like rich text to facilitate the inclusion of longer comments and content such as images and links.
...
The fieldset INDICATOR_FIELDS_ADD_RESULTS_EXCEL_TEMPLATEcontrols the display of Indicator attribute fields on the Targets Upload Download Excel Template. It is available from Nashira (v1.38) release
Object | Field set name | Default Behaviour |
|---|
Additional Comments
ampi__ |
Project_Indicator__c | ampi__ |
INDICATOR_FIELDS_ADD_RESULTS_EXCEL_TEMPL | The following fields are available out of the box:
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
The following field data types will not be supported:
Text (Encrypted)
Date/Time
In order to to mark results as Not Applicable, please ensure the following fields are added to the fieldset:
ampi__xx_Results_Not_Applicable__c
ampi__xx_Female_Results_Not_Applicable__c
ampi__xx_Male_Results_Not_Applicable__c
ampi__xx_Unknown_Results_Not_Applicable__c
...
Add Results: Custom Permissions
| Status | ||||
|---|---|---|---|---|
|
This section details the Custom Permissions that can be used to customize Add Results LWC
This functionality is available from Nashira v1.38 release onwards.
Label | API Name | Description |
|---|---|---|
Override Locked Results | Override_Locked_Results | This custom permission grants an exception to the "Results Locked" functionality. Assigned users will have the ability to edit results including uploading Excel templates, even if the Results Locked field (ampi__Results_Locked__c) on the ampi__Reporting_Period__c object is set to TRUE. |
...