AiDA XML Schema Explained (for AiDA Schema version 2.2)

Last Update: 2003 11 21, Sarah Kerr (skerr AT bellanet.org)

The purpose of this document is to give the reader a strong sense of the structure and meaning of the fields in the AiDA schema.
It is broken up into the following sections:

Tree view of the schema fields.
Explanation of all elements and attributes of the AiDA schema.
XML 'Template' view of the AiDA schema.
AiDA XML Schema.

1.0 Tree view of the schema fields

The following view gives a sense of the structure of the data. If you are viewing an electronic copy of this document, you can click on an element or attribute name to jump to a description.
A few remarks to help you understand the diagram:

all elements found directly to the right of another element are child elements of the left element ('assigningOrg' and 'uniqID' are child elements of 'ID')
* indicates a required element or attribute (only if parent element is supplied)

activities

activity
attributes:
origin
dbKey*
date
rights*
updateType
submitOrg

assigningOrg*
attributes:
refKey
attributeAddedBy
lang

uniqID*

title
attributes:
lang
transBy

location
attributes:
locationCode
attributeAddedBy
lang

startDate
attributes:
date
attributeAddedBy

endDate
attributes:
date
attributeAddedBy

status
attributes:
statusCode
attributeAddedBy
lang

sector
attributes:
refKey
attributeAddedBy
lang

notes
attributes:
lang
transBy

funding

fundingOrg
attributes:
refKey
attributeAddedBy
lang

yearly

yearStarting*
attributes:
date
attributeAddedBy

amount*
attributes:
amount
currency
attributeAddedBy
convertedBy

termsAssist
attributes:
terms
attributeAddedBy
lang

total
attributes:
amount
currency
attributeAddedBy
convertedBy

byCategory

category*
attributes:
lang
transBy

catTotal
attributes:
amount
currency
attributeAddedBy
convertedBy

catYearly

yearStarting*
attributes:
date
attributeAddedBy

amount*
attributes:
amount
currency
attributeAddedBy
convertedBy

orgInvolved

org*
attributes:
refKey
attributeAddedBy
lang

role
attributes:
orgRoleCode
attributeAddedBy
lang

personInvolved

person*
attributes:
emailAddress

role
attributes:
personRoleCode
attributeAddedBy
lang

keyword
attributes:
lang
transBy

abstract
attributes:
lang
transBy

relatedLink

label

url

lang

shortDesc

relatedTo
attributes:
origin*
dbKey*
relation*

anotherView
attributes:
origin*
dbKey*

forMoreInfo
attributes:
lang
transBy

aida_spider
attributes:
next_block

2.0 Explanation of all elements and attributes of the AiDA schema

2.1 How to Read the Tables Below

The following is a sample table:

element name

[min occurences..max occurences]¹

Description

Brief description of element.
If the element is considered to be core, an importance classification is also listed and explained here.

Attributes

A listing of this element's attributes. This row omitted if no attributes exist.

Child Elements

A listing of this element's child elements. This row omitted if no child elements exist.

element name attribute name

use required or optional²

Description

Brief description of attribute.

Possible Values

An attempt at a precise definition of what values the attribute can take on.

¹[minimum number of occurences to maximum number of occurences] This is the repeatability of the element.

[1..1]
One and only one is required within the scope of the parent element.
Example: If the 'ID' element is supplied, there must be one and only one occurence of each of 'assigningOrg' and 'uniqID' within 'ID', and this must be true for each occurence of the 'ID' element.
[1..many]
At least one is required and any number can be provided within the scope of the parent element.
Example: If the 'yearly' and in turn 'funding' elements are supplied, there must be at least one occurence of each of 'yearStarting' and 'amount' within 'yearly', and this must be true for each occurence of the 'yearly' element.
[0..1]
This is not required, but at most one can be provided within the scope of the parent element.
Example: Inside the 'activity' element, there must be no more than one occurence of the 'startDate' or 'endDate' elements, and this must be true for each occurence of the 'activity' element.
[0..many]
This is not required but any number can be provided within the scope of the parent element.
Example: Inside the 'activity' element, the 'ID' element can be left out or any number can be provided, and this must be true for each occurence of the 'activity' element.

²use required or optional

required
Within the element to which the attribute belongs, providing this attribute is required. Example: Within each 'activity' element, the attributes 'dbKey' and 'rights' must be supplied.
optional
Within the element to which the attribute belongs, providing this attribute is optional. Example: Within each 'activity' element, the attributes 'origin' and 'date' can be supplied if desired, but are not required.

2.2 Explanations

Please note that these fall in the order in which they appear in the AiDA Schema itself.

activities [1..1]

Description Holds all project/activity records in your XML document. Note that attributes of this element hold data unrelated to your project/activity records, instead they are used to link back to the AiDA schema (provides required namespace declaration attributes). It is not important to understand the attributes of this element, instead they are provided below in the example for your use.

Child Elements activity

Example (and only form in which the activities tag should be provided when conforming to version 2.2 of the AiDA schema)

<activities xmlns="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd">

activity [1..many]

Description Holds all data pertaining to a single project/activity record.

Attributes origin, dbKey, date, rights, updateType, submitOrg

Child Elements ID, title, location, startDate, endDate, status, sector, notes, funding, orgInvolved, personInvolved, keyword, abstract, relatedLink, relatedTo, anotherView, forMoreInfo

activity origin optional

Description This is an identifier for the originating records system/database.

Possible Values Your origin id. For a new records system/database sharing information with AiDA, this will be assigned to you. Existing origin identifiers are listed in 'Sources' located from AiDA Authority Files.

activity dbKey required

Description An identifier used in your database to uniquely identify the project/activity record.

Possible Values This can be in any form (numeric, alpha, combination of numeric & alpha, etc.), but is usually of the form '1', '2', '3',

activity date optional

Description The date of the last change to the activity data or the date of the data export to the xml file if the date of the last change is not recorded.

Possible Values ISO 8601 Date format which is YYYY-MM-DD
YYYY: 4-digit year
MM: 2-digit month
DD: 2-digit day

Example June 18th, 1978 would be '1978-06-18'

activity rights required

Description Specifies activity record rights that apply to this specific activity record.

Possible Values '0', '1', '2', or '3'
0 = May be used freely but source must be credited
1 = May not be used in for-profit systems
2 = May only be used by authorized users
3 = May not be re-released
These are also listed from 'Data Use Rights' located from AiDA Authority Files.

activity updateType optional

Description This attribute is used to instruct what the AiDA harvester is to do with the record. Currently it enables the contributor to specify project/activity records to be deleted or archived within the AiDA database.

Possible Values '0', '1'
0 = Delete project/activity record.
1 = Archive project/activity record.

activity submitOrg optional

Description This is the contributing/reporting organisation when the record has been supplied to a consolidating data system or organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Project/activity record to be inserted or updated in the AiDA database.
```
<activity origin="12" dbKey="42" date="2001-10-03" rights="0">
```
Case 2: Project/activity record to be deleted from the AiDA database.
```
<activity origin="9" dbKey="24" updateType="0"/>
```
(only data of the project/activity that is needed to instruct the harvester to delete the record from the AiDA database)

ID [0..many]

Description Holds all data pertaining to the project/activity identification number.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
This element is very useful when identifying duplicate records within the AiDA database. Often, a single project/activity can be recorded by more than one source contributing to the AiDA database. Therefore, the project/activity identifier is used to discover duplicate records for a single project/activity. Tracking duplicate records contributes to the overall quality of the AiDA data set.

Child Elements assigningOrg, uniqID

Example

<ID>
<assigningOrg refKey="MACA"/>
<uniqID>P-202</uniqID>
</ID>

assigningOrg [1..1]

Description This element describes the organisation which assigned the project/activity identification number specified in the 'uniqID' element.

Attributes refKey, attributeAddedBy, lang

assigningOrg refKey optional

Description This is an identifier for the organisation which assigned the project/activity identification number specified in the 'uniqID' element.

Possible Values An identifier from the 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then the organisation name should be listed as content of the 'assigningOrg' element.

