| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
A Quick Introduction to Creating and Managing Indicators
Indicators can be created and managed via the Manage Indicators page. The Manage Indicators page is used to
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Here you want to focus on the following:
|
Other Resources for [ADD YOUR TOPIC]
[Enablement Site Module]
[OTHER]
A Quick Video
| Widget Connector | ||
|---|---|---|
|
The Details of [ADD YOUR TOPIC]
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
Here you want to focus on the step-by-step instructions, including screenshots to help the user really work through this. |
...
control which Indicators (catalog and/or custom) should be reported for a Project and how they should be reported (frequency, disaggregation, etc).
...
Other Resources for Creating and Managing Indicators
[Enablement Site Module]
...
The Details of Creating and Managing Indicators
Create Project Indicator records from the Indicators Catalog tab
On the ManageIndicators page is a tab labeled, ‘Indicators Catalog.’ This tab allows users to view a list of standard indicators that can then be added to multiple projects, see the screenshot below. This catalog can be set-up by uploading the indicators using a tool such as http://dataloader.io and can streamline project setup and facilitate better reporting and aggregation of data.
Within the Indicators Catalog, users may browse through all Indicator records in a table format.
The table displays each record in the first column as a hyperlink and is clickable to the record detail.
By default, catalog indicators are displayed according to Indicator Definition.
ⓘ Admin Note: To customize the display of specific fields within this table, speak to your System Admin. Fields may be added to the Indicators Catalog Table by navigating to the CATALOG_INDICATORS_TABLE field set on the Indicator__c object. |
The table will display all Indicator records which do not have a child Project Indicator record related to the current Project.
By default, Indicators in the Indicators Catalog are sorted alphabetically according to Indicator Definition.
Clicking on a column header sorts the Indicators by ascending alphabetical order, by the selected field. Clicking on the column header a second time sorts them in descending alphabetical order by the selected field.
In order to specify the order in which the catalog indicators will appear in the Catalog Indicators Table, the field MI_Indicator_Order__c may be added to the Project page layout.
This field contains a list of picklist values based on the fields that are available on the Indicator object. Choosing a value for this field will sort the catalog indicators in ascending order according to the chosen field. For example, if a user wants the catalog indicators in this table to display according to Thematic Area, navigate to the Project page layout and choose the picklist value “Thematic Area” for the order field.
ⓘ Admin Note: Users who wish to sort the order of project indicators by a custom field may speak to a system admin to create new picklist values for the MI_Indicator_Order__c field. |
The table displays 10 Indicator records at a time. Other Indicators can be accessed via the pagination at the bottom of the table.
Search for and filter Indicator records using QuickSearch, or by configuring a custom set of fields. Filtered results are ordered according to MI_Indicator_Order__c, or alphabetically if the field is NULL.
If additional filter criteria is included and the user clicks Apply Filters, then the list of Indicators is further filtered to that criteria.
As text is entered into the QuickSearch bar as shown in the screenshot below, the Indicators displayed in the table are filtered down by those that contain the input text.
QuickSearch Input must exceed 2 characters for results to display.
The ampi__INDICATOR_CATALOG_SEARCH_FILTER field set can be configured to filter by specific, custom or standard fields. The following fields are available out of the box with Amp Impact:
Data type
Geographic Disaggregation
Reporting Frequency
Thematic Area
For further customization, please speak to your system admin and refer to the Installation Guide.
When “Clear Filters” is clicked, the filters are all cleared and the table reverts to display all Indicator records in the catalog.
To create Project Indicator records from the Indicators Catalog, the user can click the checkbox on the left of all relevant rows of Indicator data in the table and click the Add Selected button.
...
When the Add Selected button is clicked, Project Indicator records and any applicable junction records are created. The Indicator is then removed from the Indicators Catalog table and added to the Selected Indicators table. The user is then taken to the Selected Indicators page.
ⓘ Admin Note: Project Indicators are displayed in alphabetical order and newly added indicators from the Indicators Catalog will display in alphabetical order. |
Selections apply only for the current page of Indicators. If the user selects Indicators from one page, but navigates to a new page, the selected indicators from the previous page are disregarded when the Add Selected button is clicked.
Create custom Project Indicator records from the Selected Indicators tab
Create custom indicators for the current project and manage indicators that have already been added to the project.
When the Add New Custom Indicator button is clicked, a pop-up opens.
...
This pop-up displays the fields in the ADD_NEW_INDICATOR_POPUP field set on the Indicator object. You can use the field set to control which fields are displayed in the pop-up for the user to enter information on while creating the new project indicator.
When creating a new Project Indicator, certain fields are required to ensure the Indicator is accurately created in the Project. All new Project Indicators require an Indicator Definition, Data Type, Reporting Frequency and Geographic Disaggregation. All other attributes for a Project Indicator are voluntary but users can add new required fields to the field set per their organization’s requirements.
ⓘ Admin Note: If the System Admin has defined default values for custom or out of the box fields on ampi__Indicator__c, then the default values will be automatically populated when the user creates a new custom ampi__Project__Indicator__c using the Add New Custom Indicator pop-up and when the user adds an ampi__Indicator__c to the current ampi__Project__c using the Indicator Catalog tab on Manage Indicators page. Note that some fields have default values predefined out of the box:
|
On the ‘Add New Custom Indicator’ popup is a field labeled ‘Include in Catalog?’ This checkbox field controls the availability of the Indicator to the projects created. When creating a custom Indicator, the Indicator can either be:
Added to only the current Project (ampi__Include_in_Catalog__c = FALSE)
Added to the current Project and made available to all other Projects (ampi__Include_in_Catalog__c = TRUE)
By default, the field ampi__Include_in_Catalog__c is selected as TRUE (that is, it is checked), which adds the Indicator to the Selected Indicators table for the current project and the Indicator Catalog for all other projects.
If the field is FALSE (that is, it is unchecked), the Indicator will only be added to the Selected Indicators table for the current project. If this indicator is later removed from the project, then it will display in the Indicator Catalog for that project only, and it does not display in the Indicator Catalog for any other projects.
In order to change the value of the field ampi__Include_in_Catalog__c for a particular indicator, a user must open the indicator record in native Salesforce. The value in this field may not be changed by editing a project indicator via ManageIndicators page. The data load on MI page is only affected by Indicator records where ampi__Include_In_Catalog_c = TRUE. e.g. If there are 200 Indicators but only 100 indicators have ampi__Include_In_Catalog_c = TRUE, then only those 100 indicators contribute to data load.
When the user clicks Save:
A new Indicator record is created with the input data.
A Project Indicator record is created child to the current Project and the newly created Indicator record.
Applicable junction records, like ampi__Project_Indicator_Geographic_Area__c and ampi__Project_Indicator_Reporting_Period__c, are created.
If certain fields like Disaggregation_Group__c are populated, then a new junction record Disaggregated_Project_Indicator__c is created.
The following diagram describes the relationship between data on the Indicator record and the Project Indicator record:
Data from some fields is stamped from the Indicator to Project Indicator record. This data can be modified and customized for the Project Indicator record and does not impact the Indicator record.
Data from some fields on the Indicator record carry over to the Project Indicator record using formula fields. This data cannot be modified for the Project Indicator record.
...
If a System Admin has configured validation rules on the Project_Indicator__c object, then the user will be unable to save or edit a record if it does not meet the validation criteria. See screenshot below.
...
View all the Project Indicator records related to the project in a table format
The table displays each record in the first column as a hyperlink and is clickable to the record detail.
By default, Project Indicators in the Selected Indicators table are sorted alphabetically according to Indicator Definition.
ⓘ Admin Note: To customize the display of specific fields within this table, speak to your System Admin. Fields may be added to the Selected Indicators Table by navigating to the SELECTED_PROJECT_INDICATORS_TABLE field set on Project_Indicator__c object. The first column in the Selected Indicator table always displays with a hyperlink to the respective project indicator record. |
Clicking on a column header sorts the project indicators in ascending alphanumeric order, by the selected field. Clicking on the column header a second time sorts them in descending alphanumeric order by the selected field.
In order to specify the order in which the project indicators will appear in the Selected Indicators Table, the field MI_Project_Indicator_Order__c may be added to the Project page layout. It contains a list of picklist values based on the fields that are available on the Project_Indicator__c object. Choosing a value for this field will display project indicators in ascending order according to the chosen field.
For example, if a user wants project indicators in this table to display according to Thematic Area, navigate to the Project page layout and choose the picklist value “Thematic Area”. By default, the order of the catalog indicators are according to indicator definition.
...
ⓘ Admin Note: Users who wish to sort the order of project indicators by a custom field may speak to a system admin to create new picklist values for the MI_Project_Indicator_Order__c field. |
The table displays 10 Project Indicator records at a time. Other Project Indicators can be accessed via the pagination at the bottom of the table.
When the Comment icon is clicked, a pop-up window opens where the user can enter comments about the Project Indicator. On click of Save, these comments are saved to the Project Indicator’s Notes field. On click of Cancel, any changes made are discarded.
Search for and filter Project Indicator records related to the project
As text is entered into the QuickSearch Search bar, the table is filtered down to display only those project indicators that contain the input text in any of the fields added to the project indicator table or the filterset.
QuickSearch Input must exceed 2 characters for results to display.
The ampi__PROJECT_INDICATORS_SEARCH_FILTERS field set can be configured to filter by specific, custom or standard field types. The following fields are available out of the box with Amp Impact:
Data type
Geographic Disaggregation
Reporting Frequency
Thematic Area
...
ⓘ Note: Please note that when Quick Search and Filters are used together, the table displays only those results which match both criteria: the text in the quick search bar and specified filter criteria. |
Modify Project Indicator records related to the Project
When the Edit icon is clicked, the Edit Indicator pop-up window opens.
...
This pop-up displays the fields contained in the EDIT_PROJECT_INDICATOR_POPUP field set on the Project_Indicator__c object. Adding or removing fields from the field set will control which fields show in the pop-up.
Some fields are not editable on the Project Indicator through the Edit icon. If a user chooses to display the following fields in the field set - Aim, Data Type, Reporting Currency - these will not be editable since these are formula fields from the Indicator object. The rationale for creating these as formula fields is that editing any of these attributes significantly alters the meaning of that Project Indicator and for data integrity purposes, changing those fields should require creating a new indicator.
For each Project Indicator, users can choose the number of decimal points for data entry per your reporting requirements. When a Project Indicator is created, by default, it is set to be reported with no decimal points. Change and customize this per Project Indicator to increase the number of decimal points by adding the Number of Decimal Places Allowed field to the field set or by opening the particular Project Indicator record. This field supports up to 2 decimal places.
If a user chooses to add Reporting_Currency__c to this field set, the value will be displayed but will not be editable through the edit icon. In addition, this field will display a blank for any Project Indicator with Data Type ≄Currency
Remove Project Indicator records related to the Project
Amp Impact has two options for removing Project Indicators from a project: deletion and deactivation.
A Project Indicator record can be deleted by clicking on the Delete (trash bin) icon next to the Project Indicator in the Selected Indicators table. On click of the Delete icon, the user will be prompted to confirm the delete action.
...
When the deletion is confirmed, the Project Indicator record is deleted, along with any of its associated records (i.e. Results, Project Indicator Reporting Period, Project Indicator Geographic Area, etc.). The Project Indicator and its related data are no longer displayed on any of the Visualforce pages.
...
A Project Indicator can be deactivated by editing a Project Indicator in the Selected Indicators table and de-selecting the Active checkbox and setting it to FALSE in the Visualforce page. (See this section on how to deactivate Project Indicators in the Lightning Web Component.) When the record is saved, the Project Indicator record is no longer displayed on any of the Visualforce pages - except for ManageIndicators, where it is moved to the Deactivated Indicators tab.
ⓘ Admin Note: When a Project Indicator is deactivated, any Project Indicator Reporting Period records that have a Start Date after the deactivation date are deleted so no empty records exist in the system. |
Manage Deactivated Project Indicator records related to the Project
On the ManageIndicators page there is a tab labeled, ‘Deactivated Indicators.’ This tab allows users to view a list of deactivated project indicators. See the screenshot below.
...
Within the Deactivated Indicators tab, users may browse through all deactivated project indicators.
The table displays each record in the first column as a hyperlink and is clickable to the record detail.
By default, deactivated project indicators are ordered according to Indicator Definition.
Clicking on a column header sorts the deactivated project indicators in ascending alphanumeric order, by the selected field. Clicking on the column header a second time sorts them in descending alphanumeric order by the selected field.
The table displays 10 deactivated Project Indicator records at a time. Other deactivated Project Indicators can be accessed by toggling between pages at the bottom of the table.
Search for and filter deactivated Project Indicator records related to the project.
As text is entered into the QuickSearch Search bar, as shown in the screenshot above, the project indicators displayed in the table are filtered down by those whose Data Type or Thematic Area contain the input text.
The project indicators field set can be configured to filter by specific, custom or standard field types. The following fields are available out of the box with Amp Impact:
Data type
Geographic Disaggregation
Reporting Frequency
Thematic Area
To reactivate Project Indicator records from the Deactivated Indicators table, the user can click the checkbox on the left of all relevant rows of Project Indicator data in the table and click the Activate Selected button. See screenshot below.
...
When the Activate Selected button is clicked, the Project Indicator is then removed from the Deactivated Indicators table and added to the Selected Indicators table.
Use search bar and filters for specific types of indicators across Selected, Catalog, and Deactivated Indicators table
As text is entered into the QuickSearch Search bar, the project indicators displayed in the table are filtered down by indicators that contain the input text.
The project indicators field set can be configured to filter by specific, custom or standard field types. The following fields are available out of the box with Amp Impact:
Data type
Geographic Disaggregation
Reporting Frequency
Thematic Area
For further customization, please speak to your system admin and refer to the Installation Guide.
ⓘ Note: Please note that when Quick Search and Filters are used together, the table displays only those results which match both criteria: the text in the quick search bar and specified filter criteria. |
...