IRIS+ Metric Framework Plugin
This page covers:
What is the IRIS+ Metric Framework Plugin?
The IRIS Metric Framework Plugin enables users to upload the IRIS 4.0 Standard library of indicators to the Indicator Catalog.
The IRIS plugin is compatible with Amp Impact version v1.25.2 (Delphinus) or later. Amp Impact must already be installed in the Salesforce org before installing the plugin.
IRIS+ Metrics Framework Plugin Installation & Set Up
Once Amp Impact (v1.25.2 or later) is installed, you can install the IRIS+ Metrics Framework Plugin:
Installation
Install the IRIS+ Metrics Framework Plugin into the relevant environment with these installation links:
Sandbox: https://test.salesforce.com/packaging/installPackage.apexp?p0=04t8c000000yjcG
Production: https://login.salesforce.com/packaging/installPackage.apexp?p0=04t8c000000yjcG
Select which users you wish to install the package for and click “Install”.
Review the field map and the new fields that come with the IRIS Plugin. Then, determine how you want to expose these fields to users on the relevant page layouts, and where you’d want to add them to field sets.
Configuration
Refer to the field map for full configuration details.
Object | Fields | Field Type |
---|---|---|
Indicator__c | xx_IRIS_Calculation__c | Long Text Area (500) |
xx_IRIS_Citation__c | Text(255) | |
xx_IRIS_Footnote__c | Long Text Area (500) | |
xx_IRIS_Metric_Level__c | Picklist (Multi-Select) | |
xx_IRIS_Metric_Quantity_Type__c | Picklist | |
xx_IRIS_Metric_Type__c | Picklist | |
xx_IRIS_Section__c | Picklist | |
xx_IRIS_Primary_Impact_Category__c | Picklist | |
xx_IRIS_Impact_Category_Themes__c | Picklist (Multi-Select) | |
xx_IRIS_Sub_Section__c | Picklist | |
xx_IRIS_Cross_Category__c | Checkbox | |
xx_IRIS_Social_Environmental_Focus__c | Picklist (Multi-Select) | |
xx_IRIS_Related_SDGs__c: Multi-Select Picklist | Picklist (Multi-Select) | |
xx_IRIS_Dimensions_Imapct__c | Picklist (Multi-Select) | |
xx_IRIS_Stakeholders__c | Picklist (Multi-Select) | |
xx_IRIS_Operational_Impact__c | Picklist (Multi-Select) | |
xx_IRIS_Investment_Lens__c | Picklist (Multi-Select) | |
xx_IRIS_Reporting_Format__c | Picklist | |
xx_IRIS_Financials__c | Picklist (Multi-Select) | |
xx_IRIS_Indicator_Definition__c | Long Text Area (5800) | |
xx_IRIS_Guidelines__c | Long Text Area(4200) | |
ampi__Project_Indicator__c | xx_IRIS_Indicator_Definition__c | Long Text Area (5800) |
xx_IRIS_Guidelines__c | Long Text Area(4000) |
The following are also added when the plugin is installed:
“IRIS Full Access” permission set
Provides full access to Indicator object
Provides Read/Edit access to all the new fields
“Indicators with IRIS Categories” list view on ampi__Indicator__c
“IRIS Indicators with Project Indicators with Result” report type
Add IRIS Plugin Fields to Page Layouts
Once the plugin is installed, new IRIS-specific fields will need to be added to the page layouts of ampi__Indicator__c and ampi__Project_Indicator__c objects. You can add these fields to the relevant page layouts, for example, the Indicator layout by:
From the “Page Layouts” section, navigate to the relevant page layout (Indicator Object, in this example).
Selecting and adding the relevant new IRIS fields to the layout.
Add the IRIS Fields On Project Indicator Object To Relevant Field Sets
Since the Indicator Definitions of IRIS Indicators are not descriptive enough and the “Guidelines” field on the ampi__Project_Indicator__c has a character limit of 255 characters, there are now two new fields, “IRIS Indicator Definition” and “IRIS Guidelines’” on the ampi__Project_Indicator__c object.
The “IRIS Indicator Definition” and “IRIS Guidelines” fields can be added to the info popovers that appear next to every Project Indicator on the SetTargets and AddResults Visualforce pages. This will provide users with more information and context about the values that they would need to enter. The following steps can be executed to achieve this:
Navigate to the “Field Sets” section on the relevant object (Project Indicator in this example).
Click on the relevant field set (Set Targets Info Popover for the SetTargets VF component and Add Results Info Popover for the AddResults VF component).
Add the IRIS Indicator Definition field to the “In the Field Set” section.
After adding these fields to the field set, the fields would be available when you hover over the info icon that appears next to every indicator listed on the SetTargets and AddResults VF and LWC components:
User Access & Permissions
Access to the IRIS fields configured on the objects Indicator object (ampi__Indicator__c) and Project Indicator (ampi__Project_Indicator__c) can be provided through the “IRIS Full Access” permission set.
You can assign the permission set to a single user or to multiple users based on your organization’s requirements. To further customize the kind of access to IRIS fields, you can choose to clone the “IRIS Full Access” permission set to create a new permission set and modify field permissions.
Setup Automation To Copy Field Values From Catalog Indicators To Project Indicators
Activate New Process “Copy Indicator Field Values Onto Project Indicator With IRIS Fields”
Within the IRIS plugin, a new process “Copy Indicator Field Values Onto Project Indicator With IRIS Fields” is configured in such a way that when a Project Indicator is created as child to a Catalog Indicator, the value of the fields “IRIS Indicator Definition” and “IRIS Guidelines” on the ampi__Project_Indicator__c object is copied from the values of the fields “IRIS Indicator Definition” and “IRIS Guidelines” on the ampi__Indicator__c object. This process is an enhanced version of another process “Copy Indicator Field Values Onto Project Indicator” that already exists in Amp Impact.
If you were using the process “Copy Indicator Field Values Onto Project Indicator” without making any customizations, then you can activate the new “Copy Indicator Field Values Onto Project Indicator With IRIS Fields” process by following the steps mentioned in this article. Note that you would have to deactivate the process “Copy Indicator Field Values Onto Project Indicator” before activating the new process.
Depending on the current version of Amp Impact that is installed into the environment, the active process “Copy Indicator Field Values Onto Project Indicator With IRIS Fields” would also have to be modified in the following ways:
Change | Version |
The Action “Copy Indicator field values into Project Indicators fields” would have to be updated to include a new field value update for the field ‘Number of Decimal Places Allowed’ with the formula: “IF(TEXT([ampi__Project_Indicator__c].ampi__Number_of_Decimals_Places_Allowed__c) == '0', TEXT([ampi__Project_Indicator__c].ampi__Catalog_Indicator__r.ampi__Number_Of_Decimal_Places_Allowed__c), TEXT([ampi__Project_Indicator__c].ampi__Number_of_Decimals_Places_Allowed__c))” | 1.26.3 and up |
The Criteria “Project Indicator is created with Catalog Indicator” would have to be updated to include a Condition: Field = [ampi__Project_Indicator__c].ampi__xx_Is_Copy__c Operator = Equals Type = Boolean Value = False | 1.28 and up |
Please find below relevant screenshots for the changes mentioned in the table above:
Update the Existing Process
If you are using a process that was customized after cloning the default Amp Impact process “Copy Indicator Field Values Onto Project Indicator” then it is recommended to edit this process instead of activating the new process. Alternatively, if you are on Amp Impact version 1.28 or higher and you use the process “Copy Indicator Field Values Onto Project Indicator” without any customizations, you can clone the existing process “Copy Indicator Field Values Onto Project Indicator” and make the edit. In both cases, the process can be updated with the section highlighted in the screenshot below. These line items ensure that the value of the “IRIS Indicator Definition” and “IRIS Guidelines” fields on the ampi__Indicator__c object is copied to the “IRIS Indicator Definition” and “IRIS Guidelines” fields on the ampi__Project_Indicator__c object.
Upload IRIS Objectives and Indicators
Download the IRIS catalog Excel file.
Customize the tabs ampi__Indicator__c (Metrics), ampi__Indicator__c (Submetrics), and ampi__Project_Indicator_Objective__c as needed by your organization (i.e. add reporting frequency, geographical disaggregation, currency codes, et al.). The first two sheets (tabs) are meant to be uploaded into the ampi__Indicator__c object in two rounds, one after the other, and the third sheet is optional. The default values and potential customizations for certain fields in the first two tabs are listed below:
Indicator Library: The default value is kept as IRIS for all the IRIS indicators.
Data Type: The value is based on the type of Indicator. The plugin currently does not support the data types “Picklist” and “Multi Select Picklist”. Even though we have currently kept these data types on the IRIS catalog, if you would like to keep track of these indicators in Amp Impact, please replace these values in the “Data Type” column with “Qualitative”.
Geographical Disaggregation: The default value is kept as blank for all the IRIS indicators (metrics and submetrics). Set the Geographic Disaggregation based on locations for which your organization tracks target and result data.
Reporting Frequency: The default value is kept as blank for all the IRIS indicators (metrics and submetrics). Set the Reporting Frequency level for the indicators based on how frequently your organization tracks target and result data.
Reporting Currency: The default value is blank for all the IRIS indicators (metrics and submetrics). Set the value for Currency indicator with the relevant currency code. The currency code can be selected from the data validation picklist.
Units: The default value is kept as blank for all the IRIS indicators and can be customized based on your organization's requirement.
Include in Catalog?: The default value is kept as TRUE for all the IRIS indicators (metrics and submetrics).
Type of Results: The default value is kept as “Input” for all indicators. However, calculation formulas for certain indicators have been mentioned in the column “IRIS Calculation”. The “Type of Results” column value for these indicators can be changed to “Calculated” and a calculation formula can be defined in Amp Impact to automatically calculate the values of these indicators based on the value of other indicators. Visit this page for more details about Indicator types.
Cross-Disaggregation by Sex: The default value is kept as blank for all the IRIS indicators (metrics and submetrics). Set the Geographic Disaggregation level for indicators depending on which geographic level your organization tracks target and result data.
Upload IRIS indicators using the by following the instructions provided on the “Instructions” tab within the IRIS catalog.