assigningOrg attributeAddedBy optional

Description If the refKey attribute is added by a secondary organisation, then this attribute should be provided. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

assigningOrg lang optional

Description If the organisation name is provided as content of the assigningOrg element (and the 'refKey' attribute is not used), then this is the language of the full organisation name provided.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<assigningOrg refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<assigningOrg refKey="COMR" attributeAddedBy="BELL"/>
```

Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list

<assigningOrg lang="es">Instituto para la Conectividad en las Americas</assigningOrg>

uniqID [1..1]

Description This is the 'filing' number used to identify the project/activity by your organisation or an identifier used in your database to uniquely identify the project/activity record (can be same as 'activity dbKey').

Example

<uniqID>P-202</uniqID>

title [0..many]

Description Name or title of the project/activity. If there is no official title, then enter name of program, strategic objective, or unit that project/activity is associated with.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
This element is very useful when listing the project/activity record in a search result set on the AiDA website -- it provides the searcher with a very brief description of the project/activity.

Attributes lang, transBy

title lang optional

Description This is the language of the title appearing in the 'title' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

title transBy optional

Description If the title has been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Project/activity record is being provided in a single language
```
<title lang="fr">Gestion de l'école</title>
```
Case 2: Project/activity record is stored in 2 languages with translations done by the record owning organisation
```
<title lang="fr">Gestion de l'école</title>
<title lang="en">School management</title>
```
Case 3: Project/activity record is stored in 2 languages with translations done by a secondary organisation
```
<title lang="fr">Gestion de l'école</title>
<title lang="en" transBy="ADEA">School management</title>
```

location [0..many]

Description Countries and/or regions representing the geographic focus of the project/activity. If the project/activity applies to a region or a cluster of countries, then it is beneficial to also list all the countries of the geographic focus.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
One of the primary search criteria is the location of the project/activity.

Attributes locationCode, attributeAddedBy, lang

location locationCode optional

Description This is an identifier for the country/region.

Possible Values 1. Countries: Country code (ISO 3166-3) from 'Country and Region Codes', AiDA Authority Files
2. Regions: 'UNSD' Region code (United Nations Statistics Division Region Codes) from 'Country and Region Codes', AiDA Authority Files
If the geographic focus cannot be represented by the codes, then place the location in text form within the 'location' element tags. It is also encouraged to do this even when codes have been identified, since it is often the case that the textual form of the location can be more precise.

location attributeAddedBy optional

Description If the locationCode attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

location lang optional

Description If the location name is provided as content of the 'location' element (and the 'locationCode' attribute is not used), then this is the language of the location.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using ISO country and UN Division Region codes from code translations done by the record owning organisation (for the city of Maputo, Mozambique)

<location locationCode="QMB" /> (This represents the region of Eastern Africa.)
<location locationCode="MOZ" /> (This represents the country of Mozambique.)
<location lang="en">Maputo</location> (city of Maputo)

Case 2: Using ISO country and UN Division Region codes from code translations done by a secondary organisation (for the city of Maputo, Mozambique)

<location locationCode="QMB" attributeAddedBy="BELL" /> (This represents the region of Eastern Africa.)
<location locationCode="MOZ" attributeAddedBy="BELL" /> (This represents the country of Mozambique.)
<location lang="en">Maputo</location> (city of Maputo)

Case 3: Not using ISO country or UN Division Region codes (for the city of Maputo, Mozambique)

<location lang="fr">L'Afrique Orientale</location>
<location> lang="fr">la Mozambique</location>
<location lang="fr">Maputo</location>

startDate [0..1]

Description Holds data pertaining to the start date or planned start date of the project/activity.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
One of the primary search criteria is the start date of the project/activity.

Attributes date, attributeAddedBy

startDate date optional

Description The date of the start of the project/activity or the planned start date.

Possible Values ISO 8601 Date format which is YYYY-MM-DD
YYYY: 4-digit year
MM: 2-digit month
DD: 2-digit day

startDate attributeAddedBy optional

Description If the date attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the date attribute, with the record owning organisation placing the date in the correct format
```
<startDate date="1983-09-05" /> (September 5, 1983)
```
Case 2: Using the date attribute, with a secondary organisation placing the date in the correct format
```
<startDate date="1983-09-05" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<startDate>le 5 septembre, 1983</startDate>

endDate [0..1]

Description Holds data pertaining to the end date or expected finishing date of the project/activity.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
A search criteria is the end date of the project/activity, it is also important in understanding the time-frame and scope of the project/activity (when the start date is also known).

Attributes date, attributeAddedBy

endDate date optional

Description The date of the end of the project/activity or the planned finishing date.

Possible Values ISO 8601 Date format which is YYYY-MM-DD
YYYY: 4-digit year
MM: 2-digit month
DD: 2-digit day

endDate attributeAddedBy optional

Description If the date attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the date attribute, with the record owning organisation placing the date in the correct format
```
<endDate date="2002-09-17" /> (September 17, 2002)
```
Case 2: Using the date attribute, with a secondary organisation placing the date in the correct format
```
<endDate date="2002-09-17" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<endDate>le 17 septembre, 2002</endDate>

status [0..1]

Description Holds data pertaining to the current stage of the project/activity.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
A search criteria is the status of the project/activity.

Attributes statusCode, attributeAddedBy, lang

status statusCode optional

Description This is an identifier for the current stage of the project/activity.

Possible Values '1', '2', '3', '4', '5', or '6'
1 = Planned (from the conceptual stage to just prior to approval)
2 = Ongoing (the project/activity is approved, is active, but is not yet completed)
3 = Completed (the project/activity is finished, with all approved assistance provided)
4 = Cancelled (the project/activity was approved but was terminated prior to planned completion)
5 = In abeyance (the project/activity has been suspended)
6 = Committed (firm obligation in writing backed by necessary funds and specified assistance to undertake the planned project/activity)
These are also listed from 'Activity Status Codes' located from AiDA Authority Files.

status attributeAddedBy optional

Description If the 'statusCode' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

status lang optional

Description If the status is provided as content of the 'status' element (and the 'statusCode' attribute is not used), then this is the language of the status.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using the 'statusCode' attribute, with the record owning organisation performing the status mappings
```
<status statusCode="4" /> (cancelled)
```
Case 2: Using the 'statusCode' attribute, with a secondary organisation performing the status mappings
```
<status statusCode="4" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'statusCode' attribute
```
<status>implemented</status>
```

sector [0..many]

Description Holds data pertaining to the project/activity's sector or main subject area.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
A primary search criteria is the sector of the project/activity.

Attributes refKey, attributeAddedBy, lang

sector refKey optional

Description This is an identifier for the project/activity's sector or main subject area.

Possible Values An identifier from the 'Sectors: DAC 5 Codes and CRS Purpose Codes' list from AiDA Authority Files If the sector is not being provided through the use of a DAC 5 or CRS Purpose Code, then place the sector in text form within the 'sector' element tags.

sector attributeAddedBy optional

Description If the 'refKey' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

sector lang optional

