-
Notifications
You must be signed in to change notification settings - Fork 20
RSR_Partner API Write RAIN
We have implemented a synchronisation with the RAIN Foundation PMS to Akvo RSR.
https://www.dropbox.com/s/sel0javtsw9jyi9/RAIN%20process%20flow.jpg
As seen in the above diagram, the setup will include Akvo FLOW and RSR as well as also synchronising with the website of RAIN.
- Surveys will be created in FLOW to collect the project information from the field offices of RAIN.
- These will be loaded into the PMS.
- RAIN will further work on these projects, adding all the necessary information to the data set before finalising the Project to be publicised.
- RAIN will make an export file from their PMS available on https://data.rainfoundation.org/iati/.
- Akvo RSR will have a regular task setup to monitor the file location to check for any changes.
- Every week on Friday, RSR will pickup the new file containing all project and organisation information.
- Once all information has been correctly loaded via the API, RSR will deliver a set of log files to the necessary individuals to inform about any changes that have been made.
- If RSR faces any problems in processing the file, the process should be reversed, and an error notification sent to the necessary individuals for checking.
RAIN considers their IATI file as open data and allows for Akvo to import and publish all projects in their file. All projects will therefore be imported into RSR. However, due to data quality restrictions on Akvo's side, projects without an image or location will not be published.
All fields that are not part of the IATI schema should be placed within an Akvo namespace so that the file can be correctly read and analysed by both Akvo and IATI organisations. This is done by specifying xmlns:akvo="http://akvo.org/iati-activities" in the iati-activities element.
Every project should be assigned an IATI and Internal ID. Optionally, an RSR ID can be specified as well. In RSR, the IATI ID is stored on project level and the RAIN's Internal ID of the project will be stored on partnership level. When available, the RSR ID can be supplied as well in the other-identifier element with owner-name="akvorsr" and the RSR ID in the owner-ref tag. Matching of a project will be done based on these three elements. If, in addition to the IATI and Internal ID, the RSR ID is also specified, a check will take place to see if all IDs return the same RSR project. If no matching project is found or if multiple projects are found, the import for that activity will be aborted.
The Reporting Organisation of all projects in the RAIN IATI file will be set to RAIN.
The default currency and the hierarchy of the project, both specified in the iati-activity element, are retrieved from the RAIN IATI file and stored in RSR.
Besides the title element and first three description fields, there are many project description fields within RSR that are not part of IATI. These can be used by using the akvo:type for IATI Description fields. The type should be from the following:
Code Name Description
1 General Long description of the activity with no particular structure
2 Objectives Objectives for the activity, for example from a logical framework
3 Target Groups Statement of groups targeted to benefit from the activity
Akvo extensions:
4 Subtitle A subtitle with more information on the project
5 Summary A brief summary of the project
6 Background Relevant background information
7 Project Plan Detailed information about the project and plans for implementing: the what, how, who and when
8 Goal Overview Describe what the project hopes to accomplish
9 Current status Description of current phase of project
10 Sustainability Plans for sustaining/maintaining results after implementation is complete
The start and end dates (planned or actual) will be retrieved from the RAIN IATI file and stored in RSR, following the IATI standard.
Every Location should include at least the following attributes:
- Latitude
- Logitude
- Country A Location may also include additional fields. The IATI Location Type codes are listed where supported:
- City (PPLA, PPLA2, PPLC)
- State (PPL)
- Address 1
- Address 2 (ADM1, ADM2, FRM)
- Post Code
Projects without a location (or with the coordinates 0,0) will not be published.
The recipient country and region will be imported and stored in RSR. Thus far, RAIN has not specified recipient-region elements, but it is possible to do so following the IATI standard.
Each project being added should be accompanied by an image for the main project photo as an URL. Each image should be given a unique reference as the filename. The unique reference must be included within the project record in the document-link element with the tags:
- akvo:photo-id
- akvo:photo-credit
- url
Projects without an image will not be published.
All Organisations involved with projects need to be consistently referenced. If the IATI Organisation Id is known for all Organisations then this can be used. Alternatively, a unique reference number should be applied to all organisation with the tag internal-org-ref.
We support the IATI Organisation Type Codes:
Code Name
10 Government
15 Other Public Sector
21 International NGO
22 National NGO
23 Regional NGO
30 Public Private Partnership
40 Multilateral
60 Foundation
70 Private Sector
80 Academic, Training and Research
In case there are actual budgets (type 2) available with a value element, these are imported. If not, the type 1 budgets are imported from the RAIN IATI file, but only when they have a value element.
Sectors are retrieved from the RAIN IATI file and stored in RSR, following the IATI standard.
Contact information from the RAIN IATI file is retrieved and stored in RSR.
Results and indicators in the RAIN IATI file are being ignored for now.