How Can We Help?
Award XMLAward XML
Overview
This page details the Award content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Award content type that defines the import xml format. Also provided is mapping tables generated based on this XSD as well as an example xml that shows how the fields can be populated.
This is logical broken down into the different elements to help you gain a better understanding of the Award content type and how to create, read and update these records using the mechanisms provided in Pure.
Note: for the mapping tables all attributes and elements are listed, along with descriptions of the purposes of the field and any data requirements. Attribute are prefaced with an "@" to differentiate from elements, but as shown in the examples this isn't used when generating the xml.
Some elements offer options of which elements to include (such as whether to provide the ID of a person or organisation or name for lookup). These are denoted by reference to "Option Groups" where numbers are used to indicate where multiple elements are part of the same option. See example xmls for demonstrations of how to use these elements.
An Award in Pure is a record with information about research funding granted by a funder. Many fields are shared with the Application content type, though award records can hold unique information about the amount awarded and non-financial contributions.
Below are a series of attachments for your reference:
- Simple Example XML - This shows only the mandatory fields that need to be populated
- Advanced Example XML - This shows all fields that can be used. Snippets of this file are shown with their related elements below.
- XSD (Xml Schema Definition) - This is a definition of what structure the XML must follow. This page has been generated based on the contents of the xsd file, and snippets of the definition are shown with their relevant element below
- Editor Example PNG - This image shows the result of loading the advanced example xml into Pure, to allow for easy reference of which fields in Pure point to which elements in the XML. Note that the way the data is presented within your Pure instance may be different due to different configuration
- Webservice Example Response - This shows an example response of retrieving the record generated via this xml via the webservice
- Pure API Example Response - This shows an example response of retrieving the record generated via this xml via the Pure API. Note as the Pure API allows for creation of records, this format could also be used to create a new record with these details, but some fields would be ignored in that case (such as audit fields like created/modified by and internal Pure identifiers like UUID and Pure ID which wouldn't exist yet). UUIDs for related content (such as organisational units) would need to be updated as well.
Awards
upmawards
A list of upmaward elements of type upmaward
Root element of the xml document.
XML Example
<upmawards xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- There should be one occurrence of this element for every award you want created in Pure:-->
<upmaward id="award1" type="researchcouncils/renewal" managedInPure="false"><!--These are defined in UPM Nature of Activity Classification-->
<activityTypes>
<activityType>research</activityType>
</activityTypes>
<title><!--Can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is the title</cmns:text>
</title>
<shortTitle><!--Can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is short title</cmns:text>
</shortTitle>
<acronym>TITT</acronym>
<!--These types should be defined in the "Unified Project Model: Award Descriptions" classification scheme-->
<descriptions>
<cmns:description type="awarddescription"><!--Each description can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is the description text found in classification scheme "Unified Project Model: Award Descriptions"</cmns:text>
</cmns:description>
</descriptions>
<!--These types should be defined in "Unified Project Model: Types of Classified sources" classification scheme-->
<ids>
<cmns:id type="contractid">ContractID123123</cmns:id>
</ids>
<internalAwardholders><!--There must be at least one internal or external award holder for each award. Internal award holders should already exist as internal person records in Pure-->
<internalAwardholder><!-- This ID should be the source id the person was loaded into Pure with -->
<personId>person1</personId>
<organisationIds><!-- This ID must reference an internal organisation -->
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles are defined in the "Unified Project Model: Award Roles" classification scheme -->
<role>pi</role>
<!--Expressed as a percentage. Value should be between 0 and 1-->
<academicOwnership>1.0</academicOwnership>
<!--If start and end date aren't provided Pure will assume the association has been for the life of the award-->
<associationStartDate>2022-10-26</associationStartDate>
<associationEndDate>2023-02-14</associationEndDate>
</internalAwardholder>
</internalAwardholders>
<!-- Actual Researcher Commitment percentage should be enabled under UPM administration to use this -->
<internalAwardHolderResearcherCommitment><!-- Can include multiple researcher commitment elements, each with a unique combination of person, year and month. Dates should align with award start and end dates -->
<researcherCommitment><!-- This should correspond to the internalAwardHolders -->
<personId>person1</personId>
<year>2022</year>
<month>11</month>
<!-- These two fields are percentages, represented by numbers between 0 and 1 -->
<plannedCommitment>0.8</plannedCommitment>
<actualCommitment>0.65</actualCommitment>
</researcherCommitment>
<researcherCommitment>
<personId>person1</personId>
<year>2022</year>
<month>12</month>
<!-- Actual commitment can be omitted to plan for future months -->
<plannedCommitment>0.7</plannedCommitment>
</researcherCommitment>
</internalAwardHolderResearcherCommitment>
<externalAwardholders><!--External award holders are external persons who are associated with the award. Pure will attempt to find based on ID, then match on name to existing external people, but if not found then a new record will be created -->
<externalAwardholder id="judyfrancis">
<firstName>Judy</firstName>
<lastName>Francis</lastName>
<country>gb</country>
<role>coi</role>
<!-- Pure will attempt to find the external org based on ID, then match on name. If not found then a new record will be created -->
<externalOrgName>Oxbridge University</externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<externalOrgType>academic</externalOrgType>
<externalOrgId>externalOrganisation1</externalOrgId>
</externalAwardholder>
</externalAwardholders>
<!--Organisations associated with internal award holders will already reflect as being associated, so this should be used for cases where there is no person related-->
<organisations>
<organisation id="organisation2"/>
</organisations>
<!--External Organisations associated with award holders will already reflect as being associated, so this should be used for cases where there is no person related-->
<externalOrganisations><!--Pure will attempt to find based on ID, then match on name and if no match is found a new record will be created -->
<cmns:externalOrganisationAssociation>
<cmns:externalOrgName>Health Research Institute</cmns:externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<cmns:externalOrgType>fundingbody</cmns:externalOrgType>
<cmns:externalOrgId>externalOrganisation3</cmns:externalOrgId>
</cmns:externalOrganisationAssociation>
</externalOrganisations>
<!-- The Organisation that will be responsible for management of the award. Normally is the primary organisation unit of the first internal award holder -->
<managedByOrganisation id="organisation1"/>
<!-- Managed By Organisation can't be repeated here. Co-managing organisations should be enabled under UPM Administration to use this -->
<coManagingOrganisations>
<organisation id="organisation2"/>
</coManagingOrganisations>
<!-- Dates should be in the format YYYY-MM-DD -->
<expectedStartDate>2022-10-01</expectedStartDate>
<expectedEndDate>2024-05-22</expectedEndDate>
<actualStartDate>2022-10-05</actualStartDate>
<actualEndDate>2024-06-24</actualEndDate>
<awardDate>2022-02-20</awardDate>
<!--Requires the funding agency module to be enabled-->
<fundingAgencyStatus>active/approved</fundingAgencyStatus>
<!--Whether this award involves collaboration with external organisations-->
<collaborative>true</collaborative>
<!--If award is collaborative then use this to define who the collaborators are. Normally they should be listed against award holders or the externalOrganisations element already-->
<collaborators><!--Type should be defined in "Unified Project Model: Types of Collaborators" classification scheme-->
<cmns:collaborator type="jointapplicant">
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
<!--Only one organisation can be lead, if none are it is presumed the internal institution is lead-->
<cmns:leadCollaborator>false</cmns:leadCollaborator>
</cmns:collaborator>
</collaborators>
<!-- Must have at least one funding, whether financial or non-financial -->
<financialFundings><!--If synchronizing expenditure to existing awards this funding id should align with what is listed on the funding record in Pure-->
<financialFunding id="funding_id"><!-- Budgets should be enabled under UPM administration to load these values -->
<budgets><!--If synchronizing expenditure to existing awards this budget id should align with what is listed on the budget record in Pure-->
<budget id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>
</budgets>
<!-- These are the details of the organisation providing the funding. Pure will attempt to match existing organisations and create one if not found -->
<externalOrgName>Research Funding Inc</externalOrgName>
<externalOrgType>fundingbody</externalOrgType>
<externalOrgId>researchfundinc</externalOrgId>
<fundingSources><!--Full classification uri, from a classification scheme defined under the Funding Classification Configuration section of the Unified Project Model-->
<fundingSource>/dk/atira/pure/fundingopportunity/fundingopportunitytypes/fundingopportunity/conf</fundingSource>
</fundingSources>
<fundingProjectScheme>Annual Fellowship Programme</fundingProjectScheme>
<!--Needs to be defined in the "Subset of ISO-4217 currencies" classification scheme-->
<awardedCurrency>EUR</awardedCurrency>
<!--Awarded amount in awarded currency-->
<awardedAmountAwardedCurrency>10000</awardedAmountAwardedCurrency>
<!--Awarded amount in system currency-->
<awardedAmount>5000</awardedAmount>
<!--Optional:-->
<institutionalContribution>2000</institutionalContribution>
<!--Full economic cost-->
<institutionalFEC>15000</institutionalFEC>
<!--Full Economic Cost Percentage-->
<fECPercentage>0.8</fECPercentage>
<!-- How much the institution gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
<fundingProgrammeId>123453</fundingProgrammeId>
<fundingCollaborators>
<fundingCollaborator><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>
</fundingCollaborators>
<!-- Can be configured to be shown on either funding or budget, only one should be loaded -->
<costCode>1234-12323-2324</costCode>
<!--Funding visibility determines if the funding can be shown on the portal on related projects-->
<visibility>Confidential</visibility>
</financialFunding>
</financialFundings>
<!--Non financial funding (in-kind)-->
<nonFinancialFundings>
<nonFinancialFunding id="nonfundedid">
<externalOrgId>external_organisation_id_002</externalOrgId>
<fundingProjectScheme>Funding project scheme (research programme)</fundingProjectScheme>
<estimatedValue>25000</estimatedValue>
<institutionalEstimatedValue>15000</institutionalEstimatedValue>
<description>Researcher in-kind commitment of 200 hours over the life of the award</description>
<visibility>Public</visibility>
</nonFinancialFunding>
</nonFinancialFundings>
<!-- Milestones are only available if the module awardmangement is enabled -->
<milestones>
<milestone id="milestone01">
<name>Annual Report Due</name>
<!-- Can specify the name in all supported submision languages -->
<translatedNames>
<name lang="de">Milestone title in another language</name>
</translatedNames>
<description>A report is due to be sent to the funding body at the conclusion of the first full year of funding</description>
<!-- Can specify the description in all supported submission languages -->
<translatedDescriptions>
<description lang="de">Milestone description in another language</description>
</translatedDescriptions>
<!-- For academic milestones the responsibleRole should match the role of an awardholder on the award -->
<responsibleRole type="academic">pi</responsibleRole>
<completed>true</completed>
<deadline>31-12-2022</deadline>
<completedDate>22-12-2022</completedDate>
<!-- If not specified will default to the user running the load -->
<completedBy>atira</completedBy>
</milestone>
<milestone id="milestone02">
<name>Milestone 2</name>
<responsibleRole type="administrative">assisting-editor</responsibleRole>
<deadline>6-3-2022</deadline>
<reminders><!--This will set a reminder to be sent to the assigned user 1 week before the deadline-->
<reminder id="1" timeUnit="week">1</reminder>
<!--This will set a reminder to be sent to the assigned user 2 days before the deadline-->
<reminder id="2" timeUnit="day">2</reminder>
</reminders>
</milestone>
<milestone id="milestone03">
<name>Milestone 3</name>
<responsibleRole type="academic">pi</responsibleRole>
<deadline>10-04-2023</deadline>
<documents>
<document id="doc1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Cumberland_258.jpg/1280px-Cumberland_258.jpg</fileLocation>
<mimetype>image/jpeg</mimetype>
<filename>Milestone.jpg</filename>
<name>Milestone</name>
</document>
</documents>
</milestone>
</milestones>
<!-- Related awards should already exist in Pure or be included in this xml-->
<relatedAwards>
<relatedAwardId>award2</relatedAwardId>
</relatedAwards>
<!-- Related applications should already exist in Pure-->
<relatedApplications>
<relatedApplicationId>application1</relatedApplicationId>
</relatedApplications>
<!-- Related projects should already exist in Pure, or can be created as part of the XML bulk import of the award xml-->
<relatedProjectId>project1</relatedProjectId>
<documents>
<cmns:upmdocuments id="doc1"><!-- Type should be defined in the "Award Management: Award Document types" classification scheme -->
<cmns:type>agreement</cmns:type>
<!-- Can be http url, path on file server or base64 encoded data of the document -->
<cmns:file>
<cmns:http>
<cmns:url>https://upload.wikimedia.org/wikipedia/commons/b/b8/NJROTC_Awards.jpg</cmns:url>
</cmns:http>
</cmns:file>
<cmns:mimeType>image/jpeg</cmns:mimeType>
<cmns:fileName>awarddoc.jpg</cmns:fileName>
<cmns:title>Award Agreement</cmns:title>
<cmns:visibility>Restricted</cmns:visibility>
</cmns:upmdocuments>
</documents>
<keywords>
<cmns:keyword>Free text keyword value</cmns:keyword>
<cmns:keyword logicalName="/dk/atira/pure/fundingopportunity/eligibility" key="women"/>
</keywords>
<links>
<cmns:link id="a link id">
<cmns:url>http://google.com</cmns:url>
<!--Should be defined in the "Types of links for Awards" classification scheme-->
<cmns:type>unspecified</cmns:type>
<!--Optional:-->
<cmns:description><!--1 or more repetitions:-->
<cmns:text lang="en" country="GB">A link description text</cmns:text>
</cmns:description>
</cmns:link>
</links>
<!-- This element is only enabled when AWARD MANAGEMENT is enabled in pure.
Status can be Terminated, InternallyApproved, ContractNegotiation
Status reason can be Curtailed or Declined. -->
<status>
<status>Terminated</status>
<statusDate>2023-07-11</statusDate>
<!-- These two fields should only be used if status is Terminated -->
<statusReason>Curtailed</statusReason>
<statusReasonDescription>Why the award was terminated</statusReasonDescription>
</status>
<!--Should only be used if the award status is terminated and the reason is curtailed -->
<curtailed>
<date>2023-08-19</date>
<reason>Description of why it was curtailed</reason>
</curtailed>
<!--
Visibility will control whether the award information is displayed on its related project in the portal
Confidential can be used to hide from other Pure users
-->
<visibility>Restricted</visibility>
</upmaward>
<upmaward id="award2" type="researchcouncils/award">
<title>
<cmns:text lang="en" country="GB">This is the title of second award</cmns:text>
</title>
<internalAwardholders>
<internalAwardholder>
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<role>pi</role>
</internalAwardholder>
</internalAwardholders>
<managedByOrganisation id="organisation1"/>
<awardDate>2011-04-05+01:00</awardDate>
<financialFundings>
<financialFunding id="finfunding">
<externalOrgName>external funder organisation</externalOrgName>
</financialFunding>
</financialFundings>
<visibility>Restricted</visibility>
</upmaward>
</upmawards>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="upmawards">
<xs:annotation>
<xs:documentation>Root element of the xml document.</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="upmaward" minOccurs="0" maxOccurs="unbounded"/>
</xs:sequence>
<xs:attribute name="resumptionToken" type="xs:string">
<xs:annotation>
<xs:documentation>
To enable resumption tokens, add an URL to the "XML source data location" in the job configuration with "{resumptionToken}" as a placeholder, for instance "https://example.org/data?resumptionToken={resumptionToken}".
The endpoint must handle the resumptionToken in the following manner:
If an empty resumptionToken is sent, the endpoint must return all data. If a non-empty resumptionToken is sent, the endpoint must return all data that has changed since the time the resumptionToken was sent.
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>upmaward
This xml element is used to define an award to synchronise into Pure. This means that one entry in the xml has to exist per award you want to have in Pure. For each award you have to specify a unique ID, which will be the primary source ID for identifiying this award in the synchronisation.
This ID is for synchronisation purposes only, it has to be unique for each award and cannot change over time.
XML Example
<upmaward xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="award1"
type="researchcouncils/renewal"
managedInPure="false"><!--These are defined in UPM Nature of Activity Classification-->
<activityTypes>
<activityType>research</activityType>
</activityTypes>
<title><!--Can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is the title</cmns:text>
</title>
<shortTitle><!--Can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is short title</cmns:text>
</shortTitle>
<acronym>TITT</acronym>
<!--These types should be defined in the "Unified Project Model: Award Descriptions" classification scheme-->
<descriptions>
<cmns:description type="awarddescription"><!--Each description can be repeated for each submission language you have setup in Pure-->
<cmns:text lang="en" country="GB">This is the description text found in classification scheme "Unified Project Model: Award Descriptions"</cmns:text>
</cmns:description>
</descriptions>
<!--These types should be defined in "Unified Project Model: Types of Classified sources" classification scheme-->
<ids>
<cmns:id type="contractid">ContractID123123</cmns:id>
</ids>
<internalAwardholders><!--There must be at least one internal or external award holder for each award. Internal award holders should already exist as internal person records in Pure-->
<internalAwardholder><!-- This ID should be the source id the person was loaded into Pure with -->
<personId>person1</personId>
<organisationIds><!-- This ID must reference an internal organisation -->
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles are defined in the "Unified Project Model: Award Roles" classification scheme -->
<role>pi</role>
<!--Expressed as a percentage. Value should be between 0 and 1-->
<academicOwnership>1.0</academicOwnership>
<!--If start and end date aren't provided Pure will assume the association has been for the life of the award-->
<associationStartDate>2022-10-26</associationStartDate>
<associationEndDate>2023-02-14</associationEndDate>
</internalAwardholder>
</internalAwardholders>
<!-- Actual Researcher Commitment percentage should be enabled under UPM administration to use this -->
<internalAwardHolderResearcherCommitment><!-- Can include multiple researcher commitment elements, each with a unique combination of person, year and month. Dates should align with award start and end dates -->
<researcherCommitment><!-- This should correspond to the internalAwardHolders -->
<personId>person1</personId>
<year>2022</year>
<month>11</month>
<!-- These two fields are percentages, represented by numbers between 0 and 1 -->
<plannedCommitment>0.8</plannedCommitment>
<actualCommitment>0.65</actualCommitment>
</researcherCommitment>
<researcherCommitment>
<personId>person1</personId>
<year>2022</year>
<month>12</month>
<!-- Actual commitment can be omitted to plan for future months -->
<plannedCommitment>0.7</plannedCommitment>
</researcherCommitment>
</internalAwardHolderResearcherCommitment>
<externalAwardholders><!--External award holders are external persons who are associated with the award. Pure will attempt to find based on ID, then match on name to existing external people, but if not found then a new record will be created -->
<externalAwardholder id="judyfrancis">
<firstName>Judy</firstName>
<lastName>Francis</lastName>
<country>gb</country>
<role>coi</role>
<!-- Pure will attempt to find the external org based on ID, then match on name. If not found then a new record will be created -->
<externalOrgName>Oxbridge University</externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<externalOrgType>academic</externalOrgType>
<externalOrgId>externalOrganisation1</externalOrgId>
</externalAwardholder>
</externalAwardholders>
<!--Organisations associated with internal award holders will already reflect as being associated, so this should be used for cases where there is no person related-->
<organisations>
<organisation id="organisation2"/>
</organisations>
<!--External Organisations associated with award holders will already reflect as being associated, so this should be used for cases where there is no person related-->
<externalOrganisations><!--Pure will attempt to find based on ID, then match on name and if no match is found a new record will be created -->
<cmns:externalOrganisationAssociation>
<cmns:externalOrgName>Health Research Institute</cmns:externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<cmns:externalOrgType>fundingbody</cmns:externalOrgType>
<cmns:externalOrgId>externalOrganisation3</cmns:externalOrgId>
</cmns:externalOrganisationAssociation>
</externalOrganisations>
<!-- The Organisation that will be responsible for management of the award. Normally is the primary organisation unit of the first internal award holder -->
<managedByOrganisation id="organisation1"/>
<!-- Managed By Organisation can't be repeated here. Co-managing organisations should be enabled under UPM Administration to use this -->
<coManagingOrganisations>
<organisation id="organisation2"/>
</coManagingOrganisations>
<!-- Dates should be in the format YYYY-MM-DD -->
<expectedStartDate>2022-10-01</expectedStartDate>
<expectedEndDate>2024-05-22</expectedEndDate>
<actualStartDate>2022-10-05</actualStartDate>
<actualEndDate>2024-06-24</actualEndDate>
<awardDate>2022-02-20</awardDate>
<!--Requires the funding agency module to be enabled-->
<fundingAgencyStatus>active/approved</fundingAgencyStatus>
<!--Whether this award involves collaboration with external organisations-->
<collaborative>true</collaborative>
<!--If award is collaborative then use this to define who the collaborators are. Normally they should be listed against award holders or the externalOrganisations element already-->
<collaborators><!--Type should be defined in "Unified Project Model: Types of Collaborators" classification scheme-->
<cmns:collaborator type="jointapplicant">
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
<!--Only one organisation can be lead, if none are it is presumed the internal institution is lead-->
<cmns:leadCollaborator>false</cmns:leadCollaborator>
</cmns:collaborator>
</collaborators>
<!-- Must have at least one funding, whether financial or non-financial -->
<financialFundings><!--If synchronizing expenditure to existing awards this funding id should align with what is listed on the funding record in Pure-->
<financialFunding id="funding_id"><!-- Budgets should be enabled under UPM administration to load these values -->
<budgets><!--If synchronizing expenditure to existing awards this budget id should align with what is listed on the budget record in Pure-->
<budget id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>
</budgets>
<!-- These are the details of the organisation providing the funding. Pure will attempt to match existing organisations and create one if not found -->
<externalOrgName>Research Funding Inc</externalOrgName>
<externalOrgType>fundingbody</externalOrgType>
<externalOrgId>researchfundinc</externalOrgId>
<fundingSources><!--Full classification uri, from a classification scheme defined under the Funding Classification Configuration section of the Unified Project Model-->
<fundingSource>/dk/atira/pure/fundingopportunity/fundingopportunitytypes/fundingopportunity/conf</fundingSource>
</fundingSources>
<fundingProjectScheme>Annual Fellowship Programme</fundingProjectScheme>
<!--Needs to be defined in the "Subset of ISO-4217 currencies" classification scheme-->
<awardedCurrency>EUR</awardedCurrency>
<!--Awarded amount in awarded currency-->
<awardedAmountAwardedCurrency>10000</awardedAmountAwardedCurrency>
<!--Awarded amount in system currency-->
<awardedAmount>5000</awardedAmount>
<!--Optional:-->
<institutionalContribution>2000</institutionalContribution>
<!--Full economic cost-->
<institutionalFEC>15000</institutionalFEC>
<!--Full Economic Cost Percentage-->
<fECPercentage>0.8</fECPercentage>
<!-- How much the institution gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
<fundingProgrammeId>123453</fundingProgrammeId>
<fundingCollaborators>
<fundingCollaborator><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>
</fundingCollaborators>
<!-- Can be configured to be shown on either funding or budget, only one should be loaded -->
<costCode>1234-12323-2324</costCode>
<!--Funding visibility determines if the funding can be shown on the portal on related projects-->
<visibility>Confidential</visibility>
</financialFunding>
</financialFundings>
<!--Non financial funding (in-kind)-->
<nonFinancialFundings>
<nonFinancialFunding id="nonfundedid">
<externalOrgId>external_organisation_id_002</externalOrgId>
<fundingProjectScheme>Funding project scheme (research programme)</fundingProjectScheme>
<estimatedValue>25000</estimatedValue>
<institutionalEstimatedValue>15000</institutionalEstimatedValue>
<description>Researcher in-kind commitment of 200 hours over the life of the award</description>
<visibility>Public</visibility>
</nonFinancialFunding>
</nonFinancialFundings>
<!-- Milestones are only available if the module awardmangement is enabled -->
<milestones>
<milestone id="milestone01">
<name>Annual Report Due</name>
<!-- Can specify the name in all supported submision languages -->
<translatedNames>
<name lang="de">Milestone title in another language</name>
</translatedNames>
<description>A report is due to be sent to the funding body at the conclusion of the first full year of funding</description>
<!-- Can specify the description in all supported submission languages -->
<translatedDescriptions>
<description lang="de">Milestone description in another language</description>
</translatedDescriptions>
<!-- For academic milestones the responsibleRole should match the role of an awardholder on the award -->
<responsibleRole type="academic">pi</responsibleRole>
<completed>true</completed>
<deadline>31-12-2022</deadline>
<completedDate>22-12-2022</completedDate>
<!-- If not specified will default to the user running the load -->
<completedBy>atira</completedBy>
</milestone>
<milestone id="milestone02">
<name>Milestone 2</name>
<responsibleRole type="administrative">assisting-editor</responsibleRole>
<deadline>6-3-2022</deadline>
<reminders><!--This will set a reminder to be sent to the assigned user 1 week before the deadline-->
<reminder id="1" timeUnit="week">1</reminder>
<!--This will set a reminder to be sent to the assigned user 2 days before the deadline-->
<reminder id="2" timeUnit="day">2</reminder>
</reminders>
</milestone>
<milestone id="milestone03">
<name>Milestone 3</name>
<responsibleRole type="academic">pi</responsibleRole>
<deadline>10-04-2023</deadline>
<documents>
<document id="doc1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Cumberland_258.jpg/1280px-Cumberland_258.jpg</fileLocation>
<mimetype>image/jpeg</mimetype>
<filename>Milestone.jpg</filename>
<name>Milestone</name>
</document>
</documents>
</milestone>
</milestones>
<!-- Related awards should already exist in Pure or be included in this xml-->
<relatedAwards>
<relatedAwardId>award2</relatedAwardId>
</relatedAwards>
<!-- Related applications should already exist in Pure-->
<relatedApplications>
<relatedApplicationId>application1</relatedApplicationId>
</relatedApplications>
<!-- Related projects should already exist in Pure, or can be created as part of the XML bulk import of the award xml-->
<relatedProjectId>project1</relatedProjectId>
<documents>
<cmns:upmdocuments id="doc1"><!-- Type should be defined in the "Award Management: Award Document types" classification scheme -->
<cmns:type>agreement</cmns:type>
<!-- Can be http url, path on file server or base64 encoded data of the document -->
<cmns:file>
<cmns:http>
<cmns:url>https://upload.wikimedia.org/wikipedia/commons/b/b8/NJROTC_Awards.jpg</cmns:url>
</cmns:http>
</cmns:file>
<cmns:mimeType>image/jpeg</cmns:mimeType>
<cmns:fileName>awarddoc.jpg</cmns:fileName>
<cmns:title>Award Agreement</cmns:title>
<cmns:visibility>Restricted</cmns:visibility>
</cmns:upmdocuments>
</documents>
<keywords>
<cmns:keyword>Free text keyword value</cmns:keyword>
<cmns:keyword logicalName="/dk/atira/pure/fundingopportunity/eligibility" key="women"/>
</keywords>
<links>
<cmns:link id="a link id">
<cmns:url>http://google.com</cmns:url>
<!--Should be defined in the "Types of links for Awards" classification scheme-->
<cmns:type>unspecified</cmns:type>
<!--Optional:-->
<cmns:description><!--1 or more repetitions:-->
<cmns:text lang="en" country="GB">A link description text</cmns:text>
</cmns:description>
</cmns:link>
</links>
<!-- This element is only enabled when AWARD MANAGEMENT is enabled in pure.
Status can be Terminated, InternallyApproved, ContractNegotiation
Status reason can be Curtailed or Declined. -->
<status>
<status>Terminated</status>
<statusDate>2023-07-11</statusDate>
<!-- These two fields should only be used if status is Terminated -->
<statusReason>Curtailed</statusReason>
<statusReasonDescription>Why the award was terminated</statusReasonDescription>
</status>
<!--Should only be used if the award status is terminated and the reason is curtailed -->
<curtailed>
<date>2023-08-19</date>
<reason>Description of why it was curtailed</reason>
</curtailed>
<!--
Visibility will control whether the award information is displayed on its related project in the portal
Confidential can be used to hide from other Pure users
-->
<visibility>Restricted</visibility>
</upmaward>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="upmaward">
<xs:annotation>
<xs:documentation>
This xml element is used to define an award to synchronise into Pure. This means that one entry in the xml has to exist per award you want to have in Pure. For each award you have to specify a unique ID, which will be the primary source ID for identifiying this award in the synchronisation.
This ID is for synchronisation purposes only, it has to be unique for each award and cannot change over time.
</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:all>
<xs:element name="activityTypes" type="activityTypes" minOccurs="0">
<xs:annotation>
<xs:documentation>A collection of nature of activity tags. Must be defined in the /dk/atira/pure/upm/nature classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:localized_string">
<xs:annotation>
<xs:documentation>The title of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="shortTitle" type="commons:localized_string" minOccurs="0">
<xs:annotation>
<xs:documentation>The short title of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="acronym" type="commons:string_64" minOccurs="0">
<xs:annotation>
<xs:documentation>The acronym of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="descriptions" type="commons:descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>The descriptions of the award. Description types must be defined in the /dk/atira/pure/award/descriptions classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="commons:ids" minOccurs="0">
<xs:annotation>
<xs:documentation>The ids of the award. Types of IDs must be defined in the /dk/atira/pure/upm/classifiedsource classification</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="internalAwardholders"
type="internalAwardholders"
minOccurs="0">
<xs:annotation>
<xs:documentation>The internal persons related to the award. NOTE there needs to be at least one internalAwardHolder OR externalAwardholder</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="internalAwardHolderResearcherCommitment"
type="researcherCommitmentList"
minOccurs="0">
<xs:annotation>
<xs:documentation>The internal participants researcher commitment for the application</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalAwardholders"
type="externalAwardholders"
minOccurs="0">
<xs:annotation>
<xs:documentation>The external persons related to the award NOTE there needs to be at least one internalAwardHolder OR externalAwardholder</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="coManagingOrganisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The Co-ManagingOrganisations, can not be the managedByOrganisation. Can be enabled under Administrator -> Unified Project Model in Pure</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal organisations related to the award. This would normally only be used for internal organisations that aren't already affiliated as part of an internal award holder</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrganisations"
type="commons:externalOrganisationAssociations"
minOccurs="0">
<xs:annotation>
<xs:documentation>The external organisations related to the award. This would normally only be used for external organisations that don't already have an affiliation on a person who is listed on to the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managedByOrganisation" type="organisation">
<xs:annotation>
<xs:documentation>The internal organisation unit that manages the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="expectedStartDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date the award was expected to start</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="expectedEndDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date the award was expected to end</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="actualStartDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The actual start date of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="actualEndDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The actual end date of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="awardDate" type="commons:date">
<xs:annotation>
<xs:documentation>The date this award was or will be awarded</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="curtailed" type="curtailed" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies that the project is curtailed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingAgencyStatus"
type="commons:classification"
minOccurs="0">
<xs:annotation>
<xs:documentation>The funding agency status. Provide the last two tokens from a classification from the /dk/atira/pure/award/fundingagencystatus schema (e.g. "active/approved"). Can only be used when the funding agency module is enabled</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="collaborative" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifiy whether it is a collaborative award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="collaborators"
type="commons:externalCollaborators"
minOccurs="0">
<xs:annotation>
<xs:documentation>The collaborative partners on the award. Should only be used if collaborative is true</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="financialFundings" type="financialFundings" minOccurs="0">
<xs:annotation>
<xs:documentation>The financial fundings added to the award. At least one of either financialFunding or nonFinancialFunding must be present.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="nonFinancialFundings"
type="nonFinancialFundings"
minOccurs="0">
<xs:annotation>
<xs:documentation>The non financial (in-kind) fundings added to the award. At least one of either financialFunding or nonFinancialFunding must be present.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedAwards" type="relatedAwards" minOccurs="0">
<xs:annotation>
<xs:documentation>Other awards related to the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedApplications" type="relatedApplications" minOccurs="0">
<xs:annotation>
<xs:documentation>Related applications to the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="commons:upmdocuments" minOccurs="0">
<xs:annotation>
<xs:documentation>Documents attached to the award. Types must be defined in /dk/atira/pure/award/document/types classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="commons:keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>The keywords for the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>The links for the project. Types should be defined in the /dk/atira/pure/links/award classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility">
<xs:annotation>
<xs:documentation>The visibility of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedProjectId"
type="commons:non_explicit_id"
minOccurs="0">
<xs:annotation>
<xs:documentation>The id of the project the award in question should be related to. When using bulk import projects can be created automatically and related to the award, or this field can be used but the project must already exist in Pure</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="milestones" type="milestones" minOccurs="0">
<xs:annotation>
<xs:documentation>A collection of milestones that represent tasks to be completed. Requires the Award Management Module</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="status" type="status" minOccurs="0">
<xs:annotation>
<xs:documentation>The status of the award. Award management is needed for this.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="workflow" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Basic Workflow valid values: entryInProgress, forApproval, approved, validated or closed
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="xs:string" name="id" use="required">
<xs:annotation>
<xs:documentation>Id of the award in the source system</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>key token from the classification /dk/atira/pure/award/awardtypes/award, found in classification scheme /dk/atira/pure/award/awardtypes/. Key must whole part after uri, eg. researchcouncils/award</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Whether the record is managed in Pure after creation or by the XML synchronisation. If you wish to update the record via XML post creation, this must be "false"</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the award in the source system |
xsd:string |
Yes |
@type |
key token from the classification /dk/atira/pure/award/awardtypes/award, found in classification scheme /dk/atira/pure/award/awardtypes/. Key must whole part after uri, eg. researchcouncils/award |
Yes |
|
@managedInPure |
Whether the record is managed in Pure after creation or by the XML synchronisation. If you wish to update the record via XML post creation, this must be "false" |
xsd:boolean |
Yes |
activityTypes |
A collection of nature of activity tags. Must be defined in the /dk/atira/pure/upm/nature classification scheme |
No |
|
title |
The title of the award |
Yes |
|
shortTitle |
The short title of the award |
No |
|
acronym |
The acronym of the award |
No |
|
descriptions |
The descriptions of the award. Description types must be defined in the /dk/atira/pure/award/descriptions classification scheme |
No |
|
ids |
The ids of the award. Types of IDs must be defined in the /dk/atira/pure/upm/classifiedsource classification |
No |
|
internalAwardholders |
The internal persons related to the award. NOTE there needs to be at least one internalAwardHolder OR externalAwardholder |
No |
|
internalAwardHolderResearcherCommitment |
The internal participants researcher commitment for the application |
No |
|
externalAwardholders |
The external persons related to the award NOTE there needs to be at least one internalAwardHolder OR externalAwardholder |
No |
|
coManagingOrganisations |
The Co-ManagingOrganisations, can not be the managedByOrganisation. Can be enabled under Administrator -> Unified Project Model in Pure |
No |
|
organisations |
The internal organisations related to the award. This would normally only be used for internal organisations that aren't already affiliated as part of an internal award holder |
No |
|
externalOrganisations |
The external organisations related to the award. This would normally only be used for external organisations that don't already have an affiliation on a person who is listed on to the award |
No |
|
managedByOrganisation |
The internal organisation unit that manages the award |
Yes |
|
expectedStartDate |
The date the award was expected to start |
No |
|
expectedEndDate |
The date the award was expected to end |
No |
|
actualStartDate |
The actual start date of the award |
No |
|
actualEndDate |
The actual end date of the award |
No |
|
awardDate |
The date this award was or will be awarded |
Yes |
|
curtailed |
Specifies that the project is curtailed |
No |
|
fundingAgencyStatus |
The funding agency status. Provide the last two tokens from a classification from the /dk/atira/pure/award/fundingagencystatus schema (e.g. "active/approved"). Can only be used when the funding agency module is enabled |
No |
|
collaborative |
Specifiy whether it is a collaborative award |
xsd:boolean |
No |
collaborators |
The collaborative partners on the award. Should only be used if collaborative is true |
No |
|
financialFundings |
The financial fundings added to the award. At least one of either financialFunding or nonFinancialFunding must be present. |
No |
|
nonFinancialFundings |
The non financial (in-kind) fundings added to the award. At least one of either financialFunding or nonFinancialFunding must be present. |
No |
|
relatedAwards |
Other awards related to the award |
No |
|
relatedApplications |
Related applications to the award |
No |
|
documents |
Documents attached to the award. Types must be defined in /dk/atira/pure/award/document/types classification scheme |
No |
|
keywords |
The keywords for the award |
No |
|
links |
The links for the project. Types should be defined in the /dk/atira/pure/links/award classification scheme |
No |
|
visibility |
The visibility of the award |
Yes |
|
relatedProjectId |
The id of the project the award in question should be related to. When using bulk import projects can be created automatically and related to the award, or this field can be used but the project must already exist in Pure |
No |
|
milestones |
A collection of milestones that represent tasks to be completed. Requires the Award Management Module |
No |
|
status |
The status of the award. Award management is needed for this. |
No |
|
workflow |
Basic Workflow valid values: entryInProgress, forApproval, approved, validated or closed |
xsd:string |
No |
Status and Nature
activityTypes
A list of activityType elements of type commons:classification
A collection of tags indicating the type of activities that the award entails
XML Example
<activityTypes xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<activityType>research</activityType>
</activityTypes>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="activityTypes">
<xs:annotation>
<xs:documentation>A collection of tags indicating the type of activities that the award entails</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="activityType"
type="commons:classification"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>key token from the classification scheme /dk/atira/pure/upm/nature, eg. fellowship</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
activityType |
key token from the classification scheme /dk/atira/pure/upm/nature, eg. fellowship |
No |
curtailed
Details of why an award was ended early
XML Example
<curtailed xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<date>2023-08-19</date>
<reason>Description of why it was curtailed</reason>
</curtailed>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="curtailed">
<xs:annotation>
<xs:documentation>Details of why an award was ended early</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="date" type="commons:date">
<xs:annotation>
<xs:documentation>Date the award was curtailed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reason" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Reason the award was curtailed</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
date |
Date the award was curtailed |
Yes |
|
reason |
Reason the award was curtailed |
xsd:string |
No |
status
Information of the status of the award
XML Example
<status xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<status>Terminated</status>
<statusDate>2023-07-11</statusDate>
<!-- These two fields should only be used if status is Terminated -->
<statusReason>Curtailed</statusReason>
<statusReasonDescription>Why the award was terminated</statusReasonDescription>
</status>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="status">
<xs:annotation>
<xs:documentation>Information of the status of the award</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="status" type="statusState" minOccurs="0">
<xs:annotation>
<xs:documentation>The status of the award, valid values are InternallyApproved, Terminated and ContractNegotiation, but ContractNegotiation must be enabled under Award Management administration</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date the award was internally approved</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusReason" type="statusStateReason" minOccurs="0">
<xs:annotation>
<xs:documentation>If the status is terminated, the reason the award is terminated. Possible values are Curtailed or Declined</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="statusReasonDescription"
type="commons:string_1024"
minOccurs="0">
<xs:annotation>
<xs:documentation>Free text description of why the award was terminated</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
status |
The status of the award, valid values are InternallyApproved, Terminated and ContractNegotiation, but ContractNegotiation must be enabled under Award Management administration |
No |
|
statusDate |
The date the award was internally approved |
No |
|
statusReason |
If the status is terminated, the reason the award is terminated. Possible values are Curtailed or Declined |
No |
|
statusReasonDescription |
Free text description of why the award was terminated |
No |
statusState
XSD Definition
<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="statusState">
<xs:restriction base="xs:string">
<xs:enumeration value="InternallyApproved"/>
<xs:enumeration value="Terminated"/>
<xs:enumeration value="ContractNegotiation"/>
</xs:restriction>
</xs:simpleType>Restricted value: xs:string
Type |
Value |
Comments |
|---|---|---|
xs:enumeration |
InternallyApproved |
|
xs:enumeration |
Terminated |
|
xs:enumeration |
ContractNegotiation |
|
statusStateReason
XSD Definition
<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="statusStateReason">
<xs:restriction base="xs:string">
<xs:enumeration value="Curtailed"/>
<xs:enumeration value="Declined"/>
</xs:restriction>
</xs:simpleType>Restricted value: xs:string
Type |
Value |
Comments |
|---|---|---|
xs:enumeration |
Curtailed |
|
xs:enumeration |
Declined |
|
Award Holders
internalAwardholders
A list of internalAwardholder elements of type internalAwardholder
These are people who are internal to the institution (e.g. staff or students) who are listed as award holders.
XML Example
<internalAwardholders xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--There must be at least one internal or external award holder for each award. Internal award holders should already exist as internal person records in Pure-->
<internalAwardholder><!-- This ID should be the source id the person was loaded into Pure with -->
<personId>person1</personId>
<organisationIds><!-- This ID must reference an internal organisation -->
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles are defined in the "Unified Project Model: Award Roles" classification scheme -->
<role>pi</role>
<!--Expressed as a percentage. Value should be between 0 and 1-->
<academicOwnership>1.0</academicOwnership>
<!--If start and end date aren't provided Pure will assume the association has been for the life of the award-->
<associationStartDate>2022-10-26</associationStartDate>
<associationEndDate>2023-02-14</associationEndDate>
</internalAwardholder>
</internalAwardholders>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="internalAwardholders">
<xs:annotation>
<xs:documentation>These are people who are internal to the institution (e.g. staff or students) who are listed as award holders.</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="internalAwardholder"
type="internalAwardholder"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>internalAwardholder
A person who is internal to the institution and listed as an investigator of the award. They may be related to an internal organisation unit but if their involvement in the award is before them joining the institution then they can be affiliated to an external organisation
XML Example
<internalAwardholder xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- This ID should be the source id the person was loaded into Pure with -->
<personId>person1</personId>
<organisationIds><!-- This ID must reference an internal organisation -->
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles are defined in the "Unified Project Model: Award Roles" classification scheme -->
<role>pi</role>
<!--Expressed as a percentage. Value should be between 0 and 1-->
<academicOwnership>1.0</academicOwnership>
<!--If start and end date aren't provided Pure will assume the association has been for the life of the award-->
<associationStartDate>2022-10-26</associationStartDate>
<associationEndDate>2023-02-14</associationEndDate>
</internalAwardholder>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="internalAwardholder">
<xs:annotation>
<xs:documentation>A person who is internal to the institution and listed as an investigator of the award. They may be related to an internal organisation unit but if their involvement in the award is before them joining the institution then they can be affiliated to an external organisation</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="personId" type="commons:string_400">
<xs:annotation>
<xs:documentation>The source id of the person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:choice>
<xs:element name="organisationId" type="commons:string_400">
<xs:annotation>
<xs:documentation>The source id of the organisation DEPRECATED: This element has been replaced by organisationIds</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisationIds" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The source id of the organisation. The organisations related to the award holder</xs:documentation>
</xs:annotation>
</xs:element>
</xs:choice>
<xs:element name="role" type="commons:classification">
<xs:annotation>
<xs:documentation>Token from the classification scheme /dk/atira/pure/award/roles/award, eg pi</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="academicOwnership" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The academic ownership percentage of the award for this participant, must be enabled in Unified Project Model administration to display. Value should be between 0 and 1</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="associationStartDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date when the award participant association to the award started. If neither start and end date are provided then it is assumed they have be associated the entire time of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="associationEndDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date when the award participant association to the award ended If neither start and end date are provided then it is assumed they have be associated the entire time of the award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="plannedResearcherCommitment" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The planned researcher commitment for this awardholder expressed as a percentage, must be enabled in Unified Project Model administration to display. Value should be between 0 and 1</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
personId |
The source id of the person |
Yes |
|
role |
Token from the classification scheme /dk/atira/pure/award/roles/award, eg pi |
Yes |
|
academicOwnership |
The academic ownership percentage of the award for this participant, must be enabled in Unified Project Model administration to display. Value should be between 0 and 1 |
xsd:double |
No |
associationStartDate |
The date when the award participant association to the award started. If neither start and end date are provided then it is assumed they have be associated the entire time of the award |
No |
|
associationEndDate |
The date when the award participant association to the award ended If neither start and end date are provided then it is assumed they have be associated the entire time of the award |
No |
|
plannedResearcherCommitment |
The planned researcher commitment for this awardholder expressed as a percentage, must be enabled in Unified Project Model administration to display. Value should be between 0 and 1 |
xsd:double |
No |
externalAwardholders
A list of externalAwardholder elements of type externalAwardholder
XML Example
<externalAwardholders xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--External award holders are external persons who are associated with the award. Pure will attempt to find based on ID, then match on name to existing external people, but if not found then a new record will be created -->
<externalAwardholder id="judyfrancis">
<firstName>Judy</firstName>
<lastName>Francis</lastName>
<country>gb</country>
<role>coi</role>
<!-- Pure will attempt to find the external org based on ID, then match on name. If not found then a new record will be created -->
<externalOrgName>Oxbridge University</externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<externalOrgType>academic</externalOrgType>
<externalOrgId>externalOrganisation1</externalOrgId>
</externalAwardholder>
</externalAwardholders>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalAwardholders">
<xs:sequence>
<xs:element name="externalAwardholder"
type="externalAwardholder"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>externalAwardholder
A person who is external to the institution and listed as an investigator of the award. Pure will attempt to match to existing external person records based on ID and Name but if not found then a new External Person will be created automatically
XML Example
<externalAwardholder xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="judyfrancis">
<firstName>Judy</firstName>
<lastName>Francis</lastName>
<country>gb</country>
<role>coi</role>
<!-- Pure will attempt to find the external org based on ID, then match on name. If not found then a new record will be created -->
<externalOrgName>Oxbridge University</externalOrgName>
<!-- Type must be defined in "Types of External organisations" classification scheme -->
<externalOrgType>academic</externalOrgType>
<externalOrgId>externalOrganisation1</externalOrgId>
</externalAwardholder>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalAwardholder">
<xs:annotation>
<xs:documentation>A person who is external to the institution and listed as an investigator of the award. Pure will attempt to match to existing external person records based on ID and Name but if not found then a new External Person will be created automatically</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="externalPersonId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>The source id of the external person.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="firstName" type="commons:string_1024">
<xs:annotation>
<xs:documentation>First name of the participant</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024">
<xs:annotation>
<xs:documentation>Last name of the participant</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>key token from the classification scheme /dk/atira/pure/core/countries, eg dk</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="commons:classification">
<xs:annotation>
<xs:documentation>key token from the classification scheme /dk/atira/pure/award/roles/award, eg coi</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of an external organisation for this participantDEPRECATED: This element has been replaced by externalOrganisationsWill be deleted in Pure 5.14.0</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgType" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
key token from the classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes, eg ueoexternalorganisation/researchFundingBody
DEPRECATED: This element has been replaced by externalOrganisations
Will be deleted in Pure 5.14.0
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>
Source id of an external organisation
DEPRECATED: This element has been replaced by externalOrganisations
Will be deleted in Pure 5.14.0
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrganisations"
type="commons:externalOrganisationAssociations"
minOccurs="0">
<xs:annotation>
<xs:documentation>The external organisations related to the award holder. Will attempt to match to existing external organisations but if not found a new record will be created</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="period" type="commons:dateRange" minOccurs="0">
<xs:annotation>
<xs:documentation>The period during which the external award holder was involved in the award. If not provided then Pure will assume they are involved for the entire award</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
<xs:attribute name="id" type="commons:string_400" use="optional">
<xs:annotation>
<xs:documentation>The ID of the external awardholder. This is used to identify investigators on the award for synchronisation purposes and is not displayed in the editor</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The ID of the external awardholder. This is used to identify investigators on the award for synchronisation purposes and is not displayed in the editor |
Yes |
|
externalPersonId |
The source id of the external person. |
No |
|
firstName |
First name of the participant |
Yes |
|
lastName |
Last name of the participant |
Yes |
|
country |
key token from the classification scheme /dk/atira/pure/core/countries, eg dk |
No |
|
role |
key token from the classification scheme /dk/atira/pure/award/roles/award, eg coi |
Yes |
|
externalOrganisations |
The external organisations related to the award holder. Will attempt to match to existing external organisations but if not found a new record will be created |
No |
|
period |
The period during which the external award holder was involved in the award. If not provided then Pure will assume they are involved for the entire award |
No |
organisations
A list of organisation elements of type organisation
XML Example
<organisations xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<organisation id="organisation2"/>
</organisations>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisations">
<xs:sequence>
<xs:element name="organisation" type="organisation" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>organisation
An ID of an internal organisation that exists in Pure.
XML Example
<organisation xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:annotation>
<xs:documentation>An ID of an internal organisation that exists in Pure.</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="commons:string_400">
<xs:annotation>
<xs:documentation>The source ID of the organisation</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The source ID of the organisation |
Yes |
researcherCommitmentList
A list of researcherCommitment elements of type researcherCommitment
If Actual Researcher Commitment percentage is enabled under the Unified Project Model administration page then a series of monthly commitment percentages can be uploaded. These months should be within the date range of the award itself and consist of a planned percentage and an actual percentage
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="researcherCommitmentList">
<xs:annotation>
<xs:documentation>If Actual Researcher Commitment percentage is enabled under the Unified Project Model administration page then a series of monthly commitment percentages can be uploaded. These months should be within the date range of the award itself and consist of a planned percentage and an actual percentage</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="researcherCommitment"
type="researcherCommitment"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>researcherCommitment
XML Example
<researcherCommitment xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- This should correspond to the internalAwardHolders -->
<personId>person1</personId>
<year>2022</year>
<month>11</month>
<!-- These two fields are percentages, represented by numbers between 0 and 1 -->
<plannedCommitment>0.8</plannedCommitment>
<actualCommitment>0.65</actualCommitment>
</researcherCommitment>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="researcherCommitment">
<xs:sequence>
<xs:element name="personId" type="commons:string_400">
<xs:annotation>
<xs:documentation>The source id of the person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="year" type="xs:int">
<xs:annotation>
<xs:documentation>The year of this researcher commitment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="month" type="xs:int">
<xs:annotation>
<xs:documentation>The month of this researcher commitment as an integer from 1 to 12</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="plannedCommitment" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The planned researcher commitment as percentage, value should be between 0 and 1</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="actualCommitment" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The actual researcher commitment as a percentage, value should be between 0 and 1</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
personId |
The source id of the person |
Yes |
|
year |
The year of this researcher commitment |
xsd:int |
Yes |
month |
The month of this researcher commitment as an integer from 1 to 12 |
xsd:int |
Yes |
plannedCommitment |
The planned researcher commitment as percentage, value should be between 0 and 1 |
xsd:double |
No |
actualCommitment |
The actual researcher commitment as a percentage, value should be between 0 and 1 |
xsd:double |
No |
Funding
financialFundings
A list of financialFunding elements of type financialFunding
XML Example
<financialFundings xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--If synchronizing expenditure to existing awards this funding id should align with what is listed on the funding record in Pure-->
<financialFunding id="funding_id"><!-- Budgets should be enabled under UPM administration to load these values -->
<budgets><!--If synchronizing expenditure to existing awards this budget id should align with what is listed on the budget record in Pure-->
<budget id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>
</budgets>
<!-- These are the details of the organisation providing the funding. Pure will attempt to match existing organisations and create one if not found -->
<externalOrgName>Research Funding Inc</externalOrgName>
<externalOrgType>fundingbody</externalOrgType>
<externalOrgId>researchfundinc</externalOrgId>
<fundingSources><!--Full classification uri, from a classification scheme defined under the Funding Classification Configuration section of the Unified Project Model-->
<fundingSource>/dk/atira/pure/fundingopportunity/fundingopportunitytypes/fundingopportunity/conf</fundingSource>
</fundingSources>
<fundingProjectScheme>Annual Fellowship Programme</fundingProjectScheme>
<!--Needs to be defined in the "Subset of ISO-4217 currencies" classification scheme-->
<awardedCurrency>EUR</awardedCurrency>
<!--Awarded amount in awarded currency-->
<awardedAmountAwardedCurrency>10000</awardedAmountAwardedCurrency>
<!--Awarded amount in system currency-->
<awardedAmount>5000</awardedAmount>
<!--Optional:-->
<institutionalContribution>2000</institutionalContribution>
<!--Full economic cost-->
<institutionalFEC>15000</institutionalFEC>
<!--Full Economic Cost Percentage-->
<fECPercentage>0.8</fECPercentage>
<!-- How much the institution gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
<fundingProgrammeId>123453</fundingProgrammeId>
<fundingCollaborators>
<fundingCollaborator><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>
</fundingCollaborators>
<!-- Can be configured to be shown on either funding or budget, only one should be loaded -->
<costCode>1234-12323-2324</costCode>
<!--Funding visibility determines if the funding can be shown on the portal on related projects-->
<visibility>Confidential</visibility>
</financialFunding>
</financialFundings>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="financialFundings">
<xs:sequence>
<xs:element name="financialFunding"
type="financialFunding"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>financialFunding
A funding commitment from an external organisation towards the award. Depending on the financial funding configuration options under the Unified Project Model administration many more detailed elements can be included, such as budgets.
XML Example
<financialFunding xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="funding_id"><!-- Budgets should be enabled under UPM administration to load these values -->
<budgets><!--If synchronizing expenditure to existing awards this budget id should align with what is listed on the budget record in Pure-->
<budget id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>
</budgets>
<!-- These are the details of the organisation providing the funding. Pure will attempt to match existing organisations and create one if not found -->
<externalOrgName>Research Funding Inc</externalOrgName>
<externalOrgType>fundingbody</externalOrgType>
<externalOrgId>researchfundinc</externalOrgId>
<fundingSources><!--Full classification uri, from a classification scheme defined under the Funding Classification Configuration section of the Unified Project Model-->
<fundingSource>/dk/atira/pure/fundingopportunity/fundingopportunitytypes/fundingopportunity/conf</fundingSource>
</fundingSources>
<fundingProjectScheme>Annual Fellowship Programme</fundingProjectScheme>
<!--Needs to be defined in the "Subset of ISO-4217 currencies" classification scheme-->
<awardedCurrency>EUR</awardedCurrency>
<!--Awarded amount in awarded currency-->
<awardedAmountAwardedCurrency>10000</awardedAmountAwardedCurrency>
<!--Awarded amount in system currency-->
<awardedAmount>5000</awardedAmount>
<!--Optional:-->
<institutionalContribution>2000</institutionalContribution>
<!--Full economic cost-->
<institutionalFEC>15000</institutionalFEC>
<!--Full Economic Cost Percentage-->
<fECPercentage>0.8</fECPercentage>
<!-- How much the institution gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
<fundingProgrammeId>123453</fundingProgrammeId>
<fundingCollaborators>
<fundingCollaborator><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>
</fundingCollaborators>
<!-- Can be configured to be shown on either funding or budget, only one should be loaded -->
<costCode>1234-12323-2324</costCode>
<!--Funding visibility determines if the funding can be shown on the portal on related projects-->
<visibility>Confidential</visibility>
</financialFunding>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="financialFunding">
<xs:annotation>
<xs:documentation>A funding commitment from an external organisation towards the award. Depending on the financial funding configuration options under the Unified Project Model administration many more detailed elements can be included, such as budgets.</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="budgets" type="budgets" minOccurs="0">
<xs:annotation>
<xs:documentation>The budgets related to the financial funding. Should be enabled under Unified Project Model administration to display in Pure</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the external organisation providing this financial funding. Not needed if externalOrgId is used. If existing organisation is not found then new organisation will be created.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgType" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of the external organisation providing this financial funding. Not needed if externalOrgId is used. key token from the classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes, eg ueoexternalorganisation/researchFundingBody</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>ID of the external organisation providing this financial funding.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingSource" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED: This element has been replaced by fundingSources. Key token from the classification scheme /dk/atira/pure/project/financingsources, e.g. publicResearchCouncil</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingSources" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="fundingSource"
type="commons:classification"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>A classification uri, where the scheme listed on the Funding classification configuration page of the Unified Project Model administration</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="fundingProjectScheme"
type="commons:string_1024"
minOccurs="0">
<xs:annotation>
<xs:documentation>Free text value to describe the funding project scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="awardedCurrency" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The currency the funding was awarded in. Token from classification scheme /dk/atira/pure/core/isocurrencies, eg GBP</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="awardedAmountAwardedCurrency" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The amount awarded (in the awarded currency)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="awardedAmount" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The awarded amount (in the system currency)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="institutionalContribution" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Amount contributed by institution</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="institutionalFEC" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The total value for the funding</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fECPercentage" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Full Economic Cost percentage, values between 0 and 1. fEC fields need to be enabled under UPM administration for this to be available</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="institutionalPart" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Should only be provided if this is a collaborative award</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingProgrammeId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>The ID of the related funding programme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingCollaborators"
type="fundingCollaborators"
minOccurs="0">
<xs:annotation>
<xs:documentation>Collaborators, and their contributions, on this funding</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="costCode" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Financial account code. Note under UPM administration this can be configured to be available either on funding or budget</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>Visibility of the funding</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute name="id" type="commons:string_400" use="required">
<xs:annotation>
<xs:documentation>Id of the funding from an external system. If syncing expenditure for an award this should be referencing the ID type you have selected in job configuration page</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the funding from an external system. If syncing expenditure for an award this should be referencing the ID type you have selected in job configuration page |
Yes |
|
budgets |
The budgets related to the financial funding. Should be enabled under Unified Project Model administration to display in Pure |
No |
|
externalOrgName |
Name of the external organisation providing this financial funding. Not needed if externalOrgId is used. If existing organisation is not found then new organisation will be created. |
No |
|
externalOrgType |
Type of the external organisation providing this financial funding. Not needed if externalOrgId is used. key token from the classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes, eg ueoexternalorganisation/researchFundingBody |
No |
|
externalOrgId |
ID of the external organisation providing this financial funding. |
No |
|
fundingSources |
|
Contains below components |
No |
fundingSources.fundingSource |
A classification uri, where the scheme listed on the Funding classification configuration page of the Unified Project Model administration |
No |
|
fundingProjectScheme |
Free text value to describe the funding project scheme |
No |
|
awardedCurrency |
The currency the funding was awarded in. Token from classification scheme /dk/atira/pure/core/isocurrencies, eg GBP |
No |
|
awardedAmountAwardedCurrency |
The amount awarded (in the awarded currency) |
xsd:double |
No |
awardedAmount |
The awarded amount (in the system currency) |
xsd:double |
No |
institutionalContribution |
Amount contributed by institution |
xsd:double |
No |
institutionalFEC |
The total value for the funding |
xsd:double |
No |
fECPercentage |
Full Economic Cost percentage, values between 0 and 1. fEC fields need to be enabled under UPM administration for this to be available |
xsd:double |
No |
institutionalPart |
Should only be provided if this is a collaborative award |
xsd:double |
No |
fundingProgrammeId |
The ID of the related funding programme |
No |
|
fundingCollaborators |
Collaborators, and their contributions, on this funding |
No |
|
costCode |
Financial account code. Note under UPM administration this can be configured to be available either on funding or budget |
No |
|
visibility |
Visibility of the funding |
No |
nonFinancialFundings
A list of nonFinancialFunding elements of type nonFinancialFunding
XML Example
<nonFinancialFundings xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<nonFinancialFunding id="nonfundedid">
<externalOrgId>external_organisation_id_002</externalOrgId>
<fundingProjectScheme>Funding project scheme (research programme)</fundingProjectScheme>
<estimatedValue>25000</estimatedValue>
<institutionalEstimatedValue>15000</institutionalEstimatedValue>
<description>Researcher in-kind commitment of 200 hours over the life of the award</description>
<visibility>Public</visibility>
</nonFinancialFunding>
</nonFinancialFundings>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="nonFinancialFundings">
<xs:sequence>
<xs:element name="nonFinancialFunding"
type="nonFinancialFunding"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>nonFinancialFunding
A funding commitment from an external organisation of a non-financial nature (often called in-kind) towards the award. Depending on the financial funding configuration options under the Unified Project Model administration many more detailed elements can be included, such as budgets.
XML Example
<nonFinancialFunding xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="nonfundedid">
<externalOrgId>external_organisation_id_002</externalOrgId>
<fundingProjectScheme>Funding project scheme (research programme)</fundingProjectScheme>
<estimatedValue>25000</estimatedValue>
<institutionalEstimatedValue>15000</institutionalEstimatedValue>
<description>Researcher in-kind commitment of 200 hours over the life of the award</description>
<visibility>Public</visibility>
</nonFinancialFunding>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="nonFinancialFunding">
<xs:annotation>
<xs:documentation>A funding commitment from an external organisation of a non-financial nature (often called in-kind) towards the award. Depending on the financial funding configuration options under the Unified Project Model administration many more detailed elements can be included, such as budgets.</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="budgets" type="budgets" minOccurs="0">
<xs:annotation>
<xs:documentation>The budgets related to the non-financial funding</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the external organisation providing this financial funding. Not needed if externalOrgId is used. If existing organisation is not found then new organisation will be created.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgType" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of the external organisation providing this financial funding. Not needed if externalOrgId is used. key token from the classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes, eg ueoexternalorganisation/researchFundingBody</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>ID of the external organisation providing this financial funding.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingProjectScheme"
type="commons:string_1024"
minOccurs="0">
<xs:annotation>
<xs:documentation>Free text describing the funding project scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="estimatedValue" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Estimated value of the funding</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="institutionalEstimatedValue" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>Should only be provided if this is a collaborative award.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Description of the commitment</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fundingCollaborators"
type="fundingCollaborators"
minOccurs="0">
<xs:annotation>
<xs:documentation>Collaborators, and their contributions, on this funding</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>Visibility of the funding</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute name="id" type="commons:string_400" use="required">
<xs:annotation>
<xs:documentation>Id of the funding in an external system</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the funding in an external system |
Yes |
|
budgets |
The budgets related to the non-financial funding |
No |
|
externalOrgName |
Name of the external organisation providing this financial funding. Not needed if externalOrgId is used. If existing organisation is not found then new organisation will be created. |
No |
|
externalOrgType |
Type of the external organisation providing this financial funding. Not needed if externalOrgId is used. key token from the classification scheme /dk/atira/pure/ueoexternalorganisation/ueoexternalorganisationtypes, eg ueoexternalorganisation/researchFundingBody |
No |
|
externalOrgId |
ID of the external organisation providing this financial funding. |
No |
|
fundingProjectScheme |
Free text describing the funding project scheme |
No |
|
estimatedValue |
Estimated value of the funding |
xsd:double |
No |
institutionalEstimatedValue |
Should only be provided if this is a collaborative award. |
xsd:double |
No |
description |
Description of the commitment |
No |
|
fundingCollaborators |
Collaborators, and their contributions, on this funding |
No |
|
visibility |
Visibility of the funding |
No |
budgets
A list of budget elements of type budget
XML Example
<budgets xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--If synchronizing expenditure to existing awards this budget id should align with what is listed on the budget record in Pure-->
<budget id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>
</budgets>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budgets">
<xs:sequence>
<xs:element name="budget" type="budget" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>budget
A budget details a breakdown of how the awarded funding is expected to be spent. This should be enabled under the Unified Project Model administration page and can be configued as to whether support multiple account lines or yearly breakdowns
XML Example
<budget xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="the budget id">
<budgetLines>
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>
<!--
Yearly budgets should be enabled under UPM Administration for these values to display in Pure.
Each line in the yearly budget should be reflected in the budgetLines already
-->
<budgetLinesYearlyBudget><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>
<!--
Expenditure should be enabled under UPM Administration before loading.
These values can't be loaded via the interface in Pure and need to be imported via XML
You can import expenditure for manually created awards. Consult the Award Synchronisation job for more details
-->
<expenditures><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>
<!--Must be defined in "Unified Project Model: Organisation cost centre types" classification scheme-->
<costCenter>costcenter1</costCenter>
<!-- Cost code can be configured to be shown on either budget or funding -->
<costCode>4321-3242-1231231</costCode>
<organisationId>organisation1</organisationId>
</budget>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budget">
<xs:annotation>
<xs:documentation>A budget details a breakdown of how the awarded funding is expected to be spent. This should be enabled under the Unified Project Model administration page and can be configued as to whether support multiple account lines or yearly breakdowns</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="budgetLines" type="budgetLines">
<xs:annotation>
<xs:documentation>The budget lines of the budget</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="budgetLinesYearlyBudget"
type="budgetLinesYearlyBudget"
minOccurs="0">
<xs:annotation>
<xs:documentation>The budget lines of the yearly budget, if enabled under the UPM administration</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="expenditures" type="expenditures" minOccurs="0">
<xs:annotation>
<xs:documentation>The expenditures of the budget. Note this cannot be entered via the interface in Pure so must be loaded via XML</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisationId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>
The ID of the organisation this budget is associated with
If you have more than one budget per funding then this field is mandatory.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="costCenter" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The cost center this budget is associated with
Key token from the classification scheme /dk/atira/pure/upm/costcenterkeywords
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="costCode" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Financial account code. Note under UPM administration this can be configured to be available either on funding or budget</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute name="id" type="commons:string_400" use="required">
<xs:annotation>
<xs:documentation>ID of the budget. If syncing expenditure for an award this should be referencing the ID type you have selected in job configuration page</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the budget. If syncing expenditure for an award this should be referencing the ID type you have selected in job configuration page |
Yes |
|
budgetLines |
The budget lines of the budget |
Yes |
|
budgetLinesYearlyBudget |
The budget lines of the yearly budget, if enabled under the UPM administration |
No |
|
expenditures |
The expenditures of the budget. Note this cannot be entered via the interface in Pure so must be loaded via XML |
No |
|
organisationId |
The ID of the organisation this budget is associated with If you have more than one budget per funding then this field is mandatory. |
No |
|
costCenter |
The cost center this budget is associated with Key token from the classification scheme /dk/atira/pure/upm/costcenterkeywords |
No |
|
costCode |
Financial account code. Note under UPM administration this can be configured to be available either on funding or budget |
No |
budgetLines
A list of budgetLine elements of type budgetLine
A breakdown of the funding against different budget lines. To break down different account lines, single totals account should be disabled under the UPM administration
XML Example
<budgetLines xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<budgetLine><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>
</budgetLines>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budgetLines">
<xs:annotation>
<xs:documentation>A breakdown of the funding against different budget lines. To break down different account lines, single totals account should be disabled under the UPM administration</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="budgetLine" type="budgetLine" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>budgetLine
A breakdown of the funding against different budget lines. To break down different account lines, single totals account should be disabled under the UPM administration
XML Example
<budgetLine xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>5000</budgetValue>
<!--Can be enabled under UPM Administration. Values should be listed in "Unified Project Model: Organisation cost centre types" classification scheme as well as "Unified Project Model: Types of cost centre keywords on budget lines"-->
<costCenter>costcenter1</costCenter>
<!--This can be used to specify the purpose of the budgeted funds-->
<specification>Text used to make a descriptive text of the line</specification>
</budgetLine>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budgetLine">
<xs:annotation>
<xs:documentation>A breakdown of the funding against different budget lines. To break down different account lines, single totals account should be disabled under the UPM administration</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="budgetLine" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager to make sure this is setup correctly.
Key token from the classification scheme /dk/atira/pure/award/account
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="budgetValue" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The actual budget value to add to the award
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="costCenter" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The cost center this budget is associated with, if you have more than one budget per funding then this field is mandatory.
key token from the classification scheme /dk/atira/pure/upm/costcenter. Enable Cost Centre and Specification on budgets needs to be enabled under UPM for this to display
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="specification" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
A descriptive text for this budget line. Enable Cost Centre and Specification on budgets needs to be enabled under UPM for this to display
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fec" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The FEC of the budget line. fEC fields need to be enabled under UPM administration for this to be available
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="funderContributionGBP" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The funder contribution. fEC fields need to be enabled under UPM administration for this to be available
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
budgetLine |
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager to make sure this is setup correctly. Key token from the classification scheme /dk/atira/pure/award/account |
Yes |
|
budgetValue |
The actual budget value to add to the award |
xsd:double |
No |
costCenter |
The cost center this budget is associated with, if you have more than one budget per funding then this field is mandatory. key token from the classification scheme /dk/atira/pure/upm/costcenter. Enable Cost Centre and Specification on budgets needs to be enabled under UPM for this to display |
No |
|
specification |
A descriptive text for this budget line. Enable Cost Centre and Specification on budgets needs to be enabled under UPM for this to display |
No |
|
fec |
The FEC of the budget line. fEC fields need to be enabled under UPM administration for this to be available |
xsd:double |
No |
funderContributionGBP |
The funder contribution. fEC fields need to be enabled under UPM administration for this to be available |
xsd:double |
No |
budgetLinesYearlyBudget
A list of budgetLineYearlyBudget elements of type budgetLineYearlyBudget
If yearly budgets are enabled under the UPM administration then this can provide a breakdown of each budget line per year
XML Example
<budgetLinesYearlyBudget xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- There should be a value loaded for each line for each year of the award. If values aren't entered 0 will be presumed -->
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>
<budgetLineYearlyBudget><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>2000</budgetValue>
<year>2023</year>
</budgetLineYearlyBudget>
</budgetLinesYearlyBudget>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budgetLinesYearlyBudget">
<xs:annotation>
<xs:documentation>If yearly budgets are enabled under the UPM administration then this can provide a breakdown of each budget line per year</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="budgetLineYearlyBudget"
type="budgetLineYearlyBudget"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>budgetLineYearlyBudget
XML Example
<budgetLineYearlyBudget xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--
These should be listed in the Unified Project Model: Account Types classification scheme.
If you are using single total account then this value should be "total"
-->
<budgetLine>line1</budgetLine>
<budgetValue>3000</budgetValue>
<year>2022</year>
</budgetLineYearlyBudget>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="budgetLineYearlyBudget">
<xs:all>
<xs:element name="budgetLine" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Pure implementation manager to make sure this is setup correctly.
Key token from the classification scheme /dk/atira/pure/award/account
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="budgetValue" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The budgeted amount for this account line for this year
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="year" type="xs:integer" minOccurs="1">
<xs:annotation>
<xs:documentation>
The year for the budget value. Eg. 2022
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
budgetLine |
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Pure implementation manager to make sure this is setup correctly. Key token from the classification scheme /dk/atira/pure/award/account |
Yes |
|
budgetValue |
The budgeted amount for this account line for this year |
xsd:double |
No |
year |
The year for the budget value. Eg. 2022 |
xsd:integer |
Yes |
Expenditure
expenditures
A list of expenditure elements of type expenditure
Expenditure can't be entered manually into Pure via the interface so must be synchronised via XML.
This can be done when creating awards or by using the Update Awards Maintained in Pure setting on the Award Synchronisation Job.
This setting allows you to update awards that have been manually created in Pure by referencing a specified ID type for the award, funding and budget.
You can use the Pure IDs of these items or enter your own values that would likely come from your finance system.
If you are using the Pure IDs these should be recorded in your finance system instead to allow for the connections to be made betweent the awards and their expenditure.
XML Example
<expenditures xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--Expenditure should be summarised per month and budget line. Changing the value and resynchronising will update the value for that month.-->
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
<expenditure>
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>12</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>
</expenditures>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="expenditures">
<xs:annotation>
<xs:documentation>
Expenditure can't be entered manually into Pure via the interface so must be synchronised via XML.
This can be done when creating awards or by using the Update Awards Maintained in Pure setting on the Award Synchronisation Job.
This setting allows you to update awards that have been manually created in Pure by referencing a specified ID type for the award, funding and budget.
You can use the Pure IDs of these items or enter your own values that would likely come from your finance system.
If you are using the Pure IDs these should be recorded in your finance system instead to allow for the connections to be made betweent the awards and their expenditure.
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="expenditure" type="expenditure" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>expenditure
Expenditure in Pure is summarised at a monthly level, and one entry per month and budget line is respected.
In the generation of your XML file you should sum these values and include for Pure each time the data is loaded.
Existing values that aren't reflected in the load file will be removed
XML Example
<expenditure xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<budgetLine>line1</budgetLine>
<year>2022</year>
<month>11</month>
<expenditureValue>2594.22</expenditureValue>
</expenditure>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="expenditure">
<xs:annotation>
<xs:documentation>
Expenditure in Pure is summarised at a monthly level, and one entry per month and budget line is respected.
In the generation of your XML file you should sum these values and include for Pure each time the data is loaded.
Existing values that aren't reflected in the load file will be removed
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="budgetLine" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager to make sure this is setup correctly.
Key token from the classification scheme /dk/atira/pure/award/account
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="year" type="xs:integer" minOccurs="1">
<xs:annotation>
<xs:documentation>
The year for the expenditure value. Eg. 2022
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="month" type="xs:integer" minOccurs="1">
<xs:annotation>
<xs:documentation>
The month for the expenditure value. Eg. 10
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="expenditureValue" type="xs:double" minOccurs="1">
<xs:annotation>
<xs:documentation>
The actual expenditure value
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
budgetLine |
The budget line to add the budget value for. If you do not want to provide budget against individual budget lines, please make sure the module the module is configured for this and that the budget line classification schema only contains one single classification value called Total. Please consult your Atira project manager to make sure this is setup correctly. Key token from the classification scheme /dk/atira/pure/award/account |
Yes |
|
year |
The year for the expenditure value. Eg. 2022 |
xsd:integer |
Yes |
month |
The month for the expenditure value. Eg. 10 |
xsd:integer |
Yes |
expenditureValue |
The actual expenditure value |
xsd:double |
Yes |
Related content
relatedAwards
A list of relatedAwardId elements of type commons:string_400
XML Example
<relatedAwards xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedAwardId>award2</relatedAwardId>
</relatedAwards>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedAwards">
<xs:sequence>
<xs:element name="relatedAwardId"
type="commons:string_400"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Id of related award</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedAwardId |
Id of related award |
Yes |
relatedApplications
A list of relatedApplicationId elements of type commons:string_400
XML Example
<relatedApplications xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedApplicationId>application1</relatedApplicationId>
</relatedApplications>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedApplications">
<xs:sequence>
<xs:element name="relatedApplicationId"
type="commons:string_400"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Id of related application</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedApplicationId |
Id of related application |
Yes |
Milestones
milestones
A list of milestone elements of type milestone
XML Example
<milestones xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<milestone id="milestone01">
<name>Annual Report Due</name>
<!-- Can specify the name in all supported submision languages -->
<translatedNames>
<name lang="de">Milestone title in another language</name>
</translatedNames>
<description>A report is due to be sent to the funding body at the conclusion of the first full year of funding</description>
<!-- Can specify the description in all supported submission languages -->
<translatedDescriptions>
<description lang="de">Milestone description in another language</description>
</translatedDescriptions>
<!-- For academic milestones the responsibleRole should match the role of an awardholder on the award -->
<responsibleRole type="academic">pi</responsibleRole>
<completed>true</completed>
<deadline>31-12-2022</deadline>
<completedDate>22-12-2022</completedDate>
<!-- If not specified will default to the user running the load -->
<completedBy>atira</completedBy>
</milestone>
<milestone id="milestone02">
<name>Milestone 2</name>
<responsibleRole type="administrative">assisting-editor</responsibleRole>
<deadline>6-3-2022</deadline>
<reminders><!--This will set a reminder to be sent to the assigned user 1 week before the deadline-->
<reminder id="1" timeUnit="week">1</reminder>
<!--This will set a reminder to be sent to the assigned user 2 days before the deadline-->
<reminder id="2" timeUnit="day">2</reminder>
</reminders>
</milestone>
<milestone id="milestone03">
<name>Milestone 3</name>
<responsibleRole type="academic">pi</responsibleRole>
<deadline>10-04-2023</deadline>
<documents>
<document id="doc1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Cumberland_258.jpg/1280px-Cumberland_258.jpg</fileLocation>
<mimetype>image/jpeg</mimetype>
<filename>Milestone.jpg</filename>
<name>Milestone</name>
</document>
</documents>
</milestone>
</milestones>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="milestones">
<xs:sequence>
<xs:element name="milestone" type="milestone" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>milestone
A Milestone in Pure is task with alert options that can be assigned to one or more specific users to ensure that actions are taken to comply with funder requirements and internal requirements.
XML Example
<milestone xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="milestone01">
<name>Annual Report Due</name>
<!-- Can specify the name in all supported submision languages -->
<translatedNames>
<name lang="de">Milestone title in another language</name>
</translatedNames>
<description>A report is due to be sent to the funding body at the conclusion of the first full year of funding</description>
<!-- Can specify the description in all supported submission languages -->
<translatedDescriptions>
<description lang="de">Milestone description in another language</description>
</translatedDescriptions>
<!-- For academic milestones the responsibleRole should match the role of an awardholder on the award -->
<responsibleRole type="academic">pi</responsibleRole>
<completed>true</completed>
<deadline>31-12-2022</deadline>
<completedDate>22-12-2022</completedDate>
<!-- If not specified will default to the user running the load -->
<completedBy>atira</completedBy>
</milestone>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="milestone">
<xs:annotation>
<xs:documentation>
A Milestone in Pure is task with alert options that can be assigned to one or more specific users to ensure that actions are taken to comply with funder requirements and internal requirements.
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="name" type="commons:string_256">
<xs:annotation>
<xs:documentation>The name of the milestone</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedNames" type="translatedNames" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the milestone. Use if title is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>The description of the milestone</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedDescriptions"
type="translatedDescriptions"
minOccurs="0">
<xs:annotation>
<xs:documentation>Translated description of the milestone. Use if description is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="responsibleRole" type="role" minOccurs="1" default="pi">
<xs:annotation>
<xs:documentation>
The responsible role for the milestone. Valid roles depends on the type.
If type is academic, valid role is a token of a classification from the /dk/atira/pure/award/roles/award classification scheme
If type is administrative, valid roles are award roles and can be editor, validator or administrator
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reminders" type="reminders" minOccurs="0">
<xs:annotation>
<xs:documentation>The email reminders of the milestone</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>The files attached to the milestone</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="deadline" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The deadline for the milestone</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="completed"
type="xs:boolean"
minOccurs="0"
default="false">
<xs:annotation>
<xs:documentation>Specify whether the milestone was completed. Default is false</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="completedDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date the milestone was completed. Specify this date if the milestone is set to completed, otherwise the completed date will be set to the day the milestone is created in Pure</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="completedBy" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>The user who completed the milestone, if none is specified the currently logged in user will be used</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="xs:string" name="id" use="required">
<xs:annotation>
<xs:documentation>Id of the milestone in the source system</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the milestone in the source system |
xsd:string |
Yes |
name |
The name of the milestone |
Yes |
|
translatedNames |
Translated titles of the milestone. Use if title is different in another language |
No |
|
description |
The description of the milestone |
No |
|
translatedDescriptions |
Translated description of the milestone. Use if description is different in another language |
No |
|
responsibleRole |
The responsible role for the milestone. Valid roles depends on the type. If type is academic, valid role is a token of a classification from the /dk/atira/pure/award/roles/award classification scheme If type is administrative, valid roles are award roles and can be editor, validator or administrator |
Yes |
|
reminders |
The email reminders of the milestone |
No |
|
documents |
The files attached to the milestone |
No |
|
deadline |
The deadline for the milestone |
No |
|
completed |
Specify whether the milestone was completed. Default is false |
xsd:boolean |
No |
completedDate |
The date the milestone was completed. Specify this date if the milestone is set to completed, otherwise the completed date will be set to the day the milestone is created in Pure |
No |
|
completedBy |
The user who completed the milestone, if none is specified the currently logged in user will be used |
No |
role
The text of this element should indicate the role that is responsible for the milestone. If academic this should be one of the roles on the award, if administrative it should be administrator, editor or assisting-editor
XML Example
<role xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">pi</role>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="role">
<xs:annotation>
<xs:documentation>The text of this element should indicate the role that is responsible for the milestone. If academic this should be one of the roles on the award, if administrative it should be administrator, editor or assisting-editor</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="commons:string_256">
<xs:attribute name="type"
type="typeAttribute"
default="academic"
use="optional">
<xs:annotation>
<xs:documentation>The type of the role responsible for the milestone, can be academic or administrative</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@type |
The type of the role responsible for the milestone, can be academic or administrative |
Yes |
typeAttribute
XSD Definition
<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="typeAttribute">
<xs:restriction base="xs:string">
<xs:enumeration value="academic"/>
<xs:enumeration value="administrative"/>
</xs:restriction>
</xs:simpleType>Restricted value: xs:string
Type |
Value |
Comments |
|---|---|---|
xs:enumeration |
academic |
|
xs:enumeration |
administrative |
|
reminders
A list of reminder elements of type reminder
XML Example
<reminders xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--This will set a reminder to be sent to the assigned user 1 week before the deadline-->
<reminder id="1" timeUnit="week">1</reminder>
<!--This will set a reminder to be sent to the assigned user 2 days before the deadline-->
<reminder id="2" timeUnit="day">2</reminder>
</reminders>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="reminders">
<xs:sequence>
<xs:element name="reminder" type="reminder" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>reminder
Email reminder will be sent to the responsible role the specified time before deadline
XML Example
<reminder xmlns="v1.upmaward.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="1"
timeUnit="week">1</reminder>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="reminder">
<xs:annotation>
<xs:documentation>Email reminder will be sent to the responsible role the specified time before deadline</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:integer">
<xs:attribute type="xs:string" name="id" use="required">
<xs:annotation>
<xs:documentation>Id of the reminder</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="timeUnit" name="timeUnit" use="optional" default="week">
<xs:annotation>
<xs:documentation>Unit of the reminder, can be month, week or day. Default is week</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Id of the reminder |
xsd:string |
Yes |
@timeUnit |
Unit of the reminder, can be month, week or day. Default is week |
Yes |
timeUnit
XSD Definition
<xs:simpleType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="timeUnit">
<xs:restriction base="xs:string">
<xs:enumeration value="month"/>
<xs:enumeration value="week"/>
<xs:enumeration value="day"/>
</xs:restriction>
</xs:simpleType>Restricted value: xs:string
Type |
Value |
Comments |
|---|---|---|
xs:enumeration |
month |
|
xs:enumeration |
week |
|
xs:enumeration |
day |
|
translatedNames
A list of name elements of type commons:localized_text_256_lang
XML Example
<translatedNames xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<name lang="de">Milestone title in another language</name>
</translatedNames>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedNames">
<xs:sequence>
<xs:element name="name"
type="commons:localized_text_256_lang"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
name |
|
Yes |
translatedDescriptions
A list of description elements of type commons:localized_text_1024_lang
XML Example
<translatedDescriptions xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<description lang="de">Milestone description in another language</description>
</translatedDescriptions>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedDescriptions">
<xs:sequence>
<xs:element name="description"
type="commons:localized_text_1024_lang"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
description |
|
Yes |
documents
A list of document elements of type milestonedocument
XML Example
<documents xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<document id="doc1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/2/23/Cumberland_258.jpg/1280px-Cumberland_258.jpg</fileLocation>
<mimetype>image/jpeg</mimetype>
<filename>Milestone.jpg</filename>
<name>Milestone</name>
</document>
</documents>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="documents">
<xs:sequence>
<xs:element name="document" type="milestonedocument" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>milestonedocument
A document attached to a milestone
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="milestonedocument">
<xs:annotation>
<xs:documentation>A document attached to a milestone</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="fileLocation" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>
Location where Pure can read the file from. Must be prefixed with protocol either
http or https. Https is only supported if the remote server uses a trusted
certificate. If the remote server uses a self-signed certificate,
the JVM running Pure will need an updated keystore.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="name" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the document</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="filename" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Filename of the document</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="mimetype" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Mimetype of the document</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>Visibility of the document</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>ID of the document</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the document |
Yes |
|
fileLocation |
Location where Pure can read the file from. Must be prefixed with protocol either http or https. Https is only supported if the remote server uses a trusted certificate. If the remote server uses a self-signed certificate, the JVM running Pure will need an updated keystore. |
Yes |
|
name |
Name of the document |
No |
|
filename |
Filename of the document |
No |
|
mimetype |
Mimetype of the document |
No |
|
visibility |
Visibility of the document |
No |
Collaborators
fundingCollaborators
A list of fundingCollaborator elements of type fundingCollaborator
XML Example
<fundingCollaborators xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<fundingCollaborator><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>
</fundingCollaborators>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="fundingCollaborators">
<xs:sequence>
<xs:element name="fundingCollaborator"
type="fundingCollaborator"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>fundingCollaborator
An external organisation who is working with the institution on the award
XML Example
<fundingCollaborator xmlns="v1.upmaward.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Collaborator should already be listed under collaborators for award -->
<collaborator>
<cmns:externalOrgId>externalOrganisation1</cmns:externalOrgId>
</collaborator>
<!-- How much this collaborator gets of the awarded amount -->
<institutionalPart>3000</institutionalPart>
</fundingCollaborator>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="fundingCollaborator">
<xs:annotation>
<xs:documentation>An external organisation who is working with the institution on the award</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="collaborator"
type="commons:externalOrganisation"
minOccurs="1">
<xs:annotation>
<xs:documentation>
The collaborator external organisation
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="institutionalPart" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The institutional part for this collaborator (on financial fundings)
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="estimatedValue" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>
The estimated value of the contribution by this collaborator (on non-financial fundings)
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
collaborator |
The collaborator external organisation |
Yes |
|
institutionalPart |
The institutional part for this collaborator (on financial fundings) |
xsd:double |
No |
estimatedValue |
The estimated value of the contribution by this collaborator (on non-financial fundings) |
xsd:double |
No |
Updated at July 27, 2024