Description If the sector is provided as content of the 'sector' element (and the 'refKey' attribute is not used), then this is the language of the sector.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using the 'refKey' attribute, with the record owning organisation performing the sector mappings
```
<sector refKey="12240" /> (representing basic nutrition)
```
Case 2: Using the 'refKey' attribute, with a secondary organisation performing the sector mappings
```
<sector refKey="12240" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'refKey' attribute
```
<sector>irrigation</sector>
```

notes [0..many]

Description Any notes or comments about the project/activity or any information that doesn't fit anywhere else can be put here.

Attributes lang, transBy

notes lang optional

Description This is the language of the text appearing in the 'notes' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

notes transBy optional

Description If the notes have been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: 'Notes' being provided in a single language

<notes lang="en">Following this project, two new projects will continue the effort.</notes>

Case 2: Project/activity record is stored in 2 languages with translations done by the record owning organisation

<notes lang="en">Following this project, two projects will continue the effort.</notes>
<title lang="en">Suite à ce projet, deux projets vont continués l'effort.</notes>

Case 3: Project/activity record is stored in 2 languages with translations done by a secondary organisation

<notes lang="fr">Suite à ce projet, deux projets vont continués l'effort.</notes>
<notes lang="en" transBy="ADEA">Following this project, two projects will continue the effort.</notes>

funding [0..many]

Description Holds all data pertaining to the project/activity's funding.

Child Elements fundingOrg, yearly, termsAssist, total, byCategory

Example 1 (basic typcial case)

<funding>
<fundingOrg refKey="UNFP"/>
<termsAssist terms="5"/>
<total amount="750000" currency="CAD"/>
</funding>

Example 2 (using yearly funding breakdowns)

<funding>
<fundingOrg refKey="MACA"/>
<yearly>
<yearStarting date="2001-01-01"/>
<amount amount="25000" currency="XEU"/>
</yearly>
<yearly>
<yearStarting date="2002-01-01"/>
<amount amount="50000" currency="XEU"/>
</yearly>
<yearly>
<yearStarting date="2003-01-01"/>
<amount amount="100000" currency="XEU"/>
</yearly>
<termsAssist terms="1"/>
<total amount="175000" currency="XEU"/>
</funding>

Example 3 (using category yearly funding breakdowns)

<funding>
<fundingOrg refKey="KELL"/>
<termsAssist terms="1"/>
<total amount="400000" currency="USD"/>
<byCategory>
<category lang="en">youth</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
</byCategory>
<byCategory>
<category lang="en">infants</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="25000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="70000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2002-03-01"/>
<amount amount="5000" currency="USD"/>
</catYearly>
</byCategory>
</funding>

fundingOrg [0..1]

Description This element describes a funding organisation of the project/activity.

Importance Classification: Essential (if your database contains this information, then it is considered essential that you provide this element).
Two of the primary search criteria are the type of funding organisation and the donor group of the project/activity. This information is derived directly from the supplied funding organisations.

Attributes refKey, attributeAddedBy, lang

fundingOrg refKey optional

Description This is an identifier for a funding organisation of the project/activity.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then the organisation name should be listed as content of the 'fundingOrg' element.

fundingOrg attributeAddedBy optional

Description If the 'refKey' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

fundingOrg lang optional

Description If the organisation name is provided as content of the 'fundingOrg' element (and the 'refKey' attribute is not used), then this is the language of the full organisation name.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<fundingOrg refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<fundingOrg refKey="COMR" attributeAddedBy="BELL"/>
```
Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list
```
<fundingOrg lang="es">Banco Mundial</assigningOrg>
```

yearly [0..many]

Description Holds all data pertaining to yearly funding contributions.

Child Elements yearStarting, amount

Example

<yearly>
<yearStarting date="2001-01-01"/>
<amount amount="25000" currency="XEU"/>
</yearly>

yearStarting [1..many]

Description Holds data pertaining to the start date of the funding contribution to be effective for a duration of one year.

Attributes date, attributeAddedBy

yearStarting date optional

Description The date of the start of the funding contribution to be effective for one year.

Possible Values ISO 8601 Date format which is YYYY-MM-DD
YYYY: 4-digit year
MM: 2-digit month
DD: 2-digit day

Example November 17th, 1978 would be '1978-11-17'

yearStarting attributeAddedBy optional

Description If the 'date' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'date' attribute, with the record owning organisation placing the date in the correct format
```
<yearStarting date="1999-05-01" /> (May 1, 1999)
```
Case 2: Using the 'date' attribute, with a secondary organisation placing the date in the correct format
```
<yearStarting date="1999-05-01" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<yearStarting>le 1 mai, 1999</yearStarting>

amount [1..many]

Description This element describes the amount approved for contribution for the year specified in 'yearStarting'.

Attributes amount, currency, attributeAddedBy, convertedBy

amount amount optional

Description The monetary amount approved for contribution for the year specified in 'yearStarting'.

Possible Values A decimal value, which can consist of the 10 digit characters and ".". Note that commas and spaces are not permitted (i.e. 100,000 and 100 000 should be represented as 100000)

amount currency optional

Description The currency of the monetary amount specified in the 'amount' attribute.

Possible Values ISO 4217 currency codes, listed from 'Currencies' in AiDA Authority Files.

amount attributeAddedBy optional

Description If the 'amount' and/or 'currency' attribute(s) is(are) added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

amount convertedBy optional

Description If the monetary amount specified by 'amount' has been converted into another currency by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<amount amount="10000" currency="CAD"/>
<amount amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<amount>10,000 CAD</amount>
```

termsAssist [0..1]

Description This element describes the mode of financing used to provide assistance for this project/activity.

Attributes terms, attributeAddedBy, lang

termsAssist terms optional

Description The funding terms of assistance.

Possible Values '1','2','3','4','5','6','7'
1 = Grant
2 = Loan
3 = Credit
4 = Equity Investment
5 = Donation
6 = Other (in-kind, cost-sharing, debt-for-nature swap, etc.)
7 = Multiple
These are also listed from 'Terms of Assistance' located from AiDA Authority Files.

termsAssist attributeAddedBy optional

Description If the 'terms' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

termsAssist lang optional

Description If the terms of assistance is provided as content of the 'termsAssist' element (and the 'terms' attribute is not used), then this is the language of the terms of assistance provided.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using the 'terms' attribute, with the record owning organisation performing the terms of assistance mappings
```
<termsAssist terms="2"/> (representing loan)
```
Case 2: Using the 'terms' attribute, with a secondary organisation performing the terms of assistance mappings
```
<termsAssist terms="2" attributeAddedBy="ODAC"/>
```

Case 3: Not using the 'terms' attribute

<termsAssist lang="en">cost-sharing</termsAssist>

total [0..many]

Description This element describes the total amount of funding approved by the funding organisation for the project/activity.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
Providing the funding information is very important in knowing the scope of the project/activity and getting an idea, collectively within the AiDA database, of the amounts of money which are being spent in certain development areas.

Attributes amount, currency, attributeAddedBy, convertedBy

total amount optional

Description The monetary amount of funding approved by the funding organisation for the project/activity.

Possible Values A decimal value, which can consist of the 10 digit charaters and ".". Note that commas and spaces are not permitted (i.e. 100,000 and 100 000 should be represented as 100000)

total currency optional

Description The currency of the monetary amount specified in the 'amount' attribute.

Possible Values ISO 4217 currency codes, listed from 'Currencies' in AiDA Authority Files.

total attributeAddedBy optional

Description If the 'amount' and/or 'currency' attribute(s) is(are) added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

total convertedBy optional

Description If the monetary amount specified by 'amount' has been converted into another currency by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<total amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<total amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<total amount="10000" currency="CAD"/>
<total amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<total>10,000 CAD</total>
```

byCategory [0..many]

Description This element describes the amount of funding approved by the funding organisation split over one or more categories and/or one or more years for the project/activity.

Child Elements category, catTotal, catYearly

Example

Case 1: Funding split over 2 categories

<byCategory>
<category lang="en">drought</category>
<catTotal amount="200000" currency="USD"/>
</byCategory>
<byCategory>
<category lang="en">poverty</category>
<catTotal amount="200000" currency="USD"/>
</byCategory>

Case 2: Funding split over 2 categories which is split over 3 and 4 yearly periods respectively

<byCategory>
<category lang="en">youth</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
</byCategory>
<byCategory>
<category lang="en">infants</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="25000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="70000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2002-03-01"/>
<amount amount="5000" currency="USD"/>
</catYearly>
</byCategory>

category [1..1]

Description This element describes a funding category.

Attributes lang, transBy

category lang optional

Description This is the language of the category name appearing in the 'category' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

category transBy optional

Description If the category name has been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Category name is being provided in a single language
```
<category lang="fr">l'éducation</category>
```
Case 2: Category name is stored in 2 languages with translations done by the record owning organisation
```
<category lang="fr">l'éducation</category>
<category lang="en">education</category>
```

Case 3: Category name is stored in 2 languages with translations done by a secondary organisation

<category lang="fr">l'éducation</category>
<category lang="en" transBy="ADEA">education</category>

catTotal [0..many]

Description This element describes the total amount of funding approved for the category specified in 'category' by the funding organisation for the project/activity.

Attributes amount, currency, attributeAddedBy, convertedBy

catTotal amount optional

Description The monetary amount of funding approved for the category specified in 'category' by the funding organisation for the project/activity.

Possible Values A decimal value, which can consist of the 10 digit charaters and ".". Note that commas and spaces are not permitted (i.e. 100,000 and 100 000 should be represented as 100000)

catTotal currency optional

Description The currency of the monetary amount specified in the 'amount' attribute.

Possible Values ISO 4217 currency codes, listed from 'Currencies' in AiDA Authority Files.

catTotal attributeAddedBy optional

Description If the 'amount' and/or 'currency' attribute(s) is(are) added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

catTotal convertedBy optional

Description If the monetary amount specified by 'amount' has been converted into another currency by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<catTotal amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<catTotal amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<catTotal amount="10000" currency="CAD"/>
<catTotal amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<catTotal>10,000 CAD</catTotal>
```

