RSR_Partner IATI Codelist - adriancollier/demo GitHub Wiki

In order to effectively communicate between RSR and the IATI standard, we need to ensure that all the elements of both data structures can be uniquely identified.

The content of the RSR data structure has been adapted to include the IATI standard within its bounds; however there are additional pieces of data that we need to add to the IATI standard for identification.

While in IATI all information that is published to the registry is public and complete, within RSR and the workflow running up to publishing projects, this is not always the case. As a result we have instances where we need to communicate the content prior to this being fully published and public, so we have entered the publishing status as an attribute on the iati-activity node.

<iati-activity xml:lang="en" default-currency="EUR" last-updated-datetime="2014-09-10T07:15:37Z" linked-data-uri="http://www.aidstream.org/files/xml/akvo-activities.xml" hierarchy="1" akvo:publishing-status="published">

We store a Subtitle Field in RSR. This allows the project to contain a Title and Subtitle, with limits of 45 and 75 characters on each field as applicable. This field has been embedded as an attribute on the Title/Narrative node.

<title>
	<narrative akvo:subtitle="This is the subtitle">This is the project title</narrative>
</title>

The description field within IATI historically had 3 types giving publishers the opportunity to describe their activities in 3 distinct areas. With the release of 2.01, this has been expanded to 4 types, with the 4th type being "other".

We use many different text descriptions within RSR, and so we have expanded this type option with an additional Akvo Type that allows further information to be added.

Core fields The following table outlines the combinations of type identifiers for each of the description types available.

<description type="4" akvo:type="8">
	<narrative>Our aim is to provide an Android Application that is simple, intuitive and effective. The performance of this should be so great that we start having all users moving their updates to be created using the App.</narrative>
</description>

Project Updates Project updates are a vital part of the RSR content, providing a hugely valuable narrative on the activities being carried out over time.

We want to include the project updates within the content being delivered as we feel this provides a lot more contextual information. In order to do this effectively we have added several attribute tags to the description node where the Akvo type is 11.

update-id Used to provide the RSR identifier for the update

update-title Used to provide the title for the project update

update-created-at Gives the date the update was written

update-user-id Identifies the RSR user that made the updates

update-user Names the user that made the update

update-method Identifies the method being used to add the update, e.g. via Android or Web.

<description type="4" akvo:type="11" akvo:update-id="4896" akvo:update-title="Making an update" akvo:update-created-at="2014-03-18 0:0:0" akvo:update-user-id="410" akvo:update-user="Adrian Collier" akvo:update-method="Android">
	<narrative>After much work it was possible to make the update in time. This means that there is a project update present.</narrative>
</description>

Both RSR and IATI standard store more in depth information about an organisation aside from the core activity/project data structure. There is however some identifying information added to the relationship described that is extremely useful.

reporting-org-id This is used to enter an identifier that the reporting organisation uses to identify the organisation being referenced.

rsr-id This is where the RSR Identifier is referenced.

funding-amount In the event that the partner is a funding partner, then it's possible to include an amount that the partner has provided to the project/activity. We aim to phase this out with more detailed transaction information over time.

<participating-org ref="NL-KVK-41160054" role="1" type="21" akvo:reporting-org-id="27239" akvo:rsr-id="273" akvo:funding-amount="10000">
	<narrative>Cordaid</narrative>
</participating-org>

Most location information will be ported between the 2 data structures easily. We still need to do some more practical comparisons on the included data but this is expected to be a transformation only job.

However project updates can also have locations attached to them, and these instances it is important that we track which these are so we can reference them back again.

update-id Used to provide the RSR identifier for the update

<location ref="Project Update" akvo:update-id="4896">
	<administrative vocabulary="A4" level="1" code="KE" />
	<point srsName="http://www.opengis.net/def/crs/EPSG/0/4326">
		<pos>52.372329 4.908012</pos>
    </point>
</location>

RSR uses an additional codelist for confirming the types of budgets that are being entered. We will be looking into how we can move away from this structure in the longer term.

budget-type The RSR type of budget being described

<budget type="1">
	<period-start iso-date="2013-02-01" />
	<period-end iso-date="2014-04-01" />
	<value currency="EUR" value-date="2013-02-01" akvo:budget-type="13">50000</value>
</budget>

RSR makes use of the Document Link node within the IATI standard to reference a variety of external pieces of information.

As well as the traditional documents that a publisher may wish to add to their data set, RSR also created a document entry for images and videos added to the project either directly or through a project update.

update-id Used to provide the RSR identifier for the update

credit Used as an attribute on the title node to provide information about the source of the document, in particular who holds the usage rights.

Project Update Image:

<document-link format="image/jpeg" url="http://rsr.akvo.org/media/db/project/1576/update/4896/ProjectUpdate_4896_photo_2014-03-18_09.31.14_jpg_580x435_autocrop_sharpen_q85.jpg" akvo:update-id="4896">
	<title>
		<narrative akvo:credit="Credit">Project Update Image</narrative>
	</title>
	<category code="A02" />
	<language code="en" />
</document-link>

Project Update Video:

<document-link format="video/mpeg" url="http://youtu.be/_D21a-2PYtk" akvo:update-id="5787">
	<title>
		<narrative akvo:credit="Shelitha">Met a new friend, also a water lover! Enjoying the water out of the airco</narrative>
	</title>
	<category code="A02" />
	<language code="en" />
</document-link>