Versions Compared

Old Version 2

changes.mady.by.user Jane Chapola

Saved on

compared with

New Version 3

changes.mady.by.user Jane Chapola

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Update Page Layouts to Include IATI Fields and Related Lists

Info

Admin Note:  

This step is optional, depending on the reporting requirements and business processes of an organisation. Only fields that are required for IATI reporting should be added to the respective page layouts.

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

Object (API Name)

Related Lists (Child Object API Name)

Account

  • Contact

  • Account

  • ampi__Objective__c

ampi__Allocation__c

  • ampi__Transaction_Project_IATI_Sector__c

ampi__Budget__c

  • ampi__Transaction_Project_IATI_Sector__c

  • ampi__Financial__c

ampi__Disbursement__c

  • ampi__Transaction_Project_IATI_Sector__c

ampi__Project__c

  • ampi__Geographical_Area__c

  • ampi__Reporting_Period__c

  • ampi__xx_Framework__c

  • ampi__Implementation_Plan__c

  • ampi__Thematic_Area__c

  • ampi__Organization_Role__c

  • ampi__Project_Role__c

  • ampi__Catalog_Objective__c

  • ampi__Project_IATI_Policy__c

  • ampi__Project_IATI_Sector__c

ampi__Project_Indicator__c

  • ampi__Project_Indicator_Reporting_Period__c

  • ampi__Project_Indicator_Geographic_Area__c

  • ampi__Project_Indicator_Thematic_Area__c

  • ampi__Disaggregated_Project_Indicator__c

  • ampi__Result__c

  • ampi__Risk__c

  • tag__Tag_Settings__c

ampi__Organization_Role__c

  • ampi__Allocation__c

  • ampi__Budget__c

  • ampi__Disbursement__c

Add or Override Help Text for IATI Reporting

Info

 Admin Note:  

This step is optional, depending on the business processes that are being enforced or facilitated on Amp Impact. Help text can also be further modified from the default values to better capture an organisation’s processes.

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:

Object (API Name)

Field (API Name)

Suggested Help Text

ampi__Allocation__c

ampi__Internal_Code__c

Enter the internal reference linking this transaction back to the publisher’s financial management system.

ampi__Disbursement__c

ampi__Internal_Code__c

Enter the internal reference linking this transaction back to the publisher’s financial management system.

ampi__Disbursement__c

ampi__Status__c

Enter to capture the status of disbursement. If Status = Paid, this transaction will be printed as Incoming Funds (transaction type 1). If Status is not equal to1, this transaction is printed as a Planned Disbursement.

ampi__Financial__c

ampi__Internal_Code__c

Enter the internal reference linking this transaction back to the publisher’s financial management system.

ampi__Project__c

ampi__Description__c

Description type 1: Unstructured, long description of the activity. 

Translate Amp Terminology to IATI Terminology

Info

Admin Note:  

This step is optional, depending on the business processes that are being enforced or facilitated on Amp Impact.

Override Amp Labels with IATI Terms

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.

API Name

Amp Impact Label

Type of Artifact

IATI Term

ampi__Project__c

Project

Object label

Activity

ampi__Catalog_Objective__c

Objective

Object label

Result

ampi__Result__c

Result

Object label

Actual

ampi__Organization_Role__c.ampi__Project__c

Project

Field label

IATI Receiving Activity

ampi__Organization_Role__c.ampi__IATI_Providing_Project__c

IATI Providing Project

Field label

IATI Providing Activity

Account

Account

Object label

Organisation

ampi__Indicator__c.ampi__Data_Type__c

Data Type

Field label

Measure

ampi__Project_Indicator__c.ampi__Data_Type__c

Data Type

Field label

Measure

ampi__Disaggregation_Group__c

Disaggregation Group

Object label

Dimension

ampi__Disaggregation_Value__c

Disaggregation Value

Object label

Dimension Value

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:

Object

Field Set Name

Functionality

ampi__Catalog_Objective__c

ADD_NEW_OBJECTIVE_POPUP

Add New Framework Item popup on ManageLogframes

ampi__Disbursement__c

ADD_EDIT_POPUP

Add New Disbursement and Edit Disbursement popups on ManageDisbursements

DISBURSEMENT_TABLE

Table columns on ManageDisbursements

ampi__Financial__c

BUDGET_EXCEL_COLUMNS

Columns in Excel spreadsheet downloaded from ampi__Budget__c

REPORT_EXCEL_COLUMNS

Columns in Excel spreadsheet downloaded from ampi__Reporting_Period__c

ampi__Indicator__c

CATALOG_INDICATORS_TABLE

Columns in Indicator Catalog on ManageIndicators

INDICATOR_CATALOG_SEARCH_FILTER

Search filters in the Indicator Catalog on ManageIndicators

ampi__Objective__c

EDIT_PROJECT_OBJECTIVE