catYearly [0..many]

Description This element describes the yearly funding contributions approved by the funding organisation for the category specified in 'category'.

Child Elements yearStarting, amount

Example

<catYearly>
<yearStarting date="2002-02-01"/>
<amount amount="100000" currency="XEU"/>
<catYearly>

yearStarting [1..1]

Description Holds data pertaining to the start date of the funding contribution to be effective for a duration of one year for the category specified in 'category'.

Attributes date, attributeAddedBy

yearStarting date optional

Description The date of the start of the funding contribution to be effective for one year for the category specified in 'category'.

Possible Values ISO 8601 Date format which is YYYY-MM-DD
YYYY: 4-digit year
MM: 2-digit month
DD: 2-digit day

yearStarting attributeAddedBy optional

Description If the 'date' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'date' attribute, with the record owning organisation placing the date in the correct format
```
<yearStarting date="2002-02-01" /> (February 1, 2002)
```
Case 2: Using the 'date' attribute, with a secondary organisation placing the date in the correct format
```
<yearStarting date="2002-02-01" attributeAddedBy="BELL" />
```

Case 3: Not using the 'date' attribute

<yearStarting>février 2002</yearStarting>

amount [1..many]

Description This element describes the amount approved for contribution for the category specified in 'category' and year specified in 'yearStarting'.

Attributes amount, currency, attributeAddedBy, convertedBy

amount amount optional

Description The monetary amount approved for contribution for the category in 'category' and year in 'yearStarting'.

Possible Values A decimal value, which can consist of the 10 digit charaters and ".". Note that commas and spaces are not permitted (i.e. 100,000 and 100 000 should be represented as 100000)

amount currency optional

Description The currency of the monetary amount specified in the 'amount' attribute.

Possible Values ISO 4217 currency codes, listed from 'Currencies' in AiDA Authority Files.

amount attributeAddedBy optional

Description If the 'amount' and/or 'currency' attribute(s) is(are) added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

amount convertedBy optional

Description If the monetary amount specified by 'amount' has been converted into another currency by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<amount amount="10000" currency="CAD"/>
<amount amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<amount>10,000 CAD</amount>
```

orgInvolved [0..many]

Description This element describes an organisation which is involved in the project/activity and their role.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
*Note that organisations involved with a role of funding are classified as essential (see fundingOrg).
Supplying organisations involved with the project/activity is very important to be aware of collectively, within the AiDA database, the responsible organisations.

Child Elements org, role

Example

<orgInvolved>
<org refKey="ADEA"/>
<role orgRoleCode="2"/>
</orgInvolved>

org [1..1]

Description This element describes an involved organisation.

Attributes refKey, attributeAddedBy, lang

org refKey optional

Description This is an identifier for the involved organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then it should be listed as content of the 'org' element.

org attributeAddedBy optional

Description If the 'refKey' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

org lang optional

Description If the organisation name is provided as content of the 'org' element (and the 'refKey' attribute is not used), then this is the language of the full organisation name.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<org refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<org refKey="COMR" attributeAddedBy="BELL"/>
```
Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list
```
<org lang="es">Instituto para la Conectividad en las Americas</assigningOrg>
```

role [0..many]

Description This element describes the role of the involved organisation specified in 'org'.

Attributes orgRoleCode, attributeAddedBy, lang

role orgRoleCode optional

Description This is an identifier for the role of the involved organisation.

Possible Values '1','2','3','4'
1 = Funding Organisation (that which provides funds for the specific purpose of implementing the project/activity)
2 = Implementing Agency ([CHECK ??])
3 = Executing Agency (direct recipient of funds provided by the funding agency)
4 = Borrower ([CHECK?])

role attributeAddedBy optional

Description If the 'orgRoleCode' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then it should be listed as content of the 'org' element.

role lang optional

Description If the role is provided as content of the 'role' element (and the 'orgRoleCode' attribute is not used), then this is the language of the role specified.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using the 'orgRoleCode' attribute, with the record owning organisation performing the code mappings
```
<role orgRoleCode="3" /> (executing org)
```
Case 2: Using the 'orgRoleCode' attribute, with a secondary organisation performing the code mappings
```
<role orgRoleCode="3" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'orgRoleCode' attribute
```
<role lang="en">funding source</role>
```

personInvolved [0..many]

Description This element describes a person who is involved and their role in the project/activity.

Importance Classification: Recommended (if your database contains this information, then it is considered recommended that you provide this element).
Although this element is not meant to equate the contact person, it is important for tracing back to a specific individual with a responsibility to the project/activity.

Child Elements person, role

Example

<personInvolved>
<person emailAddress="mryan@somewhere.org">Michael Ryan</person>
<role personRoleCode="1"/>
</personInvolved>

person [1..1]

Description This element describes an involved person (usually the project manager).

Attributes emailAddress

person emailAddress optional

Description This is the email address for the involved person.

Possible Values Any valid email address.

Example

Case 1: Providing email address

<person emailAddress="mryan@somewhere.org">Michael Ryan</person>

Case 2: Not providing email address
```
<person>Coleen Smith</person>
```

role [0..many]

Description This element describes the role of the involved person specified in 'person'.

Attributes personRoleCode, attributeAddedBy, lang

role personRoleCode optional

Description This is an identifier for the role of the involved person.

Possible Values '1' (currently only this single value accepted)
1 = Project Manager

role attributeAddedBy optional

Description If the 'personRoleCode' attribute is added by a secondary organisation, then this attribute should be added. It is the identifier for the secondary organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then it should be listed as content of the 'org' element.

role lang optional

Description If the role is provided as content of the 'role' element (and the 'personRoleCode' attribute is not used), then this is the language of the role specified.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

Case 1: Using the 'personRoleCode' attribute, with the record owning organisation performing the code mapping
```
<role personRoleCode="1" /> (signifying project manager)
```
Case 2: Using the 'personRoleCode' attribute, with a secondary organisation performing the code mapping
```
<role personRoleCode="1" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'personRoleCode' attribute
```
<role lang="en">program officer</role>
```

keyword [0..many]

Description A keyword or descriptive phrase of the project/activity, used to find the record in a search.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
This is very important for seaching purposes.

Attributes lang, transBy

keyword lang optional

Description This is the language of the keyword appearing in the 'keyword' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

keyword transBy optional

Description If the keyword has been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: The keyword is being provided in a single language
```
<keyword lang="en">water purification</keyword>
```
Case 2: The keyword is being provided in 2 languages with translations done by the record owning organisation
```
<keyword lang="en">water purification</keyword>
<keyword lang="fr">purification de l'eau</keyword>
```

Case 3: The keyword is being provided in 2 languages with translations done by a secondary organisation

<keyword lang="en">water purification</keyword>
<keyword lang="en" transBy="ADEA">purification de l'eau</keyword>

abstract [0..many]

Description A description or summary of the project/activity.

