As of the 1st of February 2015 this wiki has been deprecated.
This archive is now a read only site.
There is also a copy of the history that has been converted into a git repository at: https://github.com/IATI/IATI-Wiki-Archive.
Please do not rely on any of the information found here.

Changes Specification - Revision 1.02 details

Formal proposals under consultation can be found at:
http://support.iatistandard.org/forums/21131653-first-decimal-upgrade

This is a working document. As proposals are refined and finalised they will be prepared here. For discussion and comment please use the forum via the links provided.

Schema Changes

Linked Data Attribute

Required Change

This is a change to the iati-activities-schema.xsd.
It requires:

  1. The addition of a attribute to the the <iati-activities> element: iati-activities/@linked-data-default (0..1) - a URI path upon which an activity identifier can be appended to get a dereferenceable URI for any activity contained within a file.
  2. The addition of an attribute to the <iati-activity> element: iati-activity/@linked-data-uri (0..1) - a URI for a given activity (over-rides iati-activities/@linked-data-default if set)

A sample diff is shown below:

<xsd:element name="iati-activities">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">
        Top-level list of one or more IATI activity records.
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:choice minOccurs="0" maxOccurs="unbounded">
      <xsd:element ref="iati-activity"/>
      <xsd:any namespace="##other" processContents="lax"/>
    </xsd:choice>
    <xsd:attribute name="version" type="xsd:decimal" use="optional">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
            A number indicating the IATI specification version in use.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="generated-datetime" type="xsd:dateTime" use="optional">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
           A date/time stamp for when this file was generated.  This
            is not necessarily the last-updated date for the
            individual activity records in it.  Uses ISO 8601 date
            format, e.g. "2010-03-12T18:45:00+01:00".  Use of this
            attribute is highly recommended, to allow recipients to
            know when a file has been updated.
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
+    <xsd:attribute name="linked-data-default" type="xsd:string" use="optional">
+      <xsd:annotation>
+        <xsd:documentation xml:lang="en">
+           IATI publishers are not obliged to publish their own Linked Data. 
+           However, if a publisher chooses to publish linked data about their IATI activities then allowing them to declare where +           this data is published would support discovery of it, and any additional information they may choose to publish as +           Linked Data alongside it. 
+          
+           This attribute is URI path upon which an activity identifier can be appended to get a dereferenceable URI for any +           activity contained within a file.
+           
+           Where a publisher declares using one of these properties that authoritative linked data is accessible for an activity +           then consuming applications that are generating Linked Data from an IATI XML file should assert an owl:sameAs +           relationship to the relevant URI.        
+         </xsd:documentation>
+      </xsd:annotation>
+    </xsd:attribute>
    <xsd:anyAttribute processContents="lax" namespace="##other"/>
  </xsd:complexType>