Edit Framework Item popup on ManageLogframes

LOG_FRAMES_TABLE

Table columns on ManageLogframes

ampi__Project__c

PROJECT_SUMMARY

Summary header on ManageDisbursements

ampi__Project_Indicator__c

ADD_RESULTS_INFO_POPOVER

Hover popover on AddResults

AR_SEARCH_FILTERS

Search filters on AddResults

DEACTIVATED_PROJECT_INDICATORS_TABLE

Columns in Deactivated Project Indicators table on ManageIndicators

EDIT_PROJECT_INDICATOR_POPUP

Edit Project Indicator popup on ManageIndicators

PROJECT_INDICATORS_SEARCH_FILTERS

Search filters in Selected Project Indicators and Deactivated Project Indicators tabs on ManageIndicators

SELECTED_PROJECT_INDICATORS_TABLE

Columns in Selected Project Indicators table on ManageIndicators

SET_TARGETS_INFO_POPOVER

Hover popover on AddResults

ST_SEARCH_FILTERS

Search filters on SetTargets

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. 

Info

Admin Note:  

If a picklist value’s API Name has been edited from its original value, then the corresponding code will not print into the XML file, which then may cause issues when validating the XML using the IATI public validator.

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

Object

Field

Account

ampi__IATI_Organization_Type__c

ampi__Allocation__c

ampi__IATI_Aid_Type__c

ampi__IATI_Aid_Type_Vocabulary__c

ampi__IATI_Disbursement_Channel__c`

ampi__IATI_Finance_Type__c

ampi__IATI_Flow_Type__c

ampi__IATI_Tied_Status__c

ampi__Budget__c

ampi__IATI_Budget_Status__c

ampi__IATI_Vocabulary__c

ampi__Disbursement__c

ampi__IATI_Aid_Type__c

ampi__IATI_Aid_Type_Vocabulary__c

ampi__IATI_Disbursement_Channel__c

ampi__IATI_Finance_Type__c

ampi__IATI_Flow_Type__c

ampi__IATI_Tied_Status__c

ampi__Status__c

ampi__Financial__c

ampi__IATI_Aid_Type__c

ampi__IATI_Aid_Type_Vocabulary__c

ampi__IATI_Disbursement_Channel__c

ampi__IATI_Finance_Type__c

ampi__IATI_Flow_Type__c

ampi__IATI_Tied_Status__c

ampi__IATI_Policy__c

ampi__Policy_Marker__c

ampi__Policy_Significance__c

ampi__Vocabulary_Code__c

ampi__Indicator__c

ampi__Aim__c

ampi__Objective__c

ampi__IATI_Vocabulary__c

ampi__Level__c

ampi__Organization_Role__c

ampi__Role__c

ampi__Project__c

ampi__IATI_Activity_Scope__c

ampi__IATI_Aid_Type__c

ampi__IATI_Aid_Type_Vocabulary__c

ampi__IATI_Budget_Not_Provided_Reason__c

ampi__IATI_Collaboration_Type__c

ampi__IATI_Condition_Type__c

ampi__IATI_Finance_Type__c

ampi__IATI_Flow_Type__c

ampi__IATI_Humanitarian_Scope__c

ampi__IATI_Humanitarian_Scope_Vocabulary__c

ampi__IATI_Project_Status__c

ampi__IATI_Tied_Status__c

ampi__Project_Geographic_Area__c

ampi__IATI_Exactness__c

ampi__IATI_Feature_Designation__c

ampi__IATI_Geographic_Vocabulary__c

ampi__IATI_Location_Class__c

ampi__IATI_Location_Reach__c

ampi__IATI_Region_Vocabulary__c

ampi__Project_Indicator__c

ampi__Calculate_Total__c

ampi__Data_Type__c

ampi__Project_Role__c

ampi__IATI_Contact_Type__c

ContentVersion

ampi__IATI_Document_Category__c

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.

a. Label: IATI VALIDATOR EXTERNAL CREDS

b. Name: IATI_VALIDATOR_EXTERNAL_CREDS

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

  • Name: Ocp-Apim-Subscription-Key

  • {!$Credential.IATI_VALIDATOR_EXTERNAL_CREDS.OcpApimSubscriptionKey}

  • Sequence Number: 1

...

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

  • Label: IATI VALIDATOR

  • Name: IATI_VALIDATOR

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

  • External Credential: IATI VALIDATOR EXTERNAL CREDS

  • Allowed Namespaces: ampi

...

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

  • Name: Content-Type

  • Value: text/plain

  • Sequence Number: 1

...

Info

Admin Note: 

Please note that custom label  IATI_VALIDATOR_NAMED_CREDS stores that API name of the Named Credential. If you want to use a different name for the Named Credential / External Credential than the one one provided above, please update the value of custom label IATI_VALIDATOR_NAMED_CREDS after configuring the Named Credential/External Credential with that name.