Indus (v1.31) | Upgrade Instructions | December 2022

Upgrading Amp Impact to Indus - v1.31

1. To upgrade to the latest release of Amp Impact, log into your Sandbox environment and use the installation link.

   1. Vera Employees can navigate to this page to access the link.

   2. Partners & customers, please get in touch with your Vera point of contact to access the link.

2. Information will be displayed confirming that you have an earlier version installed and it can be upgraded while preserving existing data. 

3. Select which users you wish to install the package for (learn more here). 

4. Click "Upgrade".

5. Refer to the release notes document and learn about the new features and bug fixes for this release. 

6. After reviewing the release notes, follow the steps outlined below. 

7. Perform your current use cases in the sandbox and if you are using any of the new features from this release, ensure that they are operating as expected.

8. When you are ready to deploy to Production, use this installation link.

9. Update any changes you make, for example to custom settings, in Production as these will not "carry over" from your sandbox. 

Packaging Changes

Certain changes to the configuration will be automatically updated on installation of the upgrade, while others will need to be manually updated (in order not to conflict with any org-specific customization). For full details on what Salesforce supports when upgrading managed packages, refer to the Editing Components and Attributes After Installation and Special Behavior of Components in Packages pages.

Update Profiles and Custom Permission Sets for New Objects and Fields

While permission sets in the package are automatically updated to provide access to these new fields (New field ampi__xx_Has_Baseline__c on object ampi__Indicator__c), profiles and custom permission sets must be manually updated to include these new artifacts if the relevant user(s) requires access to them. Refer to the Packaging Changes section in the release notes to determine which objects and fields need to be added to any custom profiles or permission sets. 

Update the Indicator Object to use Picklist Indicators and Read Only Results

Salesforce does not support the update of picklist values in a field while upgrading a managed package. This needs to be manually done in order to use the new functionality. When upgrading to Indus, you need to make the following updates to the ampi__Indicator__c object:

1. Add ‘Picklist’ picklist value within the Data Type (ampi__Data_Type__c) field

2. Add ‘Read Only’ picklist value within Type of Results (ampi__Type_of_Results__c) field

Please follow the steps mentioned below to complete the setup of the Indicator object.

Add “Picklist” picklist value within the Data Type Field

You can add ‘Picklist’ as a picklist value within the Data Type (ampi__Data_Type__c)  field by following the steps mentioned below:

1. Navigate to Salesforce Settings

2. Click on Object Manager 

3. Search for and click on the Indicator object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Data Type field (ampi__Data_Type__c)

   Open

   

6. Navigate to the Values section and click on New 

   Open

   

7. Type ‘Picklist’ in the input text box field. 

8. Click on Save.

Add “Read Only” picklist value within Type of Results Field

You can add the ‘Read Only’’ picklist value within the Type of Results (ampi__Type_of_Results__c)  field by following the steps mentioned below:

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Indicator object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Type Of Results field (ampi__Type_of_Results__c) 

6. Navigate to the Values section and click on New 

7. Type ‘Read Only’ in the input text box field. 

8. Click on Save

Update the Project Indicator Object to use Read Only Results

Salesforce does not support the update of picklist values in a field while upgrading a managed package. This needs to be manually done in order to use the new functionality. When upgrading to Indus, you need to make the following updates to the ampi__Project_Indicator__c object:

1. Add ‘Read Only’ picklist value within the Type of Results (ampi__Type_of_Results__c) field. 

Add ‘Read Only’ option to Type of Results field 

This step is required in order to use the Read Only Type of Result on the Project Indicator Object. You can add the ‘Read Only’’ option within the Type of Results (ampi__Type_of_Results__c)  field by following the steps mentioned below:

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Project Indicator object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Type Of Results field (ampi__Type_of_Results__c) 

6. Navigate to the Values section and click on New 

7. Type ‘Read Only’ in the input text box field. 

8. Click on Save

Update the Result Object to use the Baseline functionality

Salesforce does not support the update of picklist values in a field while upgrading a managed package. This needs to be manually done in order to use the new functionality. When upgrading to Indus, you need to make the following updates to the < > object:

1. Add ‘Baseline’ picklist value within the  Data Tracked (ampi__Data_Tracked__c)  field

2. Edit the label for ‘Both’ picklist value within the Data Tracked (ampi__Data_Tracked__c) field 

Add ‘Baseline’ picklist value to Data Tracked picklist field on Result Object 