</xsd:element>
<xsd:element name="iati-activity">
    <xsd:annotation>
        <xsd:documentation xml:lang="en">
            Top-level element for a single IATI activity report.
        </xsd:documentation>
    </xsd:annotation>
    <xsd:complexType>
        <xsd:choice minOccurs="1" maxOccurs="unbounded">
            <xsd:element ref="activity-website"/>
            <xsd:element ref="reporting-org"/>
            <xsd:element ref="participating-org"/>
            <xsd:element ref="recipient-country"/>
            <xsd:element ref="recipient-region"/>
            <xsd:element ref="collaboration-type"/>
            <xsd:element ref="default-flow-type"/>
            <xsd:element ref="default-aid-type"/>
            <xsd:element ref="default-finance-type"/>
            <xsd:element ref="iati-identifier"/>
            <xsd:element ref="other-identifier"/>
            <xsd:element ref="title"/>
            <xsd:element ref="description"/>
            <xsd:element ref="sector"/>
            <xsd:element ref="activity-date"/>
            <xsd:element ref="activity-status"/>
            <xsd:element ref="contact-info"/>
            <xsd:element ref="default-tied-status"/>
            <xsd:element ref="policy-marker"/>
            <xsd:element ref="location"/>
            <xsd:element ref="transaction"/>
            <xsd:element ref="result"/>
            <xsd:element ref="conditions"/>
            <xsd:element ref="budget"/>
            <xsd:element ref="planned-disbursement"/>
            <xsd:element ref="related-activity"/>
            <xsd:element ref="document-link"/>
            <xsd:element ref="legacy-data"/>
            <xsd:any namespace="##other" processContents="lax"/>
        </xsd:choice>
        <xsd:attribute name="version" type="xsd:decimal" use="optional">
            <xsd:annotation>
                <xsd:documentation xml:lang="en">
                    A number indicating the IATI specification version in use.
                    Defaults to "1.0" if not specified.  It is required to
                    specify this attribute if the document is using features
                    specific to an IATI specification other than the initial
                    1.0 version.
                </xsd:documentation>
            </xsd:annotation>
        </xsd:attribute>
        <xsd:attribute name="last-updated-datetime" type="xsd:dateTime" use="optional">
            <xsd:annotation>
                <xsd:documentation xml:lang="en">
                    The last date/time that the data for this specific
                    activity was updated.  This date must change whenever the
                    value of any field changes.
                 </xsd:documentation>
             </xsd:annotation>
         </xsd:attribute>
         <xsd:attribute ref="xml:lang"/>
         <xsd:attribute name="default-currency" type="xsd:string" use="optional">
            <xsd:annotation>
                <xsd:documentation xml:lang="en">
                    Default ISO 4217 currency code for all financial values in
                    this activity report.  See
                    http://iatistandard.org/codelists/currency
                </xsd:documentation>
            </xsd:annotation>
        </xsd:attribute>
        <xsd:attribute name="hierarchy" type="xsd:string" use="optional">
            <xsd:annotation>
                <xsd:documentation xml:lang="en">
                    Shortcut to show whether this is a parent or child
                    activity, without having to evaluate related-activity
                    elements.
                </xsd:documentation>
            </xsd:annotation>
        </xsd:attribute>
+        <xsd:attribute name="linked-data-uri" type="xsd:string" use="optional">
+            <xsd:annotation>
+                <xsd:documentation xml:lang="en">
+                    A Linked Data URI for a given activity 
+                    (over-rides iati-activities/@linked-data-default if set)
+                </xsd:documentation>
+            </xsd:annotation>
+         </xsd:attribute>
      <xsd:anyAttribute processContents="lax" namespace="##other"/>
    </xsd:complexType>
</xsd:element>

Reason

If a publisher chooses to publish linked data about their IATI activities then allowing them to declare where this data is published would support discovery of it, and any additional information they may choose to publish as Linked Data alongside it.

Demo

Proposed Changelog text

Introduced the @linked-data-default attribute on iati-activities element
Introduced the @linked-data-uri attribute on iati-activity element

Proposed Guidance

IATI publishers are not obliged to publish their own Linked Data. However, if a publisher chooses to publish linked data about their IATI activities then allowing them to declare where this data is published would support discovery of it, and any additional information they may choose to publish as Linked Data alongside it. For this reason the above-mentioned two new optional properties into the IATI standard are being added. Where a publisher declares using one of these properties that authoritative linked data is accessible for an activity then consuming applications that are generating Linked Data from an IATI XML file should assert an owl:sameAs relationship to the relevant URI.

Required Change

This is a change to the iati-common.xsd.
As such this will effect both activity and organisation files/data

It requires:

  1. the removal of the language attribute from the document-link element
  2. the addition of a language element as a child of the document-link element: document-link/language/text() (0..1) - The ISO 639 code for the language of the document

A sample diff is shown below:

<xsd:element name="document-link">
  <xsd:annotation>
    <xsd:documentation xml:lang="en">
        A categorized link to an external document.
    </xsd:documentation>
  </xsd:annotation>
  <xsd:complexType>
    <xsd:choice minOccurs="1" maxOccurs="unbounded">
      <xsd:element ref="title"/>
      <xsd:element name="category" type="codeReqType">
        <xsd:annotation>
          <xsd:documentation xml:lang="en">
              A category into which this document falls, using the
              IATI document category code list.  Must be specified at
              least once, and may be repeated for multiple categories.
 
              For the value of the @code attribute, see
              http://iatistandard.org/codelists/document_category
           </xsd:documentation>
        </xsd:annotation>
      </xsd:element>
      <xsd:any namespace="##other" processContents="lax"/>
    </xsd:choice>
    <xsd:attribute name="url" type="xsd:anyURI" use="required">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
            The target URL of the external document, e.g. "http://www.example.org/doc.html".
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
    <xsd:attribute name="format" type="xsd:string" use="optional">
      <xsd:annotation>
        <xsd:documentation xml:lang="en">
            The MIME type of the external document,
            e.g. "application/pdf".  A partial list of MIME types
            appears at http://iatistandard.org/codelists/file_format
        </xsd:documentation>
      </xsd:annotation>
    </xsd:attribute>
