...
Design Attribute | Related UI Element | UI if True | UI if False | ||||||
|---|---|---|---|---|---|---|---|---|---|
Hide Submit? | Controls the display of | Submit button is not displayed. | Submit button is displayed. | ||||||
Hide Comments? | Controls if comments | Comments related | Comments related to | ||||||
View Only Mode? | Controls whether the | Targets cannot be | Targets can be edited. | ||||||
Hide Refresh? | Controls the display of | Refresh button is | Refresh button is not | ||||||
Allow Users to Set
| Controls whether users | Users are allowed | Users are unable to set a Baseline for Project | ||||||
Hide Validation | Controls the behavior of | Set Targets page | Set Targets 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 | ||||||
Disable Geographic Area Hierarchy
| Controls whether Geographic Area hierarchy (parent-child relationships) is displayed in the 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 Targets Download Button
| Controls the display of the Download Excel Template Button on the page | Button is not displayed. | Button is displayed. | ||||||
Hide Targets Upload Button
| Controls the display of the Upload Excel Template Button on the page | Button is not displayed. | Button is displayed. | ||||||
Retain formatting of qualitative Targets on download/ upload
| Controls the display of HTML tags and characters on the downloaded template | HTML characters are displayed for downloaded targets. | HTML characters are not displayed for downloaded targets |
| Info |
|---|
Refer to the Set Targets page to know more about these features. |
Project Indicator Order
By default, all of the Project Indicators on the Set Targets 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 Set Targets 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 Set Targets 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.
Target Frequency and Geographic Area Dropdown Displays
The list of available Project Indicators that are available for entering Target data is determined by the “Target 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 same Target Frequency as selected in the Target Frequency dropdown, and a related Project Indicator Geographic Area record child to the selected Geographic Area will be displayed on the table.
The “Target Frequency” dropdown will display the values in the “Target 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 Target data of a Project Indicator are the “Target Frequency” and “Reporting Frequency” picklist fields. For more information on setting Frequency values refer to the Manage Indicators section in the User Guide. If an organization tracks a Project Indicator’s Targets and Results at the same frequency (Annual), they can choose to set only the “Reporting Frequency” field to Annual. That is, if the “Target Frequency” field is left blank, the “Reporting Frequency” field will be referenced as the Target Frequency.
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.
Set Targets LWC is supported in systems with less than 50,000 catalog Geographic Areas.
...
. | |||||||||
Lock Comments after submitting Targets/Baseline
| Controls if the comments are editable after submission of Targets/Baseline | Comments/ Fields in the comment popup cannot be edited post submission of Targets/Baseline. They can only be viewed. | Comments/ Fields in the Comment popup can be | ||||||
| |||||||||
| Info |
|---|
Refer to the Set Targets page to know more about these features. |
Project Indicator Order
By default, all of the Project Indicators on the Set Targets 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 Set Targets 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 Set Targets 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.
Target Frequency and Geographic Area Dropdown Displays
The list of available Project Indicators that are available for entering Target data is determined by the “Target 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 same Target Frequency as selected in the Target Frequency dropdown, and a related Project Indicator Geographic Area record child to the selected Geographic Area will be displayed on the table.
The “Target Frequency” dropdown will display the values in the “Target 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 Target data of a Project Indicator are the “Target Frequency” and “Reporting Frequency” picklist fields. For more information on setting Frequency values refer to the Manage Indicators section in the User Guide. If an organization tracks a Project Indicator’s Targets and Results at the same frequency (Annual), they can choose to set only the “Reporting Frequency” field to Annual. That is, if the “Target Frequency” field is left blank, the “Reporting Frequency” field will be referenced as the Target Frequency.
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.
Set Targets 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.
...
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. To utilize
| Info |
|---|
Numerator/Denominator indicators support Validation Ranges from Nashira Release (v1.38) onwards. |
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 Set Targets table. Mark the “Hide Validation Ranges?” design attribute as TRUE on the setTargets component in Lightning App Builder to disable them.
...
Once data entry is complete for Targets for a given Reporting Period, the “Submit” button can be used to lock the Targets.
...
By default, the “Submit” button is visible on the Set Targets component. Mark the “Hide Submit?” design attribute as TRUE on Lightning App Builder to hide the button.
Users are able to submit Targets for multiple Reporting Periods. For example, a user may need to submit Targets 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 Set Targets page, Target_Status__c = Submitted, thus making the Set Targets page uneditable. To make the page uneditable when any other status is selected, the Target_Status__c field can also be configured through a workflow to edit the Targets_Locked__c field which can lock the Target 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 Set Targets page, the Targets are locked out and display as read-only when
Target_Locked__c = TRUE ,or
Target_Status__c = Submitted for the selected Reporting Period(s).
Considerations for the Refresh Functionality
| Status | ||||
|---|---|---|---|---|
|
Click the Refresh icon (as displayed in the screenshot below) on the Set Targets component to load and reflect the latest data on the Set Targets component along with all the Targets 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 Set Targets component is refreshed.
The Set Targets table will load with the previous selections made on the “Target Frequency” and “Geographic Area”dropdowns. It will also preserve the scroll position on the Set Targets 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 Set Targets 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.
Set Targets Visualforce Page
| Status | ||||
|---|---|---|---|---|
|
Some key features in the product can be configured on/off depending on the client organization’s
preferences for the product. They can be disabled/enabled at the user/profile/organization level.
To enable or disable any of the features in Set Targets, go to Setup → Custom Settings. Refer to the
table on the next page and depending on the feature to be enabled/disabled, either click on:Set Targets or
Amp Impact Setup
...
2. Click on Manage
3. Click on Edit
4. A list of settings would be displayed. Check/Uncheck these settings based on the table below:
...
Field Label
...
Custom Setting
...
Related UI Element
...
UI if True
...
UI if False
...
Disable
Geographic
Area Hierarchy
...
Set Targets
...
Controls how
Geographic Areas are displayed in the Geographic Areas dropdown.
...
Targets are not
displayed in
hierarchy. Child
Geographic Areas
do not nest under
parent Geographic
...
Targets are displayed in
hierarchy. Child
Geographic Areas nest under parent Geographic Areas.
...
Targets for a given Reporting Period, the “Submit” button can be used to lock the Targets.
...
By default, the “Submit” button is visible on the Set Targets component. Mark the “Hide Submit?” design attribute as TRUE on Lightning App Builder to hide the button.
Users are able to submit Targets for multiple Reporting Periods. For example, a user may need to submit Targets 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 Set Targets page, Target_Status__c = Submitted, thus making the Set Targets page uneditable. To make the page uneditable when any other status is selected, the Target_Status__c field can also be configured through a workflow to edit the Targets_Locked__c field which can lock the Target 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 Set Targets page, the Targets are locked out and display as read-only when
Target_Locked__c = TRUE ,or
Target_Status__c = Submitted for the selected Reporting Period(s).
| Info |
|---|
Note: When the “Override Locked Targets” custom permission is assigned to a user they can make edits to Targets even if Targets_Locked__c = TRUE |
...
Considerations for the Refresh Functionality
| Status | ||||
|---|---|---|---|---|
|
Click the Refresh icon (as displayed in the screenshot below) on the Set Targets component to load and reflect the latest data on the Set Targets component along with all the Targets 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 Set Targets component is refreshed.
The Set Targets table will load with the previous selections made on the “Target Frequency” and “Geographic Area”dropdowns. It will also preserve the scroll position on the Set Targets 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 Set Targets 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.
...
Custom Settings: Set Targets Visualforce Page
| Status | ||||
|---|---|---|---|---|
|
Some key features in the product can be configured on/off depending on the client organization’s
preferences for the product. They can be disabled/enabled at the user/profile/organization level.
To enable or disable any of the features in Set Targets, go to Setup → Custom Settings. Refer to the
table on the next page and depending on the feature to be enabled/disabled, either click on:Set Targets or
Amp Impact Setup
...
2. Click on Manage
3. Click on Edit
4. A list of settings would be displayed. Check/Uncheck these settings based on the table below:
Field Label | Custom Setting | Related UI Element | UI if True | UI if False | |||
|---|---|---|---|---|---|---|---|
Disable | Set Targets | Controls how | Targets are not | Targets are displayed in | |||
Excel Upload | Set Targets | Controls if the Excel | Targets can be | Targets cannot be | |||
Hide | Set Targets | Controls if comments | Comments related | Comments related to | |||
Hide Excel | Set Targets | Controls if the Excel | Targets can cannot be | Targets cannot can be | |||
Hide | Set Targets | Controls if comments | Comments related | Comments related to | Hide Excel | NA | NA |
View only | Set Targets | Controls if the Excel | Targets cannot be | Targets can be | |||
Round-Off | Set Targets | Defines the round-off | NA | NA | |||
View only | Set Targets | Controls whether | Targets cannot be | Targets can be edited. Comments on targets can also be edited. | |||
Submit Targets | Targets cannot be | Targets can be edited. Comments on targets can also be edited. | |||||
Submit Targets | Amp Impact | Controls the display of | Submit button is | Submit button is not | |||
Validation | Amp Impact | Controls the behavior | Set Targets page will flag a user if the value entered in the input field is outside of the validation range. | Set Targets will not flag a user based on the value entered in the input field. | |||
Chatter | Amp Impact | Controls the display of | Submit button is | Submit button is not | |||
Validation | Amp Impact | Controls the behavior | Set Targets page will flag a user if the value entered in the input field is outside of the validation range. | Set Targets will not flag a user based on the value entered in the input field. | |||
Chatter | Amp Impact | Controls the display of | Chatter feed | Chatter feed does not |
| Info |
|---|
Refer to the Set Targets page to know more about these features. |
| 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. |
Field Sets: Set Targets Components
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
This section details how to customize the field sets on the Set Targets Lightning Web and VisualForce Components.
Indicator info popover displayed by hovering on the info icon
The fieldset SET_TARGETS_INFO_POPOVER controls the fields displayed in pop-up when users hover over the information icon next to a Project Indicator.
...
Chatter feed on Set | Chatter feed | Chatter feed does not |
| Info |
|---|
Refer to the Set Targets page to know more about these features. |
| 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. |
...
Field Sets: Set Targets Components
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
This section details how to customize the field sets on the Set Targets Lightning Web and VisualForce Components.
Indicator info popover displayed by hovering on the info icon
The fieldset SET_TARGETS_INFO_POPOVER controls the fields displayed in pop-up when users hover over the information icon next to a Project Indicator.
Up till the Mira (v1.37) release, all columns in the Targets Excel Upload Download template except Indicator, Disaggregation and Reporting Period columns are controlled by this field set.
...
Object | Field set name | Default Behaviour |
|---|---|---|
ampi__Project_Indicator__c | SET_TARGETS_INFO_POPOVER | The following fields are available out of the box:
|
Fields displayed in in “Show More Filters” search panel
The fieldset ampi__ST_SEARCH_FILTERS 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:
|
|
|
|
|
|
Fields displayed in in “Show More Filters” search panel
The fieldset ampi__ST_SEARCH_FILTERS controls the fields displayed when user clicks the “Show More Filters“ button to filter Project indicators on the Set Targets table.
...
| It is recommended to include no more than five search filter fields in the Set Targets page to be able to view the information in a user-friendly manner. Also note that search filter fields display in alphabetical order |
Fields/Columns displayed in in the Targets Upload Download Excel template
| Status | ||||
|---|---|---|---|---|
|
The fieldset INDICATOR_FIELDS_SET_TARGETS_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_SET_ |
TARGETS_ |
EXCEL_ |
TEMPL | The following fields are available out of the box:
|
|
|
|
|
It is recommended to include no more than five search filter fields in the Set Targets page to be able to view the information in a user-friendly manner.
|
Configurable Comment Pop-Up
| Status | ||||
|---|---|---|---|---|
|
| Status | ||||
|---|---|---|---|---|
|
...
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.
Custom Permissions
| Status | ||||
|---|---|---|---|---|
|
This functionality is available from Nashira v1.38 release onwards
...
Label
...
API Name
...
Description
...
Override Locked Targets
...
Override_Locked_Targets
...
record is populated.
Custom Permissions
| Status | ||||
|---|---|---|---|---|
|
This section details the Custom Permissions that can be used to customize Set Targets LWC
This functionality is available from Nashira v1.38 release onwards
Label | API Name | Description |
|---|---|---|
Override Locked Targets | Override_Locked_Targets | This custom permission grants an exception to the "Targets Locked" field. Assigned users will have the ability to edit targets through SetTargets LWC, including uploading Excel templates, even if the ampi__Targets_Locked__c on the ampi__Reporting_Period__c object is set to TRUE. |
Override Locked Baseline | Override_Locked_Baseline | Grants an exception to the “Results Locked” field specifically for Baseline Reporting Periods. |
...