Page Comparison

...

Related Pages:

• 📝 International Aid Transparency Initiative (IATI) Publishing - Data Entry & Management

• 💡 IATI Publishing: Key Relationships

...

Overview of IATI Publishing with Amp Impact

IATI Publishing in Amp Impact allows organisations to take its impact and transaction data in Amp Impact, generate an IATI standard XML file. In this setup guide, system administrators and implementing consultants will learn to:

...

we’ll cover the five steps to set up IATI Publishing in Amp Impact:

...

Set up the environment for entry of IATI data

...

Modify Amp Impact default interfaces to include IATI-specific information

After following this guide, a Salesforce environment will be set up so that it can automatically take its impact and transaction data, entered through Amp Impact, and print out an IATI standard XML file with that data. Clients can take that XML and publish it directly to the IATI registry.

Terminology

...

...

IATI Terminology Overview

Before we get into the weeds, let’s align on a couple of IATI-specific terms.

...

...

...

...

...

...

...

...

IATI

...

Field

...

& Object

...

Permission Configuration

IATI field- and object-level access is not assigned out-of-the-box for all Amp Usersand there are a few configuration steps to ensure that the right users have the access and permissions they need to manage the IATI publishing process.

Assign IATI Permission Set to IATI Users

After installing Amp Impact and enabling the IATI feature, follow these steps to ensure your IATI Users have access to all IATI objects and fields. Amp Impact comes with the “IATI Full Access” permission set that can be assigned to users that need access to all the related IATI fields and object. To assign this permission set, first enable the IATI feature and then follow these steps to assign the permission set:

1. Go to the Setup Quick Search box, and enter “Permission Sets”.

2. Select the “IATI Full Access” Permission Set.

   Image Modified

...

1. Click the

...

1. “Manage Assignments” button.

...

1. Click the

...

1. “Add Assignments” button.

...

1. Select all relevant users that should have access to the IATI Full Access Permission Set and click “Assign”.

If an IATI User does not need access to all IATI objects and fields, the IATI_Full_Access permission set can be cloned, and object/field permissions that are not necessary can be removed from the cloned permission set.

...

Due to a Salesforce limitation on packaging permissions for objects that are detail in a master-detail relationship to standard Salesforce objects, the permissions for two objects ‒ object- and field-level permission for ampi__Organization_Role__c and ampi__Project_Role__c ‒ and their fields must be added manually to either the user profile or a custom permission set, depending on the environment and use case. assigned manually. There are two options for adding permissions to these objects:

1. Manually add these objects and fields to the relevant profiles;

2. [Recommended] Create a customer permission set to provide access to these objects and fields and assign this to the relevant users.

Below is the list of objects/fields for which permissions must be manually set:

Enable

...

“Customize Application” Permission for Direct Read Access to Custom Metadata Types

The Customize Application “Customize Application” Permission is required for direct read access to Custom Metadata Types. This follows Salesforce’s rollout of the “secure by default” approach. For more information on its use in Amp Impact, see Set Defaults for IATI XMLs.

To grant a profile or permission set read access to a custom metadata type:

1. Go to the profile or permission set that you want to grant access to.

2. Under Enabled “Enabled Custom Metadata Type AccessAccess”, click Edit, as shown in the screenshot below.

   Image Modified

...

1. Add the custom metadata type, “ampi.IATI Default

...

1. Contact” and

...

1. “ampi.IATI Default Reporting

...

1. Org”, to the list of Enabled Custom Metadata Types.

...

1. Image Modified

To re-enable read access to custom metadata outside of Apex code or system mode contexts, see the following steps:

1. In Setup, navigate to Schema Settings“Schema Settings”.

2. Deselect Restrict “Restrict access to custom metadata types”.

...

1. Image Added

...

Enable XML Generation from Accounts

Account is the central object from which both the IATI Organisation and IATI Activity XMLs will be generated. In order to generate the XML files, some setup is required on the Account page layout to enable Users to generate their IATI files.

