How Can We Help?
Project XMLProject XML
Overview
This page details the Project content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Project 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 Project 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.
A Project in Pure is a record with information about a research project, such as the
participants and collaborators, lifecycle, grant applications and awards, links to
research output, activities, datasets, equipment and press clippings.
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.
Projects
upmprojects
A list of upmproject elements of type upmproject
The root element of the document
XML Example
<upmprojects xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<upmproject id="project1" type="other" managedInPure="false"><!-- Activity types should be defined in the "Unified Project Model: Nature of activity types" classification scheme-->
<activityTypes>
<activityType>research</activityType>
</activityTypes>
<title>
<cmns:text lang="en" country="GB">The title of the project</cmns:text>
</title>
<shortTitle>
<cmns:text lang="en" country="GB">A short title</cmns:text>
</shortTitle>
<acronym>TTotP</acronym>
<!-- Description types should be defined in the "Unified Project Model: Project Descriptions" classification scheme -->
<descriptions>
<cmns:description type="projectdescription">
<cmns:text lang="en" country="GB">The project description</cmns:text>
</cmns:description>
<cmns:description type="laymansdescription">
<cmns:text lang="en" country="GB">A laymans description of the project</cmns:text>
</cmns:description>
<cmns:description type="keyfindings">
<cmns:text lang="en" country="GB">A key findings description of the project</cmns:text>
</cmns:description>
</descriptions>
<!-- ID Type should be defined in the "Unified Project Model: Types of Classified sources" classification scheme -->
<ids>
<cmns:id type="projectid">externalid1</cmns:id>
</ids>
<internalParticipants>
<internalParticipant>
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles should be defined in the "Unified Project Model: Project Roles" classification scheme -->
<role>pi</role>
<!-- Should be a number between 0 and 1 -->
<academicOwnership>1.0</academicOwnership>
<!-- Should be a number between 0 and 1 -->
<plannedResearcherCommitment>0.5</plannedResearcherCommitment>
<associationStartDate>2007-10-26</associationStartDate>
<associationEndDate>2008-02-14</associationEndDate>
</internalParticipant>
</internalParticipants>
<!-- Commitment tracking should be enabled under UPM configuration before loading values -->
<internalParticipantsResearcherCommitment>
<researcherCommitment>
<personId>person1</personId>
<year>2007</year>
<month>11</month>
<!-- Should be a number between 0 and 1 -->
<plannedCommitment>0.5</plannedCommitment>
<!-- Should be a number between 0 and 1 -->
<actualCommitment>0.6</actualCommitment>
</researcherCommitment>
</internalParticipantsResearcherCommitment>
<externalParticipants>
<externalParticipant>
<firstName>John</firstName>
<lastName>Smith</lastName>
<country>gb</country>
<role>coi</role>
<externalOrgName>University of Europe</externalOrgName>
<externalOrgType>unknown</externalOrgType>
<externalOrgId>UoE</externalOrgId>
</externalParticipant>
</externalParticipants>
<!-- Co Managing Organisations should be enabled under the UPM configuration before loading values -->
<coManagingOrganisations>
<organisation id="organisation2"/>
</coManagingOrganisations>
<organisations>
<organisation id="organisation1"/>
</organisations>
<externalOrganisations>
<cmns:externalOrganisationAssociation>
<cmns:externalOrgName>University of Europe</cmns:externalOrgName>
<cmns:externalOrgType>unknown</cmns:externalOrgType>
<cmns:externalOrgId>UoE</cmns:externalOrgId>
</cmns:externalOrganisationAssociation>
</externalOrganisations>
<!-- Must be an internal organisation -->
<managedByOrganisation id="organisation1"/>
<startDate>2007-10-26</startDate>
<endDate>2008-02-14</endDate>
<curtailed>
<date>2008-01-14</date>
<reason>Postponed due to the lack of resources</reason>
</curtailed>
<collaborative>true</collaborative>
<!-- Collaborator type should be defined in the "Unified Project Model: Types of Collaborators" classification scheme -->
<collaborators>
<cmns:collaborator type="jointapplicant">
<cmns:externalOrgName>University of Europe</cmns:externalOrgName>
<cmns:externalOrgType>unknown</cmns:externalOrgType>
<cmns:externalOrgId>UeO</cmns:externalOrgId>
<cmns:leadCollaborator>false</cmns:leadCollaborator>
</cmns:collaborator>
</collaborators>
<relatedAwards>
<relatedAwardId>award1</relatedAwardId>
</relatedAwards>
<relatedApplications>
<relatedApplicationId>application1</relatedApplicationId>
</relatedApplications>
<relatedProjects>
<relatedProject>
<targetProjectId>project2</targetProjectId>
<relationType>partof</relationType>
</relatedProject>
</relatedProjects>
<relatedPublications>
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>
<relatedActivities>
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>
<documents>
<cmns:upmdocuments id="doc1"><!-- Type should be defined in the "Types for documents" classification scheme -->
<cmns:type>text</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/thumb/9/98/Microsoft_Project_%282019%E2%80%93present%29.svg/240px-Microsoft_Project_%282019%E2%80%93present%29.svg.png</cmns:url>
</cmns:http>
</cmns:file>
<cmns:mimeType>image/png</cmns:mimeType>
<cmns:fileName>project.png</cmns:fileName>
<cmns:title>Project Agreement</cmns:title>
<cmns:visibility>Public</cmns:visibility>
</cmns:upmdocuments>
</documents>
<keywords>
<cmns:keyword>Freetext keyword</cmns:keyword>
<cmns:keyword logicalName="sustainabledevelopmentgoals" key="gender_equality"/>
</keywords>
<links>
<cmns:link id="link1">
<cmns:url>http://google.com</cmns:url>
<cmns:type>unspecified</cmns:type>
<cmns:description>
<cmns:text lang="en" country="GB">A link description text</cmns:text>
</cmns:description>
</cmns:link>
</links>
<visibility>Public</visibility>
</upmproject>
<upmproject id="project2" type="other">
<title>
<cmns:text lang="en" country="GB">Another project title</cmns:text>
</title>
<internalParticipants>
<internalParticipant>
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<role>pi</role>
</internalParticipant>
</internalParticipants>
<managedByOrganisation id="organisation1"/>
<visibility>Confidential</visibility>
</upmproject>
</upmprojects>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="upmprojects">
<xs:annotation>
<xs:documentation>The root element of the document</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="upmproject" 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>upmproject
This xml element is used to define a project to synchronise into Pure. This means that one entry in the xml has to exist per project you want to have in Pure. For each project you have to specify a unique ID, which will be the primary source ID for identifiying this project in the synchronisation.
This ID is for synchronisation purposes only, it has to be unique for each project and cannot change over time.
XML Example
<upmproject xmlns="v1.upmproject.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="project1"
type="other"
managedInPure="false"><!-- Activity types should be defined in the "Unified Project Model: Nature of activity types" classification scheme-->
<activityTypes>
<activityType>research</activityType>
</activityTypes>
<title>
<cmns:text lang="en" country="GB">The title of the project</cmns:text>
</title>
<shortTitle>
<cmns:text lang="en" country="GB">A short title</cmns:text>
</shortTitle>
<acronym>TTotP</acronym>
<!-- Description types should be defined in the "Unified Project Model: Project Descriptions" classification scheme -->
<descriptions>
<cmns:description type="projectdescription">
<cmns:text lang="en" country="GB">The project description</cmns:text>
</cmns:description>
<cmns:description type="laymansdescription">
<cmns:text lang="en" country="GB">A laymans description of the project</cmns:text>
</cmns:description>
<cmns:description type="keyfindings">
<cmns:text lang="en" country="GB">A key findings description of the project</cmns:text>
</cmns:description>
</descriptions>
<!-- ID Type should be defined in the "Unified Project Model: Types of Classified sources" classification scheme -->
<ids>
<cmns:id type="projectid">externalid1</cmns:id>
</ids>
<internalParticipants>
<internalParticipant>
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles should be defined in the "Unified Project Model: Project Roles" classification scheme -->
<role>pi</role>
<!-- Should be a number between 0 and 1 -->
<academicOwnership>1.0</academicOwnership>
<!-- Should be a number between 0 and 1 -->
<plannedResearcherCommitment>0.5</plannedResearcherCommitment>
<associationStartDate>2007-10-26</associationStartDate>
<associationEndDate>2008-02-14</associationEndDate>
</internalParticipant>
</internalParticipants>
<!-- Commitment tracking should be enabled under UPM configuration before loading values -->
<internalParticipantsResearcherCommitment>
<researcherCommitment>
<personId>person1</personId>
<year>2007</year>
<month>11</month>
<!-- Should be a number between 0 and 1 -->
<plannedCommitment>0.5</plannedCommitment>
<!-- Should be a number between 0 and 1 -->
<actualCommitment>0.6</actualCommitment>
</researcherCommitment>
</internalParticipantsResearcherCommitment>
<externalParticipants>
<externalParticipant>
<firstName>John</firstName>
<lastName>Smith</lastName>
<country>gb</country>
<role>coi</role>
<externalOrgName>University of Europe</externalOrgName>
<externalOrgType>unknown</externalOrgType>
<externalOrgId>UoE</externalOrgId>
</externalParticipant>
</externalParticipants>
<!-- Co Managing Organisations should be enabled under the UPM configuration before loading values -->
<coManagingOrganisations>
<organisation id="organisation2"/>
</coManagingOrganisations>
<organisations>
<organisation id="organisation1"/>
</organisations>
<externalOrganisations>
<cmns:externalOrganisationAssociation>
<cmns:externalOrgName>University of Europe</cmns:externalOrgName>
<cmns:externalOrgType>unknown</cmns:externalOrgType>
<cmns:externalOrgId>UoE</cmns:externalOrgId>
</cmns:externalOrganisationAssociation>
</externalOrganisations>
<!-- Must be an internal organisation -->
<managedByOrganisation id="organisation1"/>
<startDate>2007-10-26</startDate>
<endDate>2008-02-14</endDate>
<curtailed>
<date>2008-01-14</date>
<reason>Postponed due to the lack of resources</reason>
</curtailed>
<collaborative>true</collaborative>
<!-- Collaborator type should be defined in the "Unified Project Model: Types of Collaborators" classification scheme -->
<collaborators>
<cmns:collaborator type="jointapplicant">
<cmns:externalOrgName>University of Europe</cmns:externalOrgName>
<cmns:externalOrgType>unknown</cmns:externalOrgType>
<cmns:externalOrgId>UeO</cmns:externalOrgId>
<cmns:leadCollaborator>false</cmns:leadCollaborator>
</cmns:collaborator>
</collaborators>
<relatedAwards>
<relatedAwardId>award1</relatedAwardId>
</relatedAwards>
<relatedApplications>
<relatedApplicationId>application1</relatedApplicationId>
</relatedApplications>
<relatedProjects>
<relatedProject>
<targetProjectId>project2</targetProjectId>
<relationType>partof</relationType>
</relatedProject>
</relatedProjects>
<relatedPublications>
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>
<relatedActivities>
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>
<documents>
<cmns:upmdocuments id="doc1"><!-- Type should be defined in the "Types for documents" classification scheme -->
<cmns:type>text</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/thumb/9/98/Microsoft_Project_%282019%E2%80%93present%29.svg/240px-Microsoft_Project_%282019%E2%80%93present%29.svg.png</cmns:url>
</cmns:http>
</cmns:file>
<cmns:mimeType>image/png</cmns:mimeType>
<cmns:fileName>project.png</cmns:fileName>
<cmns:title>Project Agreement</cmns:title>
<cmns:visibility>Public</cmns:visibility>
</cmns:upmdocuments>
</documents>
<keywords>
<cmns:keyword>Freetext keyword</cmns:keyword>
<cmns:keyword logicalName="sustainabledevelopmentgoals" key="gender_equality"/>
</keywords>
<links>
<cmns:link id="link1">
<cmns:url>http://google.com</cmns:url>
<cmns:type>unspecified</cmns:type>
<cmns:description>
<cmns:text lang="en" country="GB">A link description text</cmns:text>
</cmns:description>
</cmns:link>
</links>
<visibility>Public</visibility>
</upmproject>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="upmproject">
<xs:annotation>
<xs:documentation>
This xml element is used to define a project to synchronise into Pure. This means that one entry in the xml has to exist per project you want to have in Pure. For each project you have to specify a unique ID, which will be the primary source ID for identifiying this project in the synchronisation.
This ID is for synchronisation purposes only, it has to be unique for each project 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 project</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 project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="acronym" type="commons:string_64" minOccurs="0">
<xs:annotation>
<xs:documentation>The acronym of the project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="descriptions" type="commons:descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>The descriptions of the project. Type must be defined in the /dk/atira/pure/upmproject/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 project. Type of ID must be defined in the /dk/atira/pure/upm/classifiedsource classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="internalParticipants"
type="internalParticipants"
minOccurs="0">
<xs:annotation>
<xs:documentation>The internal persons related to the project. At least one internal or external participant is required.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="internalParticipantsResearcherCommitment"
type="researcherCommitmentList"
minOccurs="0">
<xs:annotation>
<xs:documentation>The participants researcher commitment for the project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalParticipants"
type="externalParticipants"
minOccurs="0">
<xs:annotation>
<xs:documentation>The external persons related to the project. At least one internal or external participant is required</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. Co-managing organisations should be enabled under the Unified Project Model configuration</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal organisations related to the project</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 project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managedByOrganisation" type="organisation">
<xs:annotation>
<xs:documentation>The internal organisation that manages the project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="startDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The start date of the project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="endDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The end date of the project</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="collaborative" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Specifies whether it is a collaborative project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="collaborators"
type="commons:externalCollaborators"
minOccurs="0">
<xs:annotation>
<xs:documentation>The collaborative partners on the project. Collaborative should be "true" if providing values here</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedAwards" type="relatedAwards" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any related awards</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedApplications" type="relatedApplications" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any related applications</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedProjects" type="relatedProjects" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any related projects</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedPublications" type="relatedPublications" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any related research outputs</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedActivities" type="relatedActivities" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any related activities</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="commons:upmdocuments" minOccurs="0">
<xs:annotation>
<xs:documentation>Documents attached to the award. Type of document must be defined in the /dk/atira/pure/core/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 project. Should align with keyword configurations for the project content type</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>The links for the project. Type should be defined in the /dk/atira/pure/links/project classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility">
<xs:annotation>
<xs:documentation>The visibility of the project. Accepted values are Public, Campus, Restricted or Confidential</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
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="xs:string" name="id" use="required">
<xs:annotation>
<xs:documentation>Id of the project in the source system</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>Type of the project. Must be defined in the classification scheme /dk/atira/pure/upmproject/upmprojecttypes</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 project in the source system |
xsd:string |
Yes |
@type |
Type of the project. Must be defined in the classification scheme /dk/atira/pure/upmproject/upmprojecttypes |
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 project |
Yes |
|
shortTitle |
The short title of the project |
No |
|
acronym |
The acronym of the project |
No |
|
descriptions |
The descriptions of the project. Type must be defined in the /dk/atira/pure/upmproject/descriptions classification scheme |
No |
|
ids |
The ids of the project. Type of ID must be defined in the /dk/atira/pure/upm/classifiedsource classification scheme |
No |
|
internalParticipants |
The internal persons related to the project. At least one internal or external participant is required. |
No |
|
internalParticipantsResearcherCommitment |
The participants researcher commitment for the project |
No |
|
externalParticipants |
The external persons related to the project. At least one internal or external participant is required |
No |
|
coManagingOrganisations |
The Co-ManagingOrganisations, can not be the managedByOrganisation. Co-managing organisations should be enabled under the Unified Project Model configuration |
No |
|
organisations |
The internal organisations related to the project |
No |
|
externalOrganisations |
The external organisations related to the project |
No |
|
managedByOrganisation |
The internal organisation that manages the project |
Yes |
|
startDate |
The start date of the project |
No |
|
endDate |
The end date of the project |
No |
|
curtailed |
Specifies that the project is curtailed |
No |
|
collaborative |
Specifies whether it is a collaborative project |
xsd:boolean |
No |
collaborators |
The collaborative partners on the project. Collaborative should be "true" if providing values here |
No |
|
relatedAwards |
IDs of any related awards |
No |
|
relatedApplications |
IDs of any related applications |
No |
|
relatedProjects |
IDs of any related projects |
No |
|
relatedPublications |
IDs of any related research outputs |
No |
|
relatedActivities |
IDs of any related activities |
No |
|
documents |
Documents attached to the award. Type of document must be defined in the /dk/atira/pure/core/document/types classification scheme |
No |
|
keywords |
The keywords for the project. Should align with keyword configurations for the project content type |
No |
|
links |
The links for the project. Type should be defined in the /dk/atira/pure/links/project classification scheme |
No |
|
visibility |
The visibility of the project. Accepted values are Public, Campus, Restricted or Confidential |
Yes |
|
workflow |
Basic Workflow valid values: entryInProgress, forApproval, approved, validated |
xsd:string |
No |
activityTypes
A list of activityType elements of type commons:classification
XML Example
<activityTypes xmlns="v1.upmproject.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:sequence>
<xs:element name="activityType"
type="commons:classification"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>token from the classification scheme /dk/atira/pure/upm/nature</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
activityType |
token from the classification scheme /dk/atira/pure/upm/nature |
No |
curtailed
XML Example
<curtailed xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<date>2008-01-14</date>
<reason>Postponed due to the lack of resources</reason>
</curtailed>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="curtailed">
<xs:all>
<xs:element name="date" type="commons:date">
<xs:annotation>
<xs:documentation>Date the project was curtailed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="reason" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Reason the project was curtailed</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
date |
Date the project was curtailed |
Yes |
|
reason |
Reason the project was curtailed |
xsd:string |
No |
Organisations
organisations
A list of organisation elements of type organisation
XML Example
<organisations xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<organisation id="organisation1"/>
</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
The ID of the organisation to lookup. Note that both an ID attribute and an element value must be provided. The element value is used to match against existing organisations
XML Example
<organisation xmlns="v1.upmproject.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>The ID of the organisation to lookup. Note that both an ID attribute and an element value must be provided. The element value is used to match against existing organisations</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="xs:string">
<xs:attribute name="id" type="commons:string_400" use="required">
<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 |
Internal Participants
internalParticipants
A list of internalParticipant elements of type internalParticipant
XML Example
<internalParticipants xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<internalParticipant>
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles should be defined in the "Unified Project Model: Project Roles" classification scheme -->
<role>pi</role>
<!-- Should be a number between 0 and 1 -->
<academicOwnership>1.0</academicOwnership>
<!-- Should be a number between 0 and 1 -->
<plannedResearcherCommitment>0.5</plannedResearcherCommitment>
<associationStartDate>2007-10-26</associationStartDate>
<associationEndDate>2008-02-14</associationEndDate>
</internalParticipant>
</internalParticipants>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="internalParticipants">
<xs:sequence>
<xs:element name="internalParticipant"
type="internalParticipant"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>internalParticipant
An internal person who is a participant on the project
XML Example
<internalParticipant xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<personId>person1</personId>
<organisationIds>
<organisation id="organisation1"/>
</organisationIds>
<!-- Roles should be defined in the "Unified Project Model: Project Roles" classification scheme -->
<role>pi</role>
<!-- Should be a number between 0 and 1 -->
<academicOwnership>1.0</academicOwnership>
<!-- Should be a number between 0 and 1 -->
<plannedResearcherCommitment>0.5</plannedResearcherCommitment>
<associationStartDate>2007-10-26</associationStartDate>
<associationEndDate>2008-02-14</associationEndDate>
</internalParticipant>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="internalParticipant">
<xs:annotation>
<xs:documentation>An internal person who is a participant on the project</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:element name="organisationId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>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 ids of the internal organisations affiliated to this person on this project</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="commons:classification">
<xs:annotation>
<xs:documentation>Role of the person on the project. Must be defined in the classification scheme /dk/atira/pure/upmproject/roles/upmproject</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 project for this participant. Should be between 0 and 1</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="plannedResearcherCommitment" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The planned researcher commitment of the project for this participant. 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 project participant association to the project started</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="associationEndDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date when the project participant association to the project ended</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
personId |
The source id of the person |
Yes |
|
organisationIds |
The source ids of the internal organisations affiliated to this person on this project |
No |
|
role |
Role of the person on the project. Must be defined in the classification scheme /dk/atira/pure/upmproject/roles/upmproject |
Yes |
|
academicOwnership |
The academic ownership percentage of the project for this participant. Should be between 0 and 1 |
xsd:double |
No |
plannedResearcherCommitment |
The planned researcher commitment of the project for this participant. Should be between 0 and 1 |
xsd:double |
No |
associationStartDate |
The date when the project participant association to the project started |
No |
|
associationEndDate |
The date when the project participant association to the project ended |
No |
researcherCommitmentList
A list of researcherCommitment elements of type researcherCommitment
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="researcherCommitmentList">
<xs:sequence>
<xs:element name="researcherCommitment"
type="researcherCommitment"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>researcherCommitment
Researcher commitment can be used for tracking a persons planned commitment to a project as well as the actual time spent
XML Example
<researcherCommitment xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<personId>person1</personId>
<year>2007</year>
<month>11</month>
<!-- Should be a number between 0 and 1 -->
<plannedCommitment>0.5</plannedCommitment>
<!-- Should be a number between 0 and 1 -->
<actualCommitment>0.6</actualCommitment>
</researcherCommitment>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="researcherCommitment">
<xs:annotation>
<xs:documentation>Researcher commitment can be used for tracking a persons planned commitment to a project as well as the actual time spent</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: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</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="plannedCommitment" type="xs:double" minOccurs="0">
<xs:annotation>
<xs:documentation>The planned researcher commitment. 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. 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 |
xsd:int |
Yes |
plannedCommitment |
The planned researcher commitment. Should be between 0 and 1 |
xsd:double |
No |
actualCommitment |
The actual researcher commitment. Should be between 0 and 1 |
xsd:double |
No |
External Participants
externalParticipants
A list of externalParticipant elements of type externalParticipant
XML Example
<externalParticipants xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<externalParticipant>
<firstName>John</firstName>
<lastName>Smith</lastName>
<country>gb</country>
<role>coi</role>
<externalOrgName>University of Europe</externalOrgName>
<externalOrgType>unknown</externalOrgType>
<externalOrgId>UoE</externalOrgId>
</externalParticipant>
</externalParticipants>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalParticipants">
<xs:sequence>
<xs:element name="externalParticipant"
type="externalParticipant"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>externalParticipant
An external person who is a particpant of this project
XML Example
<externalParticipant xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<firstName>John</firstName>
<lastName>Smith</lastName>
<country>gb</country>
<role>coi</role>
<externalOrgName>University of Europe</externalOrgName>
<externalOrgType>unknown</externalOrgType>
<externalOrgId>UoE</externalOrgId>
</externalParticipant>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="externalParticipant">
<xs:annotation>
<xs:documentation>An external person who is a particpant of this project</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>Country the participant is based in. Should be defined in the classification scheme /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="commons:classification">
<xs:annotation>
<xs:documentation>Role of the participant in the project. Should be defined in the classification scheme /dk/atira/pure/upmproject/roles/upmproject</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED: This element has been replaced by externalOrganisations</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgType" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED: This element has been replaced by externalOrganisations</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="externalOrgId" type="commons:string_400" minOccurs="0">
<xs:annotation>
<xs:documentation>DEPRECATED: This element has been replaced by externalOrganisations</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 participant</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 participant was involved in the project</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 participant association</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The ID of the external participant association |
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 |
Country the participant is based in. Should be defined in the classification scheme /dk/atira/pure/core/countries |
No |
|
role |
Role of the participant in the project. Should be defined in the classification scheme /dk/atira/pure/upmproject/roles/upmproject |
Yes |
|
externalOrganisations |
The external organisations related to the participant |
No |
|
period |
The period during which the external participant was involved in the project |
No |
Related Content
relatedProjects
A list of relatedProject elements of type relatedProject
XML Example
<relatedProjects xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedProject>
<targetProjectId>project2</targetProjectId>
<relationType>partof</relationType>
</relatedProject>
</relatedProjects>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedProjects">
<xs:sequence>
<xs:element name="relatedProject" type="relatedProject" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>relatedAwards
A list of relatedAwardId elements of type commons:string_400
XML Example
<relatedAwards xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedAwardId>award1</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>The id of the content, used for matching the content</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedAwardId |
The id of the content, used for matching the content |
Yes |
relatedApplications
A list of relatedApplicationId elements of type commons:string_400
XML Example
<relatedApplications xmlns="v1.upmproject.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>The id of the content, used for matching the content</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedApplicationId |
The id of the content, used for matching the content |
Yes |
relatedPublications
A list of relatedPublicationId elements of type commons:string_400
XML Example
<relatedPublications xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedPublications">
<xs:sequence>
<xs:element name="relatedPublicationId"
type="commons:string_400"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The id of the content, used for matching the content</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedPublicationId |
The id of the content, used for matching the content |
Yes |
relatedActivities
A list of relatedActivityId elements of type commons:string_400
XML Example
<relatedActivities xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedActivities">
<xs:sequence>
<xs:element name="relatedActivityId"
type="commons:string_400"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The id of the content, used for matching the content</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedActivityId |
The id of the content, used for matching the content |
Yes |
relatedProject
XML Example
<relatedProject xmlns="v1.upmproject.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<targetProjectId>project2</targetProjectId>
<relationType>partof</relationType>
</relatedProject>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedProject">
<xs:sequence>
<xs:element name="targetProjectId" type="commons:string_400">
<xs:annotation>
<xs:documentation>The id of the content, used for matching the content</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>
Updated at July 27, 2024