This step is required in order to use the Indicator Baseline functionality. You can add the ‘Baseline’ option within the  Data Tracked (ampi__Data_Tracked__c) field by following the steps mentioned below:

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Result object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Data Tracked field (ampi__Data_Tracked__c) 

6. Navigate to the Values section and click on New 

7. Type ‘Baseline’ in the input text box field. 

8. Click on Save. 

Edit the label for ‘Both’ picklist value within the Data Tracked field 

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Result object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Data Tracked field (ampi__Data_Tracked__c) 

6. Navigate to the Values section and click on Edit next to the ‘Both’ value

7. Change the Label to ‘Target and Result’ 

8. Click ‘Save’

Update the Project Indicator Reporting Period Object to use the Baseline functionality

Salesforce does not support the update of picklist values in a field while upgrading a managed package. This needs to be manually done in order to use the new functionality. When upgrading to Indus, you need to make the following updates to the ampi__Project_Indicator_Reporting_Period__c object:

1. Add ‘Baseline’ picklist value within the  Data Tracked (ampi__Data_Tracked__c)  field

2. Edit the label for ‘Both’ picklist value within the Data Tracked (ampi__Data_Tracked__c) field 

Add ‘Baseline’ picklist value to Data Tracked picklist field on Project Indicator Reporting Period Object 

This step is required in order to use the Indicator Baseline functionality. You can add the ‘Baseline’ option within the  Data Tracked (ampi__Data_Tracked__c) field by following the steps mentioned below:

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Project Indicator Reporting Period object 

4. Click on the Fields & Relationships tab 

5. Search and click on the Data Tracked field (ampi__Data_Tracked__c) 

6. Navigate to the Values section and click on New 

7. Type ‘Baseline’ in the input text box field. 

8. Click on Save. 

Edit the label for ‘Both’ picklist value within the Data Tracked field 

1. Navigate to Salesforce Settings 

2. Click on Object Manager

3. Search for and click on the Project Indicator Reporting Period object 

4.  Click on the Fields & Relationships tab 

5. Search and click on the Data Tracked field (ampi__Data_Tracked__c) 

6. Navigate to the Values section and click on Edit next to the ‘Both’ value

7. Change the Label to ‘Target and Result’ 

8. Click ‘Save’

Add Translations for New Values

After following the previous steps and updating the concerned objects to use the new functionality, you can also leverage Salesforce’s translation feature by adding translations for each picklist value or field label. Please refer to this document to learn how to add or update translations for the Picklist Values and Field Labels referred to earlier.

Update Custom Settings

Disable Geographic Area  Hierarchy in the dropdown on Set Targets and Add Results Visualforce pages 

A new field Disable Geographic Area Hierarchy (ampi__Disable_Geographic_Area_Hierarchy__c) has been created within the Custom Setting for Set Targets (ampi__SetTargets__c). This field controls the display of geographic areas in the dropdown on Set Targets and Add Results Visualforce pages and allows users to toggle the structure of Geographic Areas between hierarchical and non-hierarchical. 

By default, Geographic Areas will be displayed hierarchically in the dropdown on Set Targets and Add Results. To disable the hierarchy in the dropdown, follow the steps:

1. Navigate to Salesforce Settings 

2. Search for and click on Custom Settings 

3. Under the Label column, click on Set Targets (ampi__SetTargets__c)

4. Click on Manage at the top of the page 

5. Click on Edit at the top of the page 

6. Check the box next to Disable Geographic Area Hierarchy 

Update the Reporting Period Object

Page layout changes made to the ampi__Reporting_Period__c object will not be reflected when you upgrade to Indus. This is to ensure that any customizations made by users are not overridden. In order to meet the modifications made to the Reporting Period lightning record page, you need to modify the Reporting Period page layout assignments. 

Update Page Layout for the Reporting Period Object

1. Navigate to Salesforce settings

2. Click on Object Manager

3. Search for and click on the Reporting Period Object 

4. Click on the Page Layouts tab

5. Click on the Page Layouts Assignment button 

6. Click on the Edit Assignment button 

7. Click on the Baseline column. It will turn purple to indicate it has been selected

8. Click on the Page Layout to Use picklist and select Baseline Layout 

9. Click on Save 

Update Field Help Text for IATI Reporting

Help text has been updated for several IATI-related fields on the objects mentioned below in order to support the end user entering data for IATI reporting. These are not automatically updated. Refer to this sheet to access the fields and the suggested help text. 

1. Budget__c                                             9.  Organization_Role__c

2. Project_IATI_Sector__c                     10. IATI_Policy__c

