How Can We Help?
Dataset XMLDataset XML
Overview
This page details the Dataset content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Dataset 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 Dataset 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.
Datasets are the artefacts generated through the life of a research project that are made available for other researchers to be able to build upon. The analysis of this data is normally the subject of related research outputs.
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
Dataset
datasets
A list of dataset elements of type dataset
The Root element of the xml
XML Example
<datasets xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Advanced example (most functionalities used) -->
<dataset id="dataset1" type="dataset">
<title>DataSet Title</title>
<!-- Any translated titles will overwrite the general title above -->
<translatedTitles>
<title lang="de">DatSet Title - DE</title>
</translatedTitles>
<!--
Defaults to the standard datasetdescription field. If using other
description classifications use the descriptions element instead
-->
<description>DataSet Desecription</description>
<!--
Reference IDs can be added here but the types need to be added to the
"Datasets: IDs" classification scheme first
-->
<ids>
<cmns:id type="external">123456</cmns:id>
</ids>
<additionalDescriptions><!-- Can provide description values in other supported submission languages -->
<description type="datasetdescription" lang="de">DataSet Desecription - Deutsch</description>
<!--
This type is not present in a standard Pure, only used as example on how to add an additional type.
Any types must be defined in the "Datasets: Descriptions" classification scheme
-->
<description type="background">Additional description</description>
</additionalDescriptions>
<!-- Shows the time period that the dataset covers. Can be omitted or just a from date provided to indicate a point in time -->
<temporalCoverage>
<from><!-- Dates can be just a year if month and day aren't known or relevant -->
<cmns:year>2013</cmns:year>
<cmns:month>2</cmns:month>
<cmns:day>1</cmns:day>
</from>
<to>
<cmns:year>2014</cmns:year>
<cmns:month>12</cmns:month>
<cmns:day>15</cmns:day>
</to>
</temporalCoverage>
<!-- Reflects when the dataset was produced. May overlap with the temporal coverage but could include processing time that doesn't relate to the temporal coverage -->
<productionDate>
<from>
<cmns:year>2015</cmns:year>
</from>
<to>
<cmns:year>2016</cmns:year>
</to>
</productionDate>
<geoLocation><!-- This title is used for all submission local -->
<geographicalCoverage>The data covers the south eastern part of the Willow Forest also known as "The Bend"</geographicalCoverage>
<!-- Translated/Localized title will overwrite to above general title -->
<translatedGeographicalCoverage>
<title lang="de">Die Daten decken den südöstlichen Teil des Willow Forest auch als "The Bend" bekannt</title>
</translatedGeographicalCoverage>
<!-- You can specify either a point or a polygon both have to be specified in google maps format -->
<geoLoc>
<point>-83.48036611, -9.66796875</point>
</geoLoc>
</geoLocation>
<persons><!-- If a person is internal no origin needs to be set --><!-- A person is made the contact person if the attribute contactPerson is set to true. Note: only ONE person is to be set as contact person. -->
<person id="personAssoc1" contactPerson="true">
<person lookupId="person1"/>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Roles should be defined in "Datasets: Roles" classification scheme -->
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
<person id="extPersonAssoc2"><!-- If the person is an external person make sure to state that in the origin attribute -->
<person lookupId="extPerson1" origin="external">
<firstName>Tim</firstName>
<lastName>Cook</lastName>
<!-- Country should be defined in "Countries" classification scheme -->
<country>dk</country>
</person>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation origin="external" lookupId="extOrganisation">
<name>External Organisation - One</name>
<!-- Type should be defined in "Types of External organisations" Classification scheme-->
<type>collaborator</type>
</organisation>
</organisations>
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
</persons>
<organisations><!-- Here you can add any additional organisations, if the organisation is external the origin attribute must reflect that just as with person organisations -->
<organisation lookupId="extOrganisation2" origin="external">
<name>External Organisation - Two</name>
<type>government</type>
</organisation>
<!-- If origin=external is not provided, organisation is assumed to be internal -->
<organisation lookupId="organisation2"/>
</organisations>
<managingOrganisation lookupId="organisation1"/>
<!-- Just the suffix of the DOI should be provided, not the full url -->
<DOI>10.1002/0470841559.ch1</DOI>
<!-- Information about the data if its physical -->
<physicalDatas>
<physicalData id="phy1">
<title>Physical Data Title</title>
<storageLocation>Room 4.25.1</storageLocation>
<media>USB</media>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>interactiveresource</type>
</physicalData>
</physicalDatas>
<availableDate>
<cmns:year>2013</cmns:year>
</availableDate>
<!-- A publisher is required to create a dataset, however, if a default publisher has been configured for datasets you need not state one here as we will use that if none are provided. -->
<publisher lookupId="publisher1"/>
<!-- If content is embargoed you can specify a period for which the dataset is embargoed (specified in months) -->
<openAccess>embargoed</openAccess>
<embargoPeriod>3</embargoPeriod>
<!-- Legal/Ethical constraints on the dataset. The type is a classification from /dk/atira/pure/dataset/legalcondition . -->
<constraints>
<constraint><!-- Type must be defined in the "Datasets: Legal condition types" classification scheme -->
<type>dataprotection</type>
<description>This data must not be stored unencrypted</description>
</constraint>
<constraint>
<type>ethicalapproval</type>
<description>This data must not be used in connection with any military application</description>
</constraint>
</constraints>
<keywords><!-- Keyword group on dataset with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on dataset with logical name ASJCSubjectAreas that is related to classification scheme /dk/atira/pure/subjectarea/asjc must exist -->
<keyword logicalName="ASJCSubjectAreas" key="1700/1701"/>
</keywords>
<links><!-- ID must be unique for the dataset, but is not displayed in the front end editor -->
<link id="link1"><!-- Type must be defined in the "Types of links for Datasets" classification scheme -->
<type>publisher</type>
<description>
<cmns:text>Dataset on Publisher's site</cmns:text>
</description>
<url>https://www.ieee.org/</url>
</link>
<link id="link2">
<url>http://home.cern/</url>
</link>
</links>
<!-- Must be defined in the "Datasets: Document licences" classification scheme -->
<license>cc-by</license>
<documents>
<datasetdocuments id="document1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/5/56/Iris_dataset_scatterplot.svg/1920px-Iris_dataset_scatterplot.svg.png</fileLocation>
<fileName>document.png</fileName>
<embargoDate>2024-10-21</embargoDate>
<!-- Must be defined in the "Datasets: Document licences" classification scheme -->
<license>cc-by</license>
<mimeType>image/png</mimeType>
<title>Document Title</title>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>image</type>
<!-- Can be Public, Campus, Restricted or Confidential -->
<visibility>Public</visibility>
</datasetdocuments>
</documents>
<!--
IDs for all related content types should be one already existing records in Pure
(such as the source id of already imported projects)
-->
<relatedProjects>
<relatedProjectId>project1</relatedProjectId>
</relatedProjects>
<relatedEquipments>
<relatedEquipmentId>equipment1</relatedEquipmentId>
</relatedEquipments>
<relatedActivities>
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>
<relatedPublications>
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>
<relatedStudentThesis>
<relatedStudentThesisId>studentthesis1</relatedStudentThesisId>
</relatedStudentThesis>
<!-- Dataset can be included in same file as Pure will create and then relate the records -->
<relatedDatasets>
<relatedDatasetId>dataset2</relatedDatasetId>
</relatedDatasets>
<!-- Visibility of the dataset. This is used to determine if it is shown on the portal or via APIs -->
<visibility>Public</visibility>
<!-- Workflow must be enabled for datasets before using this field -->
<workflow>validated</workflow>
</dataset>
<dataset id="dataset2" type="dataset">
<title>Dataset for dwelling size and usability in London: a study of floor plan data using machine learning</title>
<description>Based on a dataset of dwelling unit plans (n = 2283) with detailed dimensions derived from open-access plan data using machine learning, this paper analyses the size and usability of dwellings in London. Half of London’s housing stock was built before the Second World War but has been extensively modified. Due to greater pressure on the housing market and problems with dwelling size, London was the first local authority in England to reintroduce space standards for all housing sectors in 2011. Providing a first comprehensive analysis of space standards and dwelling size in London at room level and across all built periods, the data shows that 61% of London homes fail the recommended minimum dwelling sizes of the London Housing Design Guide (2010), 51% a bedroom standard and 88% at least one of the dimensional requirements. The paper quantifies the extent to which homes fail both recent and historical space standards and discusses their effectiveness in relation to dwelling usability and issues of design.</description>
<persons>
<person id="personAssoc1" contactPerson="true">
<person lookupId="person1">
<firstName>Jacoby</firstName>
<lastName>Sam</lastName>
</person>
<organisations>
<organisation lookupId="organisation1"/>
</organisations>
<role>creator</role>
</person>
</persons>
<managingOrganisation lookupId="organisation1"/>
<availableDate>
<cmns:year>2022</cmns:year>
<cmns:month>5</cmns:month>
<cmns:day>9</cmns:day>
</availableDate>
<publisher lookupId="publisher1"/>
<visibility>Public</visibility>
</dataset>
</datasets>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="datasets">
<xs:annotation>
<xs:documentation>The Root element of the xml</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="dataset" 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>dataset
For each dataset record you want created in Pure there should be a new element of this type in the file
XML Example
<dataset xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="dataset1"
type="dataset">
<title>DataSet Title</title>
<!-- Any translated titles will overwrite the general title above -->
<translatedTitles>
<title lang="de">DatSet Title - DE</title>
</translatedTitles>
<!--
Defaults to the standard datasetdescription field. If using other
description classifications use the descriptions element instead
-->
<description>DataSet Desecription</description>
<!--
Reference IDs can be added here but the types need to be added to the
"Datasets: IDs" classification scheme first
-->
<ids>
<cmns:id type="external">123456</cmns:id>
</ids>
<additionalDescriptions><!-- Can provide description values in other supported submission languages -->
<description type="datasetdescription" lang="de">DataSet Desecription - Deutsch</description>
<!--
This type is not present in a standard Pure, only used as example on how to add an additional type.
Any types must be defined in the "Datasets: Descriptions" classification scheme
-->
<description type="background">Additional description</description>
</additionalDescriptions>
<!-- Shows the time period that the dataset covers. Can be omitted or just a from date provided to indicate a point in time -->
<temporalCoverage>
<from><!-- Dates can be just a year if month and day aren't known or relevant -->
<cmns:year>2013</cmns:year>
<cmns:month>2</cmns:month>
<cmns:day>1</cmns:day>
</from>
<to>
<cmns:year>2014</cmns:year>
<cmns:month>12</cmns:month>
<cmns:day>15</cmns:day>
</to>
</temporalCoverage>
<!-- Reflects when the dataset was produced. May overlap with the temporal coverage but could include processing time that doesn't relate to the temporal coverage -->
<productionDate>
<from>
<cmns:year>2015</cmns:year>
</from>
<to>
<cmns:year>2016</cmns:year>
</to>
</productionDate>
<geoLocation><!-- This title is used for all submission local -->
<geographicalCoverage>The data covers the south eastern part of the Willow Forest also known as "The Bend"</geographicalCoverage>
<!-- Translated/Localized title will overwrite to above general title -->
<translatedGeographicalCoverage>
<title lang="de">Die Daten decken den südöstlichen Teil des Willow Forest auch als "The Bend" bekannt</title>
</translatedGeographicalCoverage>
<!-- You can specify either a point or a polygon both have to be specified in google maps format -->
<geoLoc>
<point>-83.48036611, -9.66796875</point>
</geoLoc>
</geoLocation>
<persons><!-- If a person is internal no origin needs to be set --><!-- A person is made the contact person if the attribute contactPerson is set to true. Note: only ONE person is to be set as contact person. -->
<person id="personAssoc1" contactPerson="true">
<person lookupId="person1"/>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Roles should be defined in "Datasets: Roles" classification scheme -->
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
<person id="extPersonAssoc2"><!-- If the person is an external person make sure to state that in the origin attribute -->
<person lookupId="extPerson1" origin="external">
<firstName>Tim</firstName>
<lastName>Cook</lastName>
<!-- Country should be defined in "Countries" classification scheme -->
<country>dk</country>
</person>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation origin="external" lookupId="extOrganisation">
<name>External Organisation - One</name>
<!-- Type should be defined in "Types of External organisations" Classification scheme-->
<type>collaborator</type>
</organisation>
</organisations>
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
</persons>
<organisations><!-- Here you can add any additional organisations, if the organisation is external the origin attribute must reflect that just as with person organisations -->
<organisation lookupId="extOrganisation2" origin="external">
<name>External Organisation - Two</name>
<type>government</type>
</organisation>
<!-- If origin=external is not provided, organisation is assumed to be internal -->
<organisation lookupId="organisation2"/>
</organisations>
<managingOrganisation lookupId="organisation1"/>
<!-- Just the suffix of the DOI should be provided, not the full url -->
<DOI>10.1002/0470841559.ch1</DOI>
<!-- Information about the data if its physical -->
<physicalDatas>
<physicalData id="phy1">
<title>Physical Data Title</title>
<storageLocation>Room 4.25.1</storageLocation>
<media>USB</media>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>interactiveresource</type>
</physicalData>
</physicalDatas>
<availableDate>
<cmns:year>2013</cmns:year>
</availableDate>
<!-- A publisher is required to create a dataset, however, if a default publisher has been configured for datasets you need not state one here as we will use that if none are provided. -->
<publisher lookupId="publisher1"/>
<!-- If content is embargoed you can specify a period for which the dataset is embargoed (specified in months) -->
<openAccess>embargoed</openAccess>
<embargoPeriod>3</embargoPeriod>
<!-- Legal/Ethical constraints on the dataset. The type is a classification from /dk/atira/pure/dataset/legalcondition . -->
<constraints>
<constraint><!-- Type must be defined in the "Datasets: Legal condition types" classification scheme -->
<type>dataprotection</type>
<description>This data must not be stored unencrypted</description>
</constraint>
<constraint>
<type>ethicalapproval</type>
<description>This data must not be used in connection with any military application</description>
</constraint>
</constraints>
<keywords><!-- Keyword group on dataset with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on dataset with logical name ASJCSubjectAreas that is related to classification scheme /dk/atira/pure/subjectarea/asjc must exist -->
<keyword logicalName="ASJCSubjectAreas" key="1700/1701"/>
</keywords>
<links><!-- ID must be unique for the dataset, but is not displayed in the front end editor -->
<link id="link1"><!-- Type must be defined in the "Types of links for Datasets" classification scheme -->
<type>publisher</type>
<description>
<cmns:text>Dataset on Publisher's site</cmns:text>
</description>
<url>https://www.ieee.org/</url>
</link>
<link id="link2">
<url>http://home.cern/</url>
</link>
</links>
<!-- Must be defined in the "Datasets: Document licences" classification scheme -->
<license>cc-by</license>
<documents>
<datasetdocuments id="document1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/5/56/Iris_dataset_scatterplot.svg/1920px-Iris_dataset_scatterplot.svg.png</fileLocation>
<fileName>document.png</fileName>
<embargoDate>2024-10-21</embargoDate>
<!-- Must be defined in the "Datasets: Document licences" classification scheme -->
<license>cc-by</license>
<mimeType>image/png</mimeType>
<title>Document Title</title>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>image</type>
<!-- Can be Public, Campus, Restricted or Confidential -->
<visibility>Public</visibility>
</datasetdocuments>
</documents>
<!--
IDs for all related content types should be one already existing records in Pure
(such as the source id of already imported projects)
-->
<relatedProjects>
<relatedProjectId>project1</relatedProjectId>
</relatedProjects>
<relatedEquipments>
<relatedEquipmentId>equipment1</relatedEquipmentId>
</relatedEquipments>
<relatedActivities>
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>
<relatedPublications>
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>
<relatedStudentThesis>
<relatedStudentThesisId>studentthesis1</relatedStudentThesisId>
</relatedStudentThesis>
<!-- Dataset can be included in same file as Pure will create and then relate the records -->
<relatedDatasets>
<relatedDatasetId>dataset2</relatedDatasetId>
</relatedDatasets>
<!-- Visibility of the dataset. This is used to determine if it is shown on the portal or via APIs -->
<visibility>Public</visibility>
<!-- Workflow must be enabled for datasets before using this field -->
<workflow>validated</workflow>
</dataset>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="datasetType">
<xs:annotation>
<xs:documentation>For each dataset record you want created in Pure there should be a new element of this type in the file</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="title" type="commons:string_1024" minOccurs="1">
<xs:annotation>
<xs:documentation>The title of the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedTitles" type="translatedTitles" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the dataset, use if title in different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The description of the dataset, this will add a description of the type /dk/atira/pure/dataset/descriptions/datasetdescription</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="ids" type="commons:ids" minOccurs="0">
<xs:annotation>
<xs:documentation>type attribute must be a token from the classification scheme /dk/atira/pure/dataset/datasetsources/dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalDescriptions" type="descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional descriptions of the dataset, use both for different languages and for other descriptions defined in the /dk/atira/pure/dataset/descriptions classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="temporalCoverage" type="temporalCoverage" minOccurs="0">
<xs:annotation>
<xs:documentation>The period of time the dataset covers</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="productionDate" type="productionDate" minOccurs="0">
<xs:annotation>
<xs:documentation>The date/period the dataset was produced</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="geoLocation" type="geoLocation" minOccurs="0">
<xs:annotation>
<xs:documentation>The details of the geographical area the dataset covers.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="persons" type="persons" minOccurs="0">
<xs:annotation>
<xs:documentation>The persons (internal or external) related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The organisations (internal or external) related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managingOrganisation" type="organisation" minOccurs="1">
<xs:annotation>
<xs:documentation>The managing organisation of the dataset, this must always be an internal organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="DOI" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>The DOI for the dataset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="physicalDatas" type="physicalDatas" minOccurs="0">
<xs:annotation>
<xs:documentation>The details of the physical data.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="availableDate" type="commons:compoundDate" minOccurs="1">
<xs:annotation>
<xs:documentation>The date on which the dataset was published.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="publisher" type="publisher" minOccurs="1">
<xs:annotation>
<xs:documentation>The publisher of the dataset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="openAccess" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether the data is accesible to others. Token from the classification scheme /dk/atira/pure/core/openaccesspermission</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="embargoPeriod" type="xs:integer" minOccurs="0">
<xs:annotation>
<xs:documentation>The embargo period for the dataset if access option is embargoed, value is in number of months</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="constraints" type="constraints" minOccurs="0">
<xs:annotation>
<xs:documentation>The legal and ethical constraints on the use of the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>Keywords of the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="links" minOccurs="0">
<xs:annotation>
<xs:documentation>The links for the dataset.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="license" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
License that the data is available under. Token from the classification scheme /dk/atira/pure/dataset/documentlicenses
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>Documents are only imported (not synchronized). In addition, the file size must adhere to the configured max value in Pure. Any file exceeding this limit will be added as a link.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedProjects" type="relatedProjects" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any projects that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedEquipments" type="relatedEquipments" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any equipment/facilities that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedStudentThesis"
type="relatedStudentThesis"
minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any student theses that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedPublications" type="relatedPublications" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any research outputs that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedActivities" type="relatedActivities" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any activities that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="relatedDatasets" type="relatedDatasets" minOccurs="0">
<xs:annotation>
<xs:documentation>IDs of any other datasets that are related to the dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>The visibility of the dataset. This will determine if it is visible on the Portal</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="workflow" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>
Used to set the workflow state of the dataset (Workflow states: entryInProgress, forValidation, validated)
NOTE workflow is disabled by default, therefore it must be enabled in Pure if values are present in this tag
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>The external ID of the dataset, this must be an unique value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="commons:classification"
name="type"
use="optional"
default="dataset">
<xs:annotation>
<xs:documentation>The type classification. Should be a token from the scheme /dk/atira/pure/dataset/datasettypes/dataset</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Determines whether the dataset is managed in Pure, if set to to true the dataset will be fully editable and deletable in Pure</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The external ID of the dataset, this must be an unique value |
Yes |
|
@type |
The type classification. Should be a token from the scheme /dk/atira/pure/dataset/datasettypes/dataset |
Yes |
|
@managedInPure |
Determines whether the dataset is managed in Pure, if set to to true the dataset will be fully editable and deletable in Pure |
xsd:boolean |
Yes |
title |
The title of the dataset |
Yes |
|
translatedTitles |
Translated titles of the dataset, use if title in different in another language |
No |
|
description |
The description of the dataset, this will add a description of the type /dk/atira/pure/dataset/descriptions/datasetdescription |
xsd:string |
No |
ids |
type attribute must be a token from the classification scheme /dk/atira/pure/dataset/datasetsources/dataset |
No |
|
additionalDescriptions |
Additional descriptions of the dataset, use both for different languages and for other descriptions defined in the /dk/atira/pure/dataset/descriptions classification scheme |
No |
|
temporalCoverage |
The period of time the dataset covers |
No |
|
productionDate |
The date/period the dataset was produced |
No |
|
geoLocation |
The details of the geographical area the dataset covers. |
No |
|
persons |
The persons (internal or external) related to the dataset |
No |
|
organisations |
The organisations (internal or external) related to the dataset |
No |
|
managingOrganisation |
The managing organisation of the dataset, this must always be an internal organisation |
Yes |
|
DOI |
The DOI for the dataset. |
No |
|
physicalDatas |
The details of the physical data. |
No |
|
availableDate |
The date on which the dataset was published. |
Yes |
|
publisher |
The publisher of the dataset. |
Yes |
|
openAccess |
Whether the data is accesible to others. Token from the classification scheme /dk/atira/pure/core/openaccesspermission |
No |
|
embargoPeriod |
The embargo period for the dataset if access option is embargoed, value is in number of months |
xsd:integer |
No |
constraints |
The legal and ethical constraints on the use of the dataset |
No |
|
keywords |
Keywords of the dataset |
No |
|
links |
The links for the dataset. |
No |
|
license |
License that the data is available under. Token from the classification scheme /dk/atira/pure/dataset/documentlicenses |
No |
|
documents |
Documents are only imported (not synchronized). In addition, the file size must adhere to the configured max value in Pure. Any file exceeding this limit will be added as a link. |
No |
|
relatedProjects |
IDs of any projects that are related to the dataset |
No |
|
relatedEquipments |
IDs of any equipment/facilities that are related to the dataset |
No |
|
relatedStudentThesis |
IDs of any student theses that are related to the dataset |
No |
|
relatedPublications |
IDs of any research outputs that are related to the dataset |
No |
|
relatedActivities |
IDs of any activities that are related to the dataset |
No |
|
relatedDatasets |
IDs of any other datasets that are related to the dataset |
No |
|
visibility |
The visibility of the dataset. This will determine if it is visible on the Portal |
No |
|
workflow |
Used to set the workflow state of the dataset (Workflow states: entryInProgress, forValidation, validated) NOTE workflow is disabled by default, therefore it must be enabled in Pure if values are present in this tag |
xsd:string |
No |
Translations
translatedTitles
A list of title elements of type commons:localized_text_1024_lang
XML Example
<translatedTitles xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<title lang="de">DatSet Title - DE</title>
</translatedTitles>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedTitles">
<xs:sequence>
<xs:element name="title"
type="commons:localized_text_1024_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated title of the dataset, can be specified in multi languages if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
title |
Translated title of the dataset, can be specified in multi languages if your Pure is multilingual |
Yes |
translatedGeographicalCoverage
A list of title elements of type commons:localized_text_256_lang
XML Example
<translatedGeographicalCoverage xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<title lang="de">Die Daten decken den südöstlichen Teil des Willow Forest auch als "The Bend" bekannt</title>
</translatedGeographicalCoverage>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
name="translatedGeographicalCoverage">
<xs:sequence>
<xs:element name="title"
type="commons:localized_text_256_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated geographical coverage of the dataset, can be specified in multi languages if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
title |
Translated geographical coverage of the dataset, can be specified in multi languages if your Pure is multilingual |
Yes |
Persons
persons
A list of person elements of type datasetPerson
XML Example
<persons xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- If a person is internal no origin needs to be set --><!-- A person is made the contact person if the attribute contactPerson is set to true. Note: only ONE person is to be set as contact person. -->
<person id="personAssoc1" contactPerson="true">
<person lookupId="person1"/>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Roles should be defined in "Datasets: Roles" classification scheme -->
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
<person id="extPersonAssoc2"><!-- If the person is an external person make sure to state that in the origin attribute -->
<person lookupId="extPerson1" origin="external">
<firstName>Tim</firstName>
<lastName>Cook</lastName>
<!-- Country should be defined in "Countries" classification scheme -->
<country>dk</country>
</person>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation origin="external" lookupId="extOrganisation">
<name>External Organisation - One</name>
<!-- Type should be defined in "Types of External organisations" Classification scheme-->
<type>collaborator</type>
</organisation>
</organisations>
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>
</persons>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="persons">
<xs:sequence>
<xs:element name="person" type="datasetPerson" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>datasetPerson
This reflects a person (either internal or external) responsible for the dataset
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="datasetPerson">
<xs:annotation>
<xs:documentation>This reflects a person (either internal or external) responsible for the dataset</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="person" type="person">
<xs:annotation>
<xs:documentation>The identification details of the person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The organisations related to the dataset through the person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="role" type="commons:classification" minOccurs="1">
<xs:annotation>
<xs:documentation>The persons role in the creation of the dataset. Token from the classification scheme /dk/atira/pure/dataset/roles/dataset</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="associationStartDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date when the person association to the dataset started</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="associationEndDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>The date when the person association to the dataset ended</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 developer, this must be unique for each person on the dataset</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="contactPerson" use="optional">
<xs:annotation>
<xs:documentation>Indicates whether this person is the contact person for the dataset. Only ONE person can be the contact person and it has to be an INTERNAL person. Setting this attribute on multiple persons will result in errors.</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the developer, this must be unique for each person on the dataset |
Yes |
|
@contactPerson |
Indicates whether this person is the contact person for the dataset. Only ONE person can be the contact person and it has to be an INTERNAL person. Setting this attribute on multiple persons will result in errors. |
xsd:boolean |
Yes |
person |
The identification details of the person |
Yes |
|
organisations |
The organisations related to the dataset through the person |
No |
|
role |
The persons role in the creation of the dataset. Token from the classification scheme /dk/atira/pure/dataset/roles/dataset |
Yes |
|
associationStartDate |
The date when the person association to the dataset started |
No |
|
associationEndDate |
The date when the person association to the dataset ended |
No |
person
Can be woth an internal and external person, use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person and id is given matching will be done on the id, if not found mathching will be done on name, if still not found then an external person with the specified id and name will be created.
XML Example
<person xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="personAssoc1"
contactPerson="true">
<person lookupId="person1"/>
<organisations><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation lookupId="organisation1"/>
</organisations>
<!-- Roles should be defined in "Datasets: Roles" classification scheme -->
<role>datacollector</role>
<associationStartDate>2002-02-02</associationStartDate>
</person>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="person">
<xs:annotation>
<xs:documentation>
Can be woth an internal and external person, use origin to enforce either internal or external
If the person is an internal person in Pure, then the lookupId attribute must be used.
If the person is an external person and id is given matching will be done on the id, if not found mathching will be done on name, if still not found then an external person with the specified id and name will be created.
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="firstName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>First name of the person, will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="lastName" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Last name of the person, will only be used on external persons</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>token from the classification scheme /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId"/>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
|
Yes |
|
firstName |
First name of the person, will only be used on external persons |
No |
|
lastName |
Last name of the person, will only be used on external persons |
No |
|
country |
token from the classification scheme /dk/atira/pure/core/countries |
No |
Organisations
organisations
A list of organisation elements of type organisation
XML Example
<organisations xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Organisations are assumed to be internal unless marked as origin=external -->
<organisation lookupId="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
Can be both an internal and external organisation, use origin to enforce either internal or external
If the organisation is an internal organisation in Pure, then the lookupId attribute must be used.
If the organisation is an external organisation and id is given matching will be done on the id, if not found mathching will be done on name, if still not found then an external organisation with the specified id and organisation will be created.
XML Example
<organisation xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:annotation>
<xs:documentation>
Can be both an internal and external organisation, use origin to enforce either internal or external
If the organisation is an internal organisation in Pure, then the lookupId attribute must be used.
If the organisation is an external organisation and id is given matching will be done on the id, if not found mathching will be done on name, if still not found then an external organisation with the specified id and organisation will be created.
</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="name" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of an external organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="country" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The country of the external organisation. token from /dk/atira/pure/core/countries</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The type of the external organisation (will default if nothing is written)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId"/>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
|
Yes |
|
name |
Name of an external organisation |
No |
|
country |
The country of the external organisation. token from /dk/atira/pure/core/countries |
No |
|
type |
The type of the external organisation (will default if nothing is written) |
No |
Descriptions
descriptions
A list of description elements of type description
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="descriptions">
<xs:sequence>
<xs:element name="description" type="description" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>description
A description value of a particular language
XML Example
<description xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">DataSet Desecription</description>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="description">
<xs:annotation>
<xs:documentation>A description value of a particular language</xs:documentation>
</xs:annotation>
<xs:simpleContent>
<xs:extension base="commons:localized_text_lang">
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>The description field the value is for. The value should be a token from the classification scheme /dk/atira/pure/dataset/descriptions</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@type |
The description field the value is for. The value should be a token from the classification scheme /dk/atira/pure/dataset/descriptions |
Yes |
Keywords
keywords
A list of keyword elements of type commons:keyword
A series of free text and/or defined keywords in classification schemes. These should match defined keywords under the Administrator menu
XML Example
<keywords xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Keyword group on dataset with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on dataset with logical name ASJCSubjectAreas that is related to classification scheme /dk/atira/pure/subjectarea/asjc must exist -->
<keyword logicalName="ASJCSubjectAreas" key="1700/1701"/>
</keywords>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="keywords">
<xs:annotation>
<xs:documentation>A series of free text and/or defined keywords in classification schemes. These should match defined keywords under the Administrator menu</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="keyword" type="commons:keyword" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
keyword |
|
Yes |
Physical Data
physicalDatas
A list of physicalData elements of type physicalData
XML Example
<physicalDatas xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<physicalData id="phy1">
<title>Physical Data Title</title>
<storageLocation>Room 4.25.1</storageLocation>
<media>USB</media>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>interactiveresource</type>
</physicalData>
</physicalDatas>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="physicalDatas">
<xs:sequence>
<xs:element name="physicalData" type="physicalData" maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The list of physical data</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>physicalData
Reference details for any physical data in the dataset
XML Example
<physicalData xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="phy1">
<title>Physical Data Title</title>
<storageLocation>Room 4.25.1</storageLocation>
<media>USB</media>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>interactiveresource</type>
</physicalData>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="physicalData">
<xs:annotation>
<xs:documentation>Reference details for any physical data in the dataset</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="title" type="commons:string_256" minOccurs="1">
<xs:annotation>
<xs:documentation>The title/description of the physical data</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="storageLocation" type="commons:string_256" minOccurs="1">
<xs:annotation>
<xs:documentation>Where the data is stored</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="accessDescription" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>How the data can be accessed</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="media" type="commons:string_256" minOccurs="1">
<xs:annotation>
<xs:documentation>What medium the data is stored in</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>The type of the physical data. token from the classification scheme /dk/atira/pure/dataset/documents</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 physical data, this must be unique for each physical data entry for the dataset</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the physical data, this must be unique for each physical data entry for the dataset |
Yes |
|
title |
The title/description of the physical data |
Yes |
|
storageLocation |
Where the data is stored |
Yes |
|
accessDescription |
How the data can be accessed |
No |
|
media |
What medium the data is stored in |
Yes |
|
type |
The type of the physical data. token from the classification scheme /dk/atira/pure/dataset/documents |
Yes |
Publisher
publisher
Details of the publisher of the dataset. Pure will attempt to match to existing records based on ID or name and create if not found
XML Example
<publisher xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="publisher1"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="publisher">
<xs:annotation>
<xs:documentation>Details of the publisher of the dataset. Pure will attempt to match to existing records based on ID or name and create if not found</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="name" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>The name of the publisher</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>The type of the publisher. The token should be from the classification scheme /dk/atira/pure/publisher/publishertypes</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:lookupId">
<xs:annotation>
<xs:documentation>The lookup ID can be a Source ID, Pure ID or classification defined ID</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:lookupId |
The lookup ID can be a Source ID, Pure ID or classification defined ID |
Yes |
|
name |
The name of the publisher |
No |
|
type |
The type of the publisher. The token should be from the classification scheme /dk/atira/pure/publisher/publishertypes |
No |
Coverage
geoLocation
Details of the geographical area that the data covers
XML Example
<geoLocation xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- This title is used for all submission local -->
<geographicalCoverage>The data covers the south eastern part of the Willow Forest also known as "The Bend"</geographicalCoverage>
<!-- Translated/Localized title will overwrite to above general title -->
<translatedGeographicalCoverage>
<title lang="de">Die Daten decken den südöstlichen Teil des Willow Forest auch als "The Bend" bekannt</title>
</translatedGeographicalCoverage>
<!-- You can specify either a point or a polygon both have to be specified in google maps format -->
<geoLoc>
<point>-83.48036611, -9.66796875</point>
</geoLoc>
</geoLocation>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="geoLocation">
<xs:annotation>
<xs:documentation>Details of the geographical area that the data covers</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="geographicalCoverage" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>A description of the geographical coverage</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedGeographicalCoverage"
type="translatedGeographicalCoverage"
minOccurs="0">
<xs:annotation>
<xs:documentation>Translated geographical coverage of the dataset, use if geographical coverage is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="geoLoc" type="geoLoc" minOccurs="0">
<xs:annotation>
<xs:documentation>The geographical description of the dataset (either a point or a polygon)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
geographicalCoverage |
A description of the geographical coverage |
No |
|
translatedGeographicalCoverage |
Translated geographical coverage of the dataset, use if geographical coverage is different in another language |
No |
|
geoLoc |
The geographical description of the dataset (either a point or a polygon) |
No |
geoLoc
XML Example
<geoLoc xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<point>-83.48036611, -9.66796875</point>
</geoLoc>XSD Definition
<xs:all>
<xs:element name="point" type="commons:string_512" minOccurs="0">
<xs:annotation>
<xs:documentation>A geospatial point. Google maps format</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="polygon" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>A geospatial polygon. Google maps format</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
point |
A geospatial point. Google maps format |
No |
|
polygon |
A geospatial polygon. Google maps format |
xsd:string |
No |
temporalCoverage
The time period that the dataset covers. Full dates don't need to provided, just years or months. Only one date can be provided to indicate a specific point in time
XML Example
<temporalCoverage xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<from><!-- Dates can be just a year if month and day aren't known or relevant -->
<cmns:year>2013</cmns:year>
<cmns:month>2</cmns:month>
<cmns:day>1</cmns:day>
</from>
<to>
<cmns:year>2014</cmns:year>
<cmns:month>12</cmns:month>
<cmns:day>15</cmns:day>
</to>
</temporalCoverage>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="temporalCoverage">
<xs:annotation>
<xs:documentation>The time period that the dataset covers. Full dates don't need to provided, just years or months. Only one date can be provided to indicate a specific point in time</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="from" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>The from date. Can be just a year or a year and month</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="to" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>The to date. Can be just a year or a year and month</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
from |
The from date. Can be just a year or a year and month |
No |
|
to |
The to date. Can be just a year or a year and month |
No |
productionDate
The time period in which the dataset was produced. Full dates don't need to provided, just years or months. Only one date can be provided to indicate a specific point in time
XML Example
<productionDate xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<from>
<cmns:year>2015</cmns:year>
</from>
<to>
<cmns:year>2016</cmns:year>
</to>
</productionDate>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="productionDate">
<xs:annotation>
<xs:documentation>The time period in which the dataset was produced. Full dates don't need to provided, just years or months. Only one date can be provided to indicate a specific point in time</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="from" type="commons:compoundDate" minOccurs="1">
<xs:annotation>
<xs:documentation>The from date</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="to" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>The to date</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
from |
The from date |
Yes |
|
to |
The to date |
No |
Constraints
constraints
A list of constraint elements of type constraint
Legal and ethical constraints on how the data can be used
XML Example
<constraints xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<constraint><!-- Type must be defined in the "Datasets: Legal condition types" classification scheme -->
<type>dataprotection</type>
<description>This data must not be stored unencrypted</description>
</constraint>
<constraint>
<type>ethicalapproval</type>
<description>This data must not be used in connection with any military application</description>
</constraint>
</constraints>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="constraints">
<xs:annotation>
<xs:documentation>
Legal and ethical constraints on how the data can be used
</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="constraint" type="constraint" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>constraint
XML Example
<constraint xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Type must be defined in the "Datasets: Legal condition types" classification scheme -->
<type>dataprotection</type>
<description>This data must not be stored unencrypted</description>
</constraint>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="constraint">
<xs:all>
<xs:element name="type" type="commons:classification">
<xs:annotation>
<xs:documentation>The type of the constraint. It must be a token from the classification scheme /dk/atira/pure/dataset/legalcondition</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="xs:string">
<xs:annotation>
<xs:documentation>The description of the constraint of how the data may be used</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
type |
The type of the constraint. It must be a token from the classification scheme /dk/atira/pure/dataset/legalcondition |
Yes |
|
description |
The description of the constraint of how the data may be used |
xsd:string |
Yes |
Related Content
relatedDatasets
A list of relatedDatasetId elements of type commons:string_400
IDs of datasets related to this dataset
Accordion Title
<relatedDatasets xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedDatasetId>dataset2</relatedDatasetId>
</relatedDatasets>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedDatasets">
<xs:annotation>
<xs:documentation>IDs of datasets related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedDatasetId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedDatasetId |
|
Yes |
relatedProjects
A list of relatedProjectId elements of type commons:string_400
IDs of projects related to this dataset
Accordion Title
<relatedProjects xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedProjectId>project1</relatedProjectId>
</relatedProjects>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedProjects">
<xs:annotation>
<xs:documentation>IDs of projects related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedProjectId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedProjectId |
|
Yes |
relatedEquipments
A list of relatedEquipmentId elements of type commons:string_400
IDs of equipments and facilities related to this dataset
Accordion Title
<relatedEquipments xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedEquipmentId>equipment1</relatedEquipmentId>
</relatedEquipments>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedEquipments">
<xs:annotation>
<xs:documentation>IDs of equipments and facilities related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedEquipmentId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedEquipmentId |
|
Yes |
relatedStudentThesis
A list of relatedStudentThesisId elements of type commons:string_400
IDs of Student Theses related to this dataset
Accordion Title
<relatedStudentThesis xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedStudentThesisId>studentthesis1</relatedStudentThesisId>
</relatedStudentThesis>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedStudentThesis">
<xs:annotation>
<xs:documentation>IDs of Student Theses related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedStudentThesisId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedStudentThesisId |
|
Yes |
relatedPublications
A list of relatedPublicationId elements of type commons:string_400
IDs of research outputs related to this dataset
Accordion Title
<relatedPublications xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedPublicationId>research_output1</relatedPublicationId>
</relatedPublications>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedPublications">
<xs:annotation>
<xs:documentation>IDs of research outputs related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedPublicationId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedPublicationId |
|
Yes |
relatedActivities
A list of relatedActivityId elements of type commons:string_400
IDs of activities related to this dataset
Accordion Title
<relatedActivities xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<relatedActivityId>activityAttendance1</relatedActivityId>
</relatedActivities>Accordion Title
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="relatedActivities">
<xs:annotation>
<xs:documentation>IDs of activities related to this dataset</xs:documentation>
</xs:annotation>
<xs:sequence>
<xs:element name="relatedActivityId"
type="commons:string_400"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
relatedActivityId |
|
Yes |
Documents
documents
A list of datasetdocuments elements of type datasetdocument
XML Example
<documents xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<datasetdocuments id="document1">
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/5/56/Iris_dataset_scatterplot.svg/1920px-Iris_dataset_scatterplot.svg.png</fileLocation>
<fileName>document.png</fileName>
<embargoDate>2024-10-21</embargoDate>
<!-- Must be defined in the "Datasets: Document licences" classification scheme -->
<license>cc-by</license>
<mimeType>image/png</mimeType>
<title>Document Title</title>
<!-- Type should be defined in the "Datasets: Document types" Classification scheme -->
<type>image</type>
<!-- Can be Public, Campus, Restricted or Confidential -->
<visibility>Public</visibility>
</datasetdocuments>
</documents>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="documents">
<xs:sequence>
<xs:element name="datasetdocuments"
type="datasetdocument"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>
datasetdocument
An electronic file of the dataset
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="datasetdocument">
<xs:annotation>
<xs:documentation>An electronic file of the dataset</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="type"
type="commons:classification"
minOccurs="0"
default="other">
<xs:annotation>
<xs:documentation>
Should be defined in the /dk/atira/pure/dataset/documents classification scheme
</xs:documentation>
</xs:annotation>
</xs:element>
<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="mimeType" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
Mimetype of the file. If not provided Pure will attempt to derive
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
Name of the file. If not provided Pure will attempt to derive from the file location
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
Title of the file. If not provided Pure will attempt to derive from the file name
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="embargoDate" type="commons:date" minOccurs="0">
<xs:annotation>
<xs:documentation>
Date that the file should be released from embargo
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="license" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
License that the file can be used under. Must be a token from the classification scheme /dk/atira/pure/dataset/documentlicenses
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>
Visibility of the file. Options are Public, Restricted, Campus or Confidential.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>
Unique identifier for the file
</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
XML Attribute/Element |
Description |
Type |
Mandatory |
@id |
Unique identifier for the file |
Yes |
|
type |
Should be defined in the /dk/atira/pure/dataset/documents classification scheme |
No |
|
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 |
|
mimeType |
Mimetype of the file. If not provided Pure will attempt to derive |
No |
|
fileName |
Name of the file. If not provided Pure will attempt to derive from the file location |
No |
|
title |
Title of the file. If not provided Pure will attempt to derive from the file name |
No |
|
embargoDate |
Date that the file should be released from embargo |
No |
|
license |
License that the file can be used under. Must be a token from the classification scheme /dk/atira/pure/dataset/documentlicenses |
No |
|
visibility |
Visibility of the file. Options are Public, Restricted, Campus or Confidential. |
No |
Links
links
A list of link elements of type link
XML Example
<links xmlns="v1.dataset.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- ID must be unique for the dataset, but is not displayed in the front end editor -->
<link id="link1"><!-- Type must be defined in the "Types of links for Datasets" classification scheme -->
<type>publisher</type>
<description>
<cmns:text>Dataset on Publisher's site</cmns:text>
</description>
<url>https://www.ieee.org/</url>
</link>
<link id="link2">
<url>http://home.cern/</url>
</link>
</links>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="links">
<xs:sequence>
<xs:element name="link" type="link" minOccurs="1" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>link
Link where the dataset can be accessed
XML Example
<link xmlns="v1.dataset.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="link1"><!-- Type must be defined in the "Types of links for Datasets" classification scheme -->
<type>publisher</type>
<description>
<cmns:text>Dataset on Publisher's site</cmns:text>
</description>
<url>https://www.ieee.org/</url>
</link>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="link">
<xs:annotation>
<xs:documentation>Link where the dataset can be accessed</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="url" type="xs:string">
<xs:annotation>
<xs:documentation>Full url of the link</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="type" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>Type of the link. Token should be in the /dk/atira/pure/links/dataset classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="commons:localized_string" minOccurs="0">
<xs:annotation>
<xs:documentation>Free text description of the link</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>An identifier for the link, should be unique for the dataset. </xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
An identifier for the link, should be unique for the dataset. |
Yes |
|
url |
Full url of the link |
xsd:string |
Yes |
type |
Type of the link. Token should be in the /dk/atira/pure/links/dataset classification scheme |
No |
|
description |
Free text description of the link |
No |
Updated at July 27, 2024