-    <xsd:attribute name="language" type="xsd:language" use="optional">
-      <xsd:annotation>
-        <xsd:documentation xml:lang="en">
-            The ISO 639 language code for the target document, e.g. "en".
-        </xsd:documentation>
-      </xsd:annotation>
-    </xsd:attribute>
+    <xsd:element name="language" type="codeType">
+      <xsd:annotation>
+        <xsd:documentation xml:lang="en">
+            The ISO 639 language code for the target document, e.g. "en".
+        </xsd:documentation>
+      </xsd:annotation>
+    </xsd:element>
    <xsd:anyAttribute processContents="lax" namespace="##other"/>
  </xsd:complexType>
</xsd:element>

Reason

The language refers to the language of the document itself, so an element is a more appropriate way of refering to this, rather than using a language attribute. This is thought to have been as it is due to an error.

Demo

Changelog text

Removed language attribute from, and introduced an new language child element to, the document-link element

Documentation

Code list Changes

Gazetteer Agency

http://support.iatistandard.org/entries/21090158-add-openstreetmap-as-gazetteer-agency

Adding Open Street Map to the list at http://iatistandard.org/codelists/gazetteer_agency:

 code: OSM 
 name: Open Street Map

XML

 <codelist name="GazetteerAgency" date-last-modified="NEW DATETIME" version="1.01" xml:lang="en">
    <comment>Added Open Street Map</comment>
    <GazetteerAgency>
      <code>GEO</code>
      <name>Geonames.org</name>
    </GazetteerAgency>
    <GazetteerAgency>
      <code>NGA</code>
      <name>National Geospatial-Intelligence Agency</name>
    </GazetteerAgency>
    <GazetteerAgency>
      <code>OSM</code>
      <name>Open Street Map</name>
    </GazetteerAgency>
  </codelist>
      

Metadata Change

Version 1.01

Changelog

Added Open Street Map

Demo

Transaction Type

http://support.iatistandard.org/entries/21179867-transaction-type-element-needs-additonal-code-options