3. Project__c                                           11. Project_Indicator__c     

4. Account                                               12. Objective__c

5. Disbursement__c                               13. Project_IATI_Policy__c

6. IATI_Sector__c                                    14.  ContentVersion

7. Project_Geographic_Area__c            15. Allocation__c     

8. Financial__c

Update Field Sets

In this release, we have added new fields to certain field sets, as mentioned in the table given below. The new field is placed at the end of the upgraded field set in whichever column it was added to. Fields can also be added/removed/re-ordered based on the organization’s preferences. 

Add Set Targets and Add Results Lightning Web Components to the Project Lightning Page

To preserve existing functionality on the Project Lightning Record Page, the new Lightning Web Components (setTargets and addResults) have not been immediately added to the page. If your organization wishes to switch to this new interface (Please refer to User Guide) follow the below steps:

1. Create a clone of the Project Lightning Record Page.

2. In Lightning App Builder, click on the tabs to open up the Tab component editor on the right-hand pane.

3. Remove the Visualforce pages from the respective tabs:

   1. SetTargets Visualforce page from the “Targets“ tab 

   2. AddResults Visualforce page from the “Results“ tab 

4. On the left-hand pane, scroll down to Custom-Managed Components.

5. Drag each Lightning Web Component from the pane and drop it into the respective tabs:

   1. setTargets Lightning Web Component into the “Targets“ tab 

   2. addResults Lightning Web Component into the “Results“ tab 

6. Click “Save”.

7. Click “Activation” and activate the Lightning Record Page according to your organization’s use case.

Start Using Amp Impact in Spanish

Amp Impact now contains Spanish (language code “es”) translations for many of its features. To start using Amp Impact in Spanish, Translation Workbench must be enabled and Spanish must be activated. If these are not already in place, follow the steps below:

1. Open Setup and go to Translation Settings.

2. Click Enable.

3. Click Add in the Supported Languages menu.

4. Select Spanish and leave Active as checked.

5. (Optional) Add a translator for the language.

6. Click Save.

To set Spanish as the default language for all users in the org:

1. Open Setup and go to Company Information.

2. Click Edit.

3. Set Default Language as Spanish. 

4. Click Save.

To set Spanish as the default language for a specific user:

1. Open Setup and go to Users.

2. Click Edit next to the User who will be using Amp in Spanish.

3. Set Language to Spanish.

4. Click Save.

Set Up Named Credential for IATI XML Validation

In order to validate the IATI Organisation or Activity XML while it is being generated, a Named Credential record will need to be created in order to connect an Amp Impact environment with the IATI Validator. Before you can create this, you will first need to obtain an IATI Gateway API Key.

Create IATI Gateway API Keys

1. Navigate to https://developer.iatistandard.org

2. Click “Sign Up”.

3. Follow the sign up process and confirm your account from an email link.

4. Sign In to the API Gateway developer portal (same URL as above).

5. Click Subscriptions > “Exploratory”/“Full Access” (as per requirement).

6. Enter a Subscription Name (this can be anything you want) in the box.

7. Check the box to agree to the Terms of Use.

8. Click the Subscribe Button.

9. Copy your Primary or Secondary Key from your Profile on the API Gateway webpage.

Create Named Credential Record in Salesforce

With the primary and secondary keys copied from the previous section, you are now ready to create a Named Credential record to connect Salesforce and Amp Impact to the IATI Public Validator.

1. Go to setup and search for “Named Credentials”.

2. Click on “External Credentials” and then click on “New”.

3. Fill in the following details and click Save.

   1. Label: IATI VALIDATOR EXTERNAL CREDS

   2. Name: IATI_VALIDATOR_EXTERNAL_CREDS

   3. Authentication Protocol: Custom

4. Create a Permission Set Mapping for the External Credential. This Permission Set Mapping will help to authorize users such that users assigned to this permission set will only be allowed to utilize a specific OcpApimSubscriptionKey provided by the IATI. 

5. Input the OcpApimSubscriptionKey (Primary or Secondary Key) provided by the API Gateway in the value field of Parameter 1 and click Save.

6. Create a custom header with the following inputs. 

   1. Name: Ocp-Apim-Subscription-Key

   2. {!$Credential.IATI_VALIDATOR_EXTERNAL_CREDS.OcpApimSubscriptionKey}

   3. Sequence Number: 1

7. Now, create a Named Credential, with the following parameters.

8. Create a new custom header within the Named Credential with the following parameters:

1. Name: Content-Type

2. Value: text/plain

3. Sequence Number: 1