Create/Customize Flow from Template

...

If the Screen Flow must be customized (e.g. text changed, filter options added), then this Flow can be cloned and modified for those customizations. 

Customize Flow Filters (Activity Standard

...

Only)

This step is only required if the filters for the Activity Standard XML in the Screen Flow need to be customized. In order to customize these filters, follow the steps below:

1. Go to Setup.

2. Type and select “Flows” in the QuickSearch menu.

3. Open the IATI_XML_Generation Flow in Flow Builder.

4. Modify the available filters in the Filter_IATI_Activities Screen element.

   Image Modified

...

1. Ensure that the filter criteria is reflected in the Filtered_IATI_Activities Get Records element.

   Image Modified

...

1. Click Save As.

...

1. In the Save screen, select to save as a New Flow.

   Image Modified

Create Lightning Action to Launch Custom Flow

...

1. Go to Setup.

2. Go to Object Manager.

3. In Object Manager, select Account.

4. Go to Buttons, Links, and Actions.

5. Click New Action to create a Flow Action, selecting the custom flow created. The Label and Name can be filled out per the use case.

   Image Modified

...

(Required) Add Lightning Quick Action to Account Record Page

...

1. Go to Setup.

2. Go to Object Manager.

3. In Object Manager, select Account.

4. Go to Page Layouts.

5. Click into the Page Layout that will be assigned to the Profile(s) of Users who will be generating XML files for IATI reporting.

6. In the top menu, select Mobile & Lightning Actions. From the options that appear, drag and drop Generate IATI XML into the page layout.

7. Click Save.

   Image Modified

...

Set Defaults for IATI XMLs

...

Update Page Layouts to Include IATI Fields and Related Lists

• The objects mentioned in the IATI Data Entry Mapping Sheet contain IATI-specific fields that can be printed into the generated XML file. 

• The fields in the IATI Data Entry Mapping Sheet need to be added into the respective page layouts so that values can be entered for IATI reporting.

• Apart from the fields, there are some related lists that need to be added to some of the Objects. These can be found in the table below. Please make sure these can be found on the object page.

Add or Override Help Text for IATI Reporting

To support users in entering data required for IATI reporting, help text on all IATI-specific fields has been added by default. For fields that are not IATI-specific, help text may be added or modified to provide additional context to users, as indicated in the table below:

Translate Amp Terminology to IATI Terminology

...

Amp Impact and IATI use different terminology to describe different artifacts in M&E. The table below provides the default labels of objects and fields in Amp Impact, and their corresponding IATI term. Using Translation Workbench, organisations can override the default Amp labels with IATI terminology.

Add IATI Fields to Field Sets

To facilitate IATI data entry through Amp Impact, certain field sets can be modified to include IATI fields for population. Those field sets are listed below:

Picklist Limitation for IATI Reporting

Due to the codes generated and printed into the IATI XML files by populating picklist fields, there is a limitation around customizing any of these fields. For any picklist field used for IATI reporting, the picklist values can only be edited in the Label and not in the API Name in order for the corresponding code to print correctly. 

Find below the list of picklist fields used in IATI reporting with this limitation:

...

Set Up Named Credential for IATI XML Validation

...

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

...

1. Image AddedImage Modified

...

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

...

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

...

1. Click the Subscribe Button.

...

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

   Image Modified

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

   Image Modified

...

1. Fill in the following details and click Save.

...

1. 1. Label: IATI VALIDATOR EXTERNAL CREDS

...

1. 1. Name: IATI_VALIDATOR_EXTERNAL_CREDS

...

1. 1. Authentication Protocol: Custom

   Image Modified

...

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

...

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

   Image Modified

...

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

   Image Modified

...

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

   1. Label: IATI VALIDATOR

   2. Name: IATI_VALIDATOR

   3. URL: https://api.iatistandard.org

   4. External Credential: IATI VALIDATOR EXTERNAL CREDS

   5. Allowed Namespaces: ampi

      Image Modified

...

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

   Image Modified

...