Importance Classification: Highly Recommended (if your database contains this information, then it is considered highly recommended that you provide this element).
Providing a short description of the record is important to AiDA users seeking quick details and highlights of the project/activity. Also important for searching purposes.

Attributes lang, transBy

Possible Values The elements '', '', '', '' are additionally allowed

abstract lang optional

Description This is the language of the abstract appearing in the 'abstract' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

abstract transBy optional

Description If the abstract has been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: The abstract is being provided in a single language

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>

Case 2: The abstract is being provided in 2 languages with translations done by the record owning organisation

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>
<abstract lang="fr">Ce projet se concentre sur 2 secteurs <b><i>principaux</i></b> ...</abstract>

Case 3: The abstract is being provided in 2 languages with translations done by a secondary organisation

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>
<abstract lang="en" transBy="ADEA">Ce projet se concentre sur 2 secteurs <b><i>principaux</i></b> ...</abstract>

relatedLink [0..many]

Description This contains information about a link related to the project/activity. This could be pointing back to the original record listed on the source organisation's web page, or to an associated document available via a URL.

Importance Classification: Recommended (if your database contains this information, then it is considered recommended that you provide this element).
Data captured through the AiDA process is designed to only be a common subset of information about a project/activity. Providing links to external additional information is the ideal case to provide a richer set of data.

Child Elements label, url, lang, shortDesc

Example

<relatedLink>
<label>PRISME project description (from source)</label>
<url>http://prisme.adeanet.org/index.cfm?Fuseaction=dsp_search_project_details&index=1&RefPr_list=1</url>
<lang>en</lang>
<shortDesc>Find the full project description at this location.</shortDesc>
</relatedLink>

label [0..1]

Description This contains the related link's label.

Example

<label>PRISME project description (from source)</label>

url [0..1]

Description This holds the URL (or web address) of the related link.

Example

<url>http://prisme.adeanet.org/index.cfm?Fuseaction=dsp_search_project_details&index=1&RefPr_list=1</url>

lang [0..1]

Description This contains the language of the page pointed to by the URL, as well as the language of the title and short description.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

Example

<lang>en</lang>

shortDesc [0..1]

Description This contains a short description (that gives more detail than the 'label') about a link related to the project/activity.

Example

<shortDesc>Find the full project description at this location.</shortDesc>

relatedTo [0..many]

Description This contains information about a record in the harvesting system that is related to the project/activity record (either part of or a continuation of).

Attributes origin, dbKey, relation

relatedTo origin required

Description This is an identifier for the records system/database to which the related record belongs.

Possible Values An origin id.

relatedTo dbKey required

Description An identifier used in records system/database (to which the related record belongs) to uniquely identify the related project/activity record.

Possible Values This can be in any form (numeric, alpha, combination of numeric & alpha, etc.), but is usually of the form '1', '2', '3',

relatedTo relation required

Description This is an identifier for the relation type.

Possible Values '1','2','3','4'
1 = relatedTo activity is part of this activity
2 = this activity is part of the relatedTo activity
3 = relatedTo activity continued this activity
4 = this activity continued the relatedTo activity

Example

<relatedTo origin="3" dbKey="46" relation="2"/>

anotherView [0..many]

Description This contains information about a record in the harvesting system which describes the same project/activity, yet gives complementing details.

Attributes origin, dbKey

anotherView origin required

Description This is an identifier for the records system/database to which the record for the same project/activity belongs.

Possible Values An origin id.

anotherView dbKey required

Description An identifier used in the records system/database to which the record for the same project/activity belongs) to uniquely identify the project/activity record.

Possible Values This can be in any form (numeric, alpha, combination of numeric & alpha, etc.), but is usually of the form '1', '2', '3',

Example

<anotherView origin="2" dbKey="164"/>

forMoreInfo [0..many]

Description The name / contact information of an individual or means by which requests for additional information can be directed.

Importance Classification: Recommended (if your database contains this information, then it is considered recommended that you provide this element).
Often, users of the information within AiDA would like a specific contact for more information about a project/activity.

Attributes lang, transBy

Possible Values The elements '', '', '', '' are additionally allowed

forMoreInfo lang optional

Description This is the language of the text appearing in the 'forMoreInfo' element.

Possible Values An ISO 639-2 language code, available from the 'Languages' list located from AiDA Authority Files.

forMoreInfo transBy optional

Description If the 'forMoreInfo' text has been translated by a secondary organisation which has a copy of the project/activity record, this is an identifier for that organisation.

Possible Values An identifier from 'Organisations Names and Codes' located from AiDA Authority Files. Note that if a code for the organisation that is being specified is not in the 'Organisations Names and Codes' list, then this attribute should not be specified.

Example

Case 1: The 'forMoreInfo' text is being provided in a single language

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>

Case 2: The 'forMoreInfo' text is being provided in 2 languages with translations done by the record owning organisation

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>
<forMoreInfo lang="fr">Pour plus d'information, prière de contacter <b><i>info@someorg.org</i></b></forMoreInfo>

Case 3: The 'forMoreInfo' text is being provided in 2 languages with translations done by a secondary organisation

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>
<forMoreInfo lang="en" transBy="ADEA">Pour plus d'information, prière de contacter <b><i>info@someorg.org</i></b></forMoreInfo>

aida_spider [0..1]

Description This information is strictly for the harvester. It is useful when you are using a dynamic script to produce an XML document with potentially a large amount of records. The harvester can use the information supplied in this element to request pages handling specified parameters so that it can then process your XML in predefined blocks (or sets) preventing performance problems.

Attributes next_block

aida_spider next_block optional

Description This is the URL of the dynamic script for the harvester to call to produce the next set of records for the harvester to read.

Possible Values The format of this is:
[URL of script]?[name of parameter]=[value of parameter]&[name of parameter]=[value of parameter]&[name of parameter]=[value of parameter]&...
There is a standard set of parameters which you can design your dynamic script to handle either all or a subset of them. They are the following:
maxBlockSize: This is a numeric value which is the maximum number of records ('activity' elements) which is returned in a call to the script.
startWith: This is an alpha-numeric value corresponding to a project/activity 'dbKey' value. The set of records returned should start with the record corresponding to the 'startWith' value supplied and contain records following it in sequence.
startAfter: This is an alpha-numeric value corresponding to a project/activity 'dbKey' value. The set of records returned should start with the next record in sequence following the record corresponding to the 'startAfter' value supplied and contain records following it in sequence.
country: This is an ISO 3166 2 or 3 digit country code. The set of records returned should have a 'location' element set to be the specified country.
since: This is an ISO 8601 date as specified in the activity date attribute. The set of records returned should have been added/updated in your records system since the 'since' date specified (i.e. the 'date' attribute in activity should be greater than or equal to the date specified).
rights: This is a rights code as specified in the activity rights attribute. The set of records returned should have the 'rights' value specified.

Example

Case 1: Script supports 'maxBlockSize' and 'since'. The last activity 'dbKey' in the current XML document is 'P123J'. The harvester would like 25 records returned, update/inserted after Dec. 1st 2002 which are after record 'P123J' in the database.
```
<aida_spider next_block="http://www.anyorg.org/aida/scriptfile.php?maxBlockSize=25&since=2002-12-01&startAfter=P123J"/>
```
Case 2: Script supports 'country', 'since', and 'rights'. The harvester would like to have all projects/activities taking place in Benin, inserted/updated on or after Sept. 5th 2002, with rights set as 3 (May not be re-released.)
```
<aida_spider next_block="http://www.ABCorg.org/scriptfile.asp?country=BEN&since=2002-09-05&rights=3"/>
```

3.0 XML 'Template' view of the AiDA schema

