Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This page covers:

Table of Contents
minLevel2
maxLevel3
stylecircle

...

Design attributes control the display of various buttons/components on the Add Results page.

...

Info

Refer to the Add Results page to know more about these features.

Information Icon Pop-Up Fields

Each Project Indicator

...

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 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.

...

  • 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:

    1. Ensure that the “Default Results RP Id” field is displayed on the Page Layout. 

    2. Navigate to the Reporting Period to display by default and copy the 18-digit Salesforce ID found in the URL of the record. 

    3. 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. 

Info

Numerator/Denominator indicators support Stoplights 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 Numerator/Denominator) 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

Info

Numerator/Denominator indicators support Validation Ranges from Nashira Release (v1.38) onwards.

To utilize this feature, the following fields must be populated:

  1. “Validation Range Minimum” and “Validation Range Maximum”

...

  1. for Number, Currency and Percent Indicators

  2. “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 attribute as TRUE on the setResults component in Lightning App Builder to disable them.  

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.

...

out of range.

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 / or  EDIT_PROJECT_INDICATOR_POPUP fieldset on the Project Indicator object.

...

Customize Submit Results for Review Process
Status
colourPurple
titleLightning Web Component

...

  1. 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. 

  2. 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).

  3. On the Add Results page, the Results are locked out and display as read-only when

    1. Result_Locked__c = TRUE ,or

    2. 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 ,or

...

Considerations for the Refresh Functionality
Status
colourPurple
titleLightning Web Component

...

Object

Field set name

Default Behaviour

ampi__Project_Indicator__c

SET_TARGETS_INFO_POPOVER

The following fields are available out of the box:

  • ampi__Objective__c

  • ampi__Guideline__c

  • ampi__Disaggregation_Group__c

  • ampi__Cross_Disaggregation_by_Sex__c

Note: ampi__xx_Calculation_Factor__c is availably by default in the Mira (v1.37) release.

Fields displayed in search filter panel

...

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 unrestricted access to manage Set Targets through SetTargets LWC, 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.

...