Adding the following to the transaction type codelist (http://iatistandard.org/codelists/transaction_type):

QP  -  Purchase of Equity  -  The use of an activity's funds to purchase equity in a business
QS  -  Sale of Equity  -  The flow of funds into an activity from the sale of equity
CG  -  Credit Guarantee  -  A commitment made by a funding organisation to underwrite a loan or line of credit entered into by a third party.

XML

<codelist name="TransactionType" date-last-modified="2012-12-17T16:37:03.457" version="1.01" xml:lang="en">
	<TransactionType>
		<code>C</code>
		<name>Commitment</name>
		<description>A firm written obligation by the donor to provide resources of a specified amount under specified financial terms and conditions and for specified purposes for the benefit of the recipient</description>
	</TransactionType>
	<TransactionType>
		<code>D</code>
		<name>Disbursement</name>
		<description>The amount placed at the disposal of a recipient country or agency (in the case of internal development-related expenditures, the outlay of funds)</description>
	</TransactionType>
	<TransactionType>
		<code>E</code>
		<name>Expenditure</name>
		<description>The outlay by the implementing agency on goods and services for the activity</description>
	</TransactionType>
	<TransactionType>
		<code>IF</code>
		<name>Incoming Funds</name>
		<description>Funds received from an external funding source (eg a donor).</description>
	</TransactionType>
	<TransactionType>
		<code>IR</code>
		<name>Interest Repayment</name>
		<description>The actual amount of interest repaid, including fees.</description>
	</TransactionType>
	<TransactionType>
		<code>LR</code>
		<name>Loan Repayment</name>
		<description>The actual amount of principal (amortisation) repaid, including any arrears.</description>
	</TransactionType>
	<TransactionType>
		<code>R</code>
		<name>Reimbursement</name>
		<description>A disbursement that covers funds already spent by the recipient, as agreed in the terms of the loan or grant.</description>
	</TransactionType>
+                <TransactionType>
+			<code>QP</code>
+			<name>Purchase of Equity</name>
+			<description>The use of an activity's funds to purchase equity in a business.</description>
+		</TransactionType>
+                <TransactionType>
+			<code>QS</code>
+			<name>Sale of Equity</name>
+			<description>The flow of funds into an activity from the sale of equity.</description>
+		</TransactionType>
+               <TransactionType>
+			<code>CG</code>
+			<name>Credit Guarantee</name>
+			<description>A commitment made by a funding organisation to underwrite a loan or line of credit entered into by a third party.</description>
+		</TransactionType>
</codelist>
      

Metadata Change

Version 1.01

Changelog

Added 3 now options to the codelist: QP - Purchase of Equity, QS - Sale of Equity ,CG - Credit Guarantee

Demo

http://support.iatistandard.org/entries/21179746-document-link-and-aid-allocation-policies

Adding the following to the Document Category code list (http://iatistandard.org/codelists/document_category):

A10  -  Tender
A11  -  Contract
B04  -  Aid Allocation Policy
B05  -  Procurement Policy and Procedure

XML

<codelist name="DocumentCategory" date-last-modified="2012-03-02T16:37:03.457Z" version="1.0" xml:lang="en">
	<DocumentCategory>
		<code>A01</code>
		<name>Pre- and post-project impact appraisal</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A02</code>
		<name>Objectives / Purpose of activity</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A03</code>
		<name>Intended ultimate beneficiaries</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A04</code>
		<name>Conditions</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A05</code>
		<name>Budget</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A06</code>
		<name>Summary information about contract</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A07</code>
		<name>Review of project performance and evaluation</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A08</code>
		<name>Results, outcomes and outputs</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>A09</code>
		<name>Memorandum of understanding (If agreed by all parties)</name>
		<description/>
		<category>A</category>
		<category-name>Activity Level</category-name>
	</DocumentCategory>
+    <DocumentCategory>
+        <code>A10</code>
+        <name>Tender</name>
+        <description/>
+        <category>A</category>
+        <category-name>Activity Level</category-name>
+    </DocumentCategory>
+    <DocumentCategory>
+        <code>A11</code>
+        <name>Contract</name>
+        <description/>
+        <category>A</category>
+        <category-name>Activity Level</category-name>
+    </DocumentCategory>
	<DocumentCategory>
		<code>B01</code>
		<name>Annual report</name>
		<description/>
		<category>B</category>
		<category-name>Agency Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>B02</code>
		<name>Strategy paper</name>
		<description/>
		<category>B</category>
		<category-name>Agency Level</category-name>
	</DocumentCategory>
	<DocumentCategory>
		<code>B03</code>
		<name>Country strategy paper</name>
		<description/>
		<category>B</category>
		<category-name>Agency Level</category-name>
	</DocumentCategory>
+    <DocumentCategory>
+        <code>B04</code>
+        <name>Aid Allocation Policy</name>
+        <description/>
+        <category>B</category>
+        <category-name>Agency Level</category-name>
+    </DocumentCategory>
+    <DocumentCategory>
+        <code>B05</code></code>
+        <name>Procurement Policy and Procedure</name>
+        <description/>
+        <category>B</category>
+        <category-name>Agency Level</category-name>
+    </DocumentCategory>
</codelist>
      

Metadata Change

Version 1.01

Changelog

Added 4 now options to the codelist: A10 - Tender, A11 - Contract, B04 - Aid Allocation Policy, B05 - Procurement Policy and Procedure

Demo

Fixes

Documentation

http://support.iatistandard.org/entries/21790496-alter-documentation-within-the-schema-that-is-out-of-date

Documentation in the activity schema is being amended. A changelog will be published.

Hierarchy Attribute

Required Change

This is a change to the iati-activities-schema.xsd.

Proposal

Alter the activity xsd schema from:

<xsd:attribute name="hierarchy" type="xsd:string" use="optional">

to

<xsd:attribute name="hierarchy" type="xsd:int" use="optional">

Reason

In previous guidance, the attribute 'hierarchy' (on an iati-activity element) was defined as integer and specifies the level in the hierarchy of activities but in the XSD (http://iatistandard.org/downloads/iati-activities-schema.xsd) it is defined as a string and is described as a relative position as a parent (1) or child (2) - the distinction only matters in a hierarchy with more than 2 levels but needs clarification.

Demo

Proposed Changelog text

hierarchy attribute changed from type=“xsd:string” to “xsd:int”

Proposed Guidance

None yet


QR Code
QR Code Changes Specification - Revision 1.02 details (generated for current page)