The following shows an empty individual occurence of each element with corresponding attributes that exists in the schema structured as it would be in your AiDA XML document (tabbing is of course not necessary but used here to see hierarchy of data). Note that in your AiDA XML document not all elements (and attributes) are necessarily present and certain elements will occur more than once (see descriptions of each for more details) -- the following is just to give you a sense of all elements and attributes.

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd">
<activity origin="" dbKey="" date="" rights="" updateType="" submitOrg="">
<ID>
<assigningOrg refKey="" attributeAddedBy="" lang=""/>
<uniqID></uniqID>
</ID>
<title lang="" transBy=""></title>
<location locationCode="" attributeAddedBy="" lang=""></location>
<startDate date="" attributeAddedBy=""/>
<endDate date="" attributeAddedBy=""/>
<status statusCode="" attributeAddedBy="" lang=""/>
<sector refKey="" attributeAddedBy="" lang=""></sector>
<notes lang="" transBy=""></notes>
<funding>
<fundingOrg refKey="" attributeAddedBy="" lang=""></fundingOrg>
<yearly>
<yearStarting date="" attributeAddedBy=""/>
<amount amount="" currency="" attributeAddedBy="" convertedBy=""/>
</yearly>
<termsAssist terms="" attributeAddedBy=""/>
<total amount="" currency="" attributeAddedBy="" convertedBy=""/>
<byCategory>
<category lang="" transBy=""></category>
<catTotal amount="" currency="" attributeAddedBy="" convertedBy=""/>
<catYearly>
<yearStarting date="" attributeAddedBy=""/>
<amount amount="" currency="" attributeAddedBy="" convertedBy=""/>
</catYearly>
</byCategory>
</funding>
<orgInvolved>
<org refKey="" attributeAddedBy="" lang=""></org>
<role orgRoleCode="" attributeAddedBy="" lang=""></role>
</orgInvolved>
<personInvolved>
<person emailAddress=""></person>
<role personRoleCode="" attributeAddedBy="" lang=""></role>
</personInvolved>
<keyword lang="" transBy=""></keyword>
<abstract lang="" transBy=""></abstract>
<relatedLink>
<label></label>
<url></url>
<lang></lang>
<shortDesc></shortDesc>
</relatedLink>
<relatedTo origin="" dbKey="" relation=""/>
<anotherView origin="" dbKey=""/>
<forMoreInfo lang="" transBy=""></forMoreInfo>
</activity>
<aida_spider next_block=""/>
</activities>

4.0 AiDA XML Schema

The most recent version of the AiDA schema is 2.2 and is located at: http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd AiDA XML Schema Explained (for AiDA Schema version 2.2) .

AiDA XML Schema Explained (for AiDA Schema version 2.2)

Last Update: 2003 11 21, Sarah Kerr (skerr AT bellanet.org)

The purpose of this document is to give the reader a strong sense of the structure and meaning of the fields in the AiDA schema.
It is broken up into the following sections:

Tree view of the schema fields.
Explanation of all elements and attributes of the AiDA schema.
XML 'Template' view of the AiDA schema.
AiDA XML Schema.

1.0 Tree view of the schema fields

all elements found directly to the right of another element are child elements of the left element ('assigningOrg' and 'uniqID' are child elements of 'ID')
* indicates a required element or attribute (only if parent element is supplied)

activities

activity
attributes:
origin
dbKey*
date
rights*
updateType
submitOrg

assigningOrg*
attributes:
refKey
attributeAddedBy
lang

uniqID*

title
attributes:
lang
transBy

location
attributes:
locationCode
attributeAddedBy
lang

startDate
attributes:
date
attributeAddedBy

endDate
attributes:
date
attributeAddedBy

status
attributes:
statusCode
attributeAddedBy
lang

sector
attributes:
refKey
attributeAddedBy
lang

notes
attributes:
lang
transBy

funding

fundingOrg
attributes:
refKey
attributeAddedBy
lang

yearly

yearStarting*
attributes:
date
attributeAddedBy

amount*
attributes:
amount
currency
attributeAddedBy
convertedBy

termsAssist
attributes:
terms
attributeAddedBy
lang

total
attributes:
amount
currency
attributeAddedBy
convertedBy

byCategory

category*
attributes:
lang
transBy

catTotal
attributes:
amount
currency
attributeAddedBy
convertedBy

catYearly

yearStarting*
attributes:
date
attributeAddedBy

amount*
attributes:
amount
currency
attributeAddedBy
convertedBy

orgInvolved

org*
attributes:
refKey
attributeAddedBy
lang

role
attributes:
orgRoleCode
attributeAddedBy
lang

personInvolved

person*
attributes:
emailAddress

role
attributes:
personRoleCode
attributeAddedBy
lang

keyword
attributes:
lang
transBy

abstract
attributes:
lang
transBy

relatedLink

label

url

lang

shortDesc

relatedTo
attributes:
origin*
dbKey*
relation*

anotherView
attributes:
origin*
dbKey*

forMoreInfo
attributes:
lang
transBy

aida_spider
attributes:
next_block

2.0 Explanation of all elements and attributes of the AiDA schema

2.1 How to Read the Tables Below

The following is a sample table:

element name

[min occurences..max occurences]¹

Description

Brief description of element.
If the element is considered to be core, an importance classification is also listed and explained here.

Attributes

A listing of this element's attributes. This row omitted if no attributes exist.

Child Elements

A listing of this element's child elements. This row omitted if no child elements exist.

element name attribute name

use required or optional²

Description

Brief description of attribute.

Possible Values

An attempt at a precise definition of what values the attribute can take on.

¹[minimum number of occurences to maximum number of occurences] This is the repeatability of the element.

[1..1]
One and only one is required within the scope of the parent element.
Example: If the 'ID' element is supplied, there must be one and only one occurence of each of 'assigningOrg' and 'uniqID' within 'ID', and this must be true for each occurence of the 'ID' element.
[1..many]
At least one is required and any number can be provided within the scope of the parent element.
Example: If the 'yearly' and in turn 'funding' elements are supplied, there must be at least one occurence of each of 'yearStarting' and 'amount' within 'yearly', and this must be true for each occurence of the 'yearly' element.
[0..1]
This is not required, but at most one can be provided within the scope of the parent element.
Example: Inside the 'activity' element, there must be no more than one occurence of the 'startDate' or 'endDate' elements, and this must be true for each occurence of the 'activity' element.
[0..many]
This is not required but any number can be provided within the scope of the parent element.
Example: Inside the 'activity' element, the 'ID' element can be left out or any number can be provided, and this must be true for each occurence of the 'activity' element.

²use required or optional

required
Within the element to which the attribute belongs, providing this attribute is required. Example: Within each 'activity' element, the attributes 'dbKey' and 'rights' must be supplied.
optional
Within the element to which the attribute belongs, providing this attribute is optional. Example: Within each 'activity' element, the attributes 'origin' and 'date' can be supplied if desired, but are not required.

2.2 Explanations

Please note that these fall in the order in which they appear in the AiDA Schema itself.

Example (and only form in which the activities tag should be provided when conforming to version 2.2 of the AiDA schema)

<activities xmlns="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd"
xmlns:msdata="urn:schemas-microsoft-com:xml-msdata"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd">

Example

Case 1: Project/activity record to be inserted or updated in the AiDA database.
```
<activity origin="12" dbKey="42" date="2001-10-03" rights="0">
```
Case 2: Project/activity record to be deleted from the AiDA database.
```
<activity origin="9" dbKey="24" updateType="0"/>
```
(only data of the project/activity that is needed to instruct the harvester to delete the record from the AiDA database)

Example

<ID>
<assigningOrg refKey="MACA"/>
<uniqID>P-202</uniqID>
</ID>

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<assigningOrg refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<assigningOrg refKey="COMR" attributeAddedBy="BELL"/>
```

Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list

<assigningOrg lang="es">Instituto para la Conectividad en las Americas</assigningOrg>

Example

<uniqID>P-202</uniqID>

Example

Case 1: Project/activity record is being provided in a single language
```
<title lang="fr">Gestion de l'école</title>
```
Case 2: Project/activity record is stored in 2 languages with translations done by the record owning organisation
```
<title lang="fr">Gestion de l'école</title>
<title lang="en">School management</title>
```
Case 3: Project/activity record is stored in 2 languages with translations done by a secondary organisation
```
<title lang="fr">Gestion de l'école</title>
<title lang="en" transBy="ADEA">School management</title>
```

Example

Case 1: Using ISO country and UN Division Region codes from code translations done by the record owning organisation (for the city of Maputo, Mozambique)

<location locationCode="QMB" /> (This represents the region of Eastern Africa.)
<location locationCode="MOZ" /> (This represents the country of Mozambique.)
<location lang="en">Maputo</location> (city of Maputo)

Case 2: Using ISO country and UN Division Region codes from code translations done by a secondary organisation (for the city of Maputo, Mozambique)

<location locationCode="QMB" attributeAddedBy="BELL" /> (This represents the region of Eastern Africa.)
<location locationCode="MOZ" attributeAddedBy="BELL" /> (This represents the country of Mozambique.)
<location lang="en">Maputo</location> (city of Maputo)

Case 3: Not using ISO country or UN Division Region codes (for the city of Maputo, Mozambique)

<location lang="fr">L'Afrique Orientale</location>
<location> lang="fr">la Mozambique</location>
<location lang="fr">Maputo</location>

Example

Case 1: Using the date attribute, with the record owning organisation placing the date in the correct format
```
<startDate date="1983-09-05" /> (September 5, 1983)
```
Case 2: Using the date attribute, with a secondary organisation placing the date in the correct format
```
<startDate date="1983-09-05" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<startDate>le 5 septembre, 1983</startDate>

Example

Case 1: Using the date attribute, with the record owning organisation placing the date in the correct format
```
<endDate date="2002-09-17" /> (September 17, 2002)
```
Case 2: Using the date attribute, with a secondary organisation placing the date in the correct format
```
<endDate date="2002-09-17" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<endDate>le 17 septembre, 2002</endDate>

Example

Case 1: Using the 'statusCode' attribute, with the record owning organisation performing the status mappings
```
<status statusCode="4" /> (cancelled)
```
Case 2: Using the 'statusCode' attribute, with a secondary organisation performing the status mappings
```
<status statusCode="4" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'statusCode' attribute
```
<status>implemented</status>
```

Example

Case 1: Using the 'refKey' attribute, with the record owning organisation performing the sector mappings
```
<sector refKey="12240" /> (representing basic nutrition)
```
Case 2: Using the 'refKey' attribute, with a secondary organisation performing the sector mappings
```
<sector refKey="12240" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'refKey' attribute
```
<sector>irrigation</sector>
```

Example

Case 1: 'Notes' being provided in a single language

<notes lang="en">Following this project, two new projects will continue the effort.</notes>

Case 2: Project/activity record is stored in 2 languages with translations done by the record owning organisation

<notes lang="en">Following this project, two projects will continue the effort.</notes>
<title lang="en">Suite à ce projet, deux projets vont continués l'effort.</notes>

Case 3: Project/activity record is stored in 2 languages with translations done by a secondary organisation

<notes lang="fr">Suite à ce projet, deux projets vont continués l'effort.</notes>
<notes lang="en" transBy="ADEA">Following this project, two projects will continue the effort.</notes>

funding [0..many]

Description Holds all data pertaining to the project/activity's funding.

Child Elements fundingOrg, yearly, termsAssist, total, byCategory

Example 1 (basic typcial case)

<funding>
<fundingOrg refKey="UNFP"/>
<termsAssist terms="5"/>
<total amount="750000" currency="CAD"/>
</funding>

Example 2 (using yearly funding breakdowns)

<funding>
<fundingOrg refKey="MACA"/>
<yearly>
<yearStarting date="2001-01-01"/>
<amount amount="25000" currency="XEU"/>
</yearly>
<yearly>
<yearStarting date="2002-01-01"/>
<amount amount="50000" currency="XEU"/>
</yearly>
<yearly>
<yearStarting date="2003-01-01"/>
<amount amount="100000" currency="XEU"/>
</yearly>
<termsAssist terms="1"/>
<total amount="175000" currency="XEU"/>
</funding>

Example 3 (using category yearly funding breakdowns)

<funding>
<fundingOrg refKey="KELL"/>
<termsAssist terms="1"/>
<total amount="400000" currency="USD"/>
<byCategory>
<category lang="en">youth</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
</byCategory>
<byCategory>
<category lang="en">infants</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="25000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="70000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2002-03-01"/>
<amount amount="5000" currency="USD"/>
</catYearly>
</byCategory>
</funding>

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<fundingOrg refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<fundingOrg refKey="COMR" attributeAddedBy="BELL"/>
```
Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list
```
<fundingOrg lang="es">Banco Mundial</assigningOrg>
```

yearly [0..many]

Description Holds all data pertaining to yearly funding contributions.

Child Elements yearStarting, amount

Example

<yearly>
<yearStarting date="2001-01-01"/>
<amount amount="25000" currency="XEU"/>
</yearly>

Example

Case 1: Using the 'date' attribute, with the record owning organisation placing the date in the correct format
```
<yearStarting date="1999-05-01" /> (May 1, 1999)
```
Case 2: Using the 'date' attribute, with a secondary organisation placing the date in the correct format
```
<yearStarting date="1999-05-01" attributeAddedBy="BELL" />
```

Case 3: Not using the date attribute

<yearStarting>le 1 mai, 1999</yearStarting>

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<amount amount="10000" currency="CAD"/>
<amount amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<amount>10,000 CAD</amount>
```

Example

Case 1: Using the 'terms' attribute, with the record owning organisation performing the terms of assistance mappings
```
<termsAssist terms="2"/> (representing loan)
```
Case 2: Using the 'terms' attribute, with a secondary organisation performing the terms of assistance mappings
```
<termsAssist terms="2" attributeAddedBy="ODAC"/>
```

Case 3: Not using the 'terms' attribute

<termsAssist lang="en">cost-sharing</termsAssist>

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<total amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<total amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<total amount="10000" currency="CAD"/>
<total amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<total>10,000 CAD</total>
```

Example

Case 1: Funding split over 2 categories

<byCategory>
<category lang="en">drought</category>
<catTotal amount="200000" currency="USD"/>
</byCategory>
<byCategory>
<category lang="en">poverty</category>
<catTotal amount="200000" currency="USD"/>
</byCategory>

Case 2: Funding split over 2 categories which is split over 3 and 4 yearly periods respectively

<byCategory>
<category lang="en">youth</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="50000" currency="USD"/>
</catYearly>
</byCategory>
<byCategory>
<category lang="en">infants</category>
<catTotal amount="200000" currency="USD"/>
<catYearly>
<yearStarting date="1999-03-01"/>
<amount amount="25000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2000-03-01"/>
<amount amount="100000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2001-03-01"/>
<amount amount="70000" currency="USD"/>
</catYearly>
<catYearly>
<yearStarting date="2002-03-01"/>
<amount amount="5000" currency="USD"/>
</catYearly>
</byCategory>

Example

Case 1: Category name is being provided in a single language
```
<category lang="fr">l'éducation</category>
```
Case 2: Category name is stored in 2 languages with translations done by the record owning organisation
```
<category lang="fr">l'éducation</category>
<category lang="en">education</category>
```

Case 3: Category name is stored in 2 languages with translations done by a secondary organisation

<category lang="fr">l'éducation</category>
<category lang="en" transBy="ADEA">education</category>

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<catTotal amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<catTotal amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<catTotal amount="10000" currency="CAD"/>
<catTotal amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<catTotal>10,000 CAD</catTotal>
```

Example

<catYearly>
<yearStarting date="2002-02-01"/>
<amount amount="100000" currency="XEU"/>
<catYearly>

Example

Case 1: Using the 'date' attribute, with the record owning organisation placing the date in the correct format
```
<yearStarting date="2002-02-01" /> (February 1, 2002)
```
Case 2: Using the 'date' attribute, with a secondary organisation placing the date in the correct format
```
<yearStarting date="2002-02-01" attributeAddedBy="BELL" />
```

Case 3: Not using the 'date' attribute

<yearStarting>février 2002</yearStarting>

Example

Case 1: Using the 'amount' and 'currency' attributes, with the record owning organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD"/>
```
Case 2: Using the 'amount' and 'currency' attributes, with a secondary organisation placing the data in the correct format
```
<amount amount="10000" currency="CAD" attributeAddedBy="BELL"/>
```
Case 3: The amount is stored in 2 different currencies with the conversion done by a secondary organisation
```
<amount amount="10000" currency="CAD"/>
<amount amount="6368" currency="USD" convertedBy="BELL"/>
```
Case 4: The 'amount' nor 'currency' attributes are used
```
<amount>10,000 CAD</amount>
```

Example

<orgInvolved>
<org refKey="ADEA"/>
<role orgRoleCode="2"/>
</orgInvolved>

Example

Case 1: Organisation code exists in the 'Organisations Names and Codes' list
```
<org refKey="MACA"/>
```
Case 2: Organisation code added by a secondary organisation
```
<org refKey="COMR" attributeAddedBy="BELL"/>
```
Case 3: Organisation code does not exist in the 'Organisations Names and Codes' list
```
<org lang="es">Instituto para la Conectividad en las Americas</assigningOrg>
```

Example

Case 1: Using the 'orgRoleCode' attribute, with the record owning organisation performing the code mappings
```
<role orgRoleCode="3" /> (executing org)
```
Case 2: Using the 'orgRoleCode' attribute, with a secondary organisation performing the code mappings
```
<role orgRoleCode="3" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'orgRoleCode' attribute
```
<role lang="en">funding source</role>
```

Example

<personInvolved>
<person emailAddress="mryan@somewhere.org">Michael Ryan</person>
<role personRoleCode="1"/>
</personInvolved>

Example

Case 1: Providing email address

<person emailAddress="mryan@somewhere.org">Michael Ryan</person>

Case 2: Not providing email address
```
<person>Coleen Smith</person>
```

Example

Case 1: Using the 'personRoleCode' attribute, with the record owning organisation performing the code mapping
```
<role personRoleCode="1" /> (signifying project manager)
```
Case 2: Using the 'personRoleCode' attribute, with a secondary organisation performing the code mapping
```
<role personRoleCode="1" attributeAddedBy="ODAC" />
```
Case 3: Not using the 'personRoleCode' attribute
```
<role lang="en">program officer</role>
```

Example

Case 1: The keyword is being provided in a single language
```
<keyword lang="en">water purification</keyword>
```
Case 2: The keyword is being provided in 2 languages with translations done by the record owning organisation
```
<keyword lang="en">water purification</keyword>
<keyword lang="fr">purification de l'eau</keyword>
```

Case 3: The keyword is being provided in 2 languages with translations done by a secondary organisation

<keyword lang="en">water purification</keyword>
<keyword lang="en" transBy="ADEA">purification de l'eau</keyword>

Example

Case 1: The abstract is being provided in a single language

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>

Case 2: The abstract is being provided in 2 languages with translations done by the record owning organisation

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>
<abstract lang="fr">Ce projet se concentre sur 2 secteurs <b><i>principaux</i></b> ...</abstract>

Case 3: The abstract is being provided in 2 languages with translations done by a secondary organisation

<abstract lang="en">This project focuses on 2 <b><i>principal</i></b> areas ...</abstract>
<abstract lang="en" transBy="ADEA">Ce projet se concentre sur 2 secteurs <b><i>principaux</i></b> ...</abstract>

Example

<relatedLink>
<label>PRISME project description (from source)</label>
<url>http://prisme.adeanet.org/index.cfm?Fuseaction=dsp_search_project_details&index=1&RefPr_list=1</url>
<lang>en</lang>
<shortDesc>Find the full project description at this location.</shortDesc>
</relatedLink>

label [0..1]

Description This contains the related link's label.

Example

<label>PRISME project description (from source)</label>

url [0..1]

Description This holds the URL (or web address) of the related link.

Example

<url>http://prisme.adeanet.org/index.cfm?Fuseaction=dsp_search_project_details&index=1&RefPr_list=1</url>

Example

<lang>en</lang>

shortDesc [0..1]

Description This contains a short description (that gives more detail than the 'label') about a link related to the project/activity.

Example

<shortDesc>Find the full project description at this location.</shortDesc>

Example

<relatedTo origin="3" dbKey="46" relation="2"/>

Example

<anotherView origin="2" dbKey="164"/>

Example

Case 1: The 'forMoreInfo' text is being provided in a single language

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>

Case 2: The 'forMoreInfo' text is being provided in 2 languages with translations done by the record owning organisation

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>
<forMoreInfo lang="fr">Pour plus d'information, prière de contacter <b><i>info@someorg.org</i></b></forMoreInfo>

Case 3: The 'forMoreInfo' text is being provided in 2 languages with translations done by a secondary organisation

<forMoreInfo lang="en">For further inquiries, please contact <b><i>info@someorg.org</i></b></forMoreInfo>
<forMoreInfo lang="en" transBy="ADEA">Pour plus d'information, prière de contacter <b><i>info@someorg.org</i></b></forMoreInfo>

Example

Case 1: Script supports 'maxBlockSize' and 'since'. The last activity 'dbKey' in the current XML document is 'P123J'. The harvester would like 25 records returned, update/inserted after Dec. 1st 2002 which are after record 'P123J' in the database.
```
<aida_spider next_block="http://www.anyorg.org/aida/scriptfile.php?maxBlockSize=25&since=2002-12-01&startAfter=P123J"/>
```
Case 2: Script supports 'country', 'since', and 'rights'. The harvester would like to have all projects/activities taking place in Benin, inserted/updated on or after Sept. 5th 2002, with rights set as 3 (May not be re-released.)
```
<aida_spider next_block="http://www.ABCorg.org/scriptfile.asp?country=BEN&since=2002-09-05&rights=3"/>
```

3.0 XML 'Template' view of the AiDA schema

<?xml version="1.0" encoding="UTF-8"?>
<activities xmlns="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd">
<activity origin="" dbKey="" date="" rights="" updateType="" submitOrg="">
<ID>
<assigningOrg refKey="" attributeAddedBy="" lang=""/>
<uniqID></uniqID>
</ID>
<title lang="" transBy=""></title>
<location locationCode="" attributeAddedBy="" lang=""></location>
<startDate date="" attributeAddedBy=""/>
<endDate date="" attributeAddedBy=""/>
<status statusCode="" attributeAddedBy="" lang=""/>
<sector refKey="" attributeAddedBy="" lang=""></sector>
<notes lang="" transBy=""></notes>
<funding>
<fundingOrg refKey="" attributeAddedBy="" lang=""></fundingOrg>
<yearly>
<yearStarting date="" attributeAddedBy=""/>
<amount amount="" currency="" attributeAddedBy="" convertedBy=""/>
</yearly>
<termsAssist terms="" attributeAddedBy=""/>
<total amount="" currency="" attributeAddedBy="" convertedBy=""/>
<byCategory>
<category lang="" transBy=""></category>
<catTotal amount="" currency="" attributeAddedBy="" convertedBy=""/>
<catYearly>
<yearStarting date="" attributeAddedBy=""/>
<amount amount="" currency="" attributeAddedBy="" convertedBy=""/>
</catYearly>
</byCategory>
</funding>
<orgInvolved>
<org refKey="" attributeAddedBy="" lang=""></org>
<role orgRoleCode="" attributeAddedBy="" lang=""></role>
</orgInvolved>
<personInvolved>
<person emailAddress=""></person>
<role personRoleCode="" attributeAddedBy="" lang=""></role>
</personInvolved>
<keyword lang="" transBy=""></keyword>
<abstract lang="" transBy=""></abstract>
<relatedLink>
<label></label>
<url></url>
<lang></lang>
<shortDesc></shortDesc>
</relatedLink>
<relatedTo origin="" dbKey="" relation=""/>
<anotherView origin="" dbKey=""/>
<forMoreInfo lang="" transBy=""></forMoreInfo>
</activity>
<aida_spider next_block=""/>
</activities>

4.0 AiDA XML Schema

The most recent version of the AiDA schema is 2.2 and is located at: http://www.idmlinitiative.org/resources/dtds/AIDA22.xsd.