How Can We Help?
Impact XMLImpact XML
Overview
This page details the Impact content type. On this page you will find different representations of the data elements contained within this type.
Below is the xsd for the Impact 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 Impact 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.
Impact captures the real world results of the research conducted at your institution. This normally involves some evidence of it being applied over a multi-year period
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
Impacts
impacts
A list of impact elements of type impact
The root element of the document
XML Example
<impacts xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<impact id="impact1" type="impact" managedInPure="false"><!--Required title-->
<title>Main title</title>
<!--Optional list of -->
<translatedTitles>
<title lang="de">Title in other language</title>
</translatedTitles>
<description>Impact Description</description>
<additionalDescriptions>
<description type="impactdescription" lang="de">Impact Desecription - Deutsch</description>
<!--'additionaldescription' classification is not present in a standard Pure, only used as example on how to add an additional type -->
<description type="additionaldescription">Additional description</description>
</additionalDescriptions>
<startDate>
<cmns:year>2001</cmns:year>
<cmns:month>9</cmns:month>
<cmns:day>11</cmns:day>
</startDate>
<endDate>
<cmns:year>2021</cmns:year>
<cmns:month>12</cmns:month>
<cmns:day>24</cmns:day>
</endDate>
<!--corresponds to classification /dk/atira/pure/impact/impactstatus -->
<impactStatus>open</impactStatus>
<!--corresponds to classification /dk/atira/pure/impact/impactnature -->
<impactCategories>
<impactCategory>culturalimpacts</impactCategory>
<impactCategory>publicpolicyimpacts</impactCategory>
</impactCategories>
<!--corresponds to classification /dk/atira/pure/impact/impactlevel -->
<impactLevel>engagement</impactLevel>
<impactEvidence>
<impactEvidence id="evidence01"><!--corresponds to classification /dk/atira/pure/impact/evidenceindicator -->
<evidenceIndicator>qualitative</evidenceIndicator>
<evidenceTitle>Evidence Title</evidenceTitle>
<evidenceTitlesTranslated>
<title lang="de">Title in other language</title>
</evidenceTitlesTranslated>
<summary>Summary in primary language</summary>
<translatedSummaries>
<summary lang="de">Summary of evidence in other language</summary>
</translatedSummaries>
<startDate>
<cmns:year>2010</cmns:year>
</startDate>
<endDate>
<cmns:year>2018</cmns:year>
</endDate>
<evidenceContactInformation>
<evidenceContactInformation id="contact1">
<contactName>John Doe</contactName>
<contactDetails>Email: John.Doe@evidence.net</contactDetails>
<corroborateText>Optional corroborate text</corroborateText>
<consentObtained>true</consentObtained>
</evidenceContactInformation>
</evidenceContactInformation>
<links>
<cmns:link id="link01">
<cmns:url>https://www.elsevier.com</cmns:url>
<cmns:description>
<cmns:text lang="en">the evidence link description</cmns:text>
<cmns:text lang="de">das beschreibung</cmns:text>
</cmns:description>
<cmns:type>evidence</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc1">
<title>Evidence Doc Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Tycho_crater_on_the_Moon.jpg/256px-Tycho_crater_on_the_Moon.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>
</impactEvidence>
</impactEvidence>
<persons><!-- If a person is internal no origin needs to be set -->
<associatedPerson id="personAssociation1"><!-- lookupHint is key from /dk/atira/pure/person/personsources, use this to prefer Scopus author ID when looking for a match -->
<person lookupId="person1" lookupHint="scopusauthor"/>
<organisations><!-- lookupHint is key from /dk/atira/pure/organisation/organisationsources, use this to prefer Organisation ID when looking for a match -->
<organisation lookupId="organisation1" lookupHint="organisationid"/>
</organisations>
<!--corresponds to classification /dk/atira/pure/impact/roles/impact -->
<personRole>participant</personRole>
</associatedPerson>
<associatedPerson id="personAssociation2"><!-- lookupHint synchronisedUnifiedPerson, use this to prefer external id of a person from the Person synchronisation when looking for a match -->
<person lookupId="supervisor1" lookupHint="synchronisedUnifiedPerson"/>
<organisations><!-- lookupHint synchronisedUnifiedOrganisation, use this to prefer external id of an organisation from the Organisation synchronisation when looking for a match -->
<organisation lookupId="organisation3" lookupHint="synchronisedUnifiedOrganisation"/>
</organisations>
<!--corresponds to classification /dk/atira/pure/impact/roles/impact -->
<personRole>participant</personRole>
</associatedPerson>
<associatedPerson id="personAssociation3"><!-- 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>US</country>
</person>
<personRole>participant</personRole>
<organisations>
<organisation lookupId="extOrganisation" origin="external">
<name>External Organisation - One</name>
<type>unknown</type>
</organisation>
</organisations>
</associatedPerson>
</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>unknown</type>
</organisation>
<organisation lookupId="organisation2"/>
</organisations>
<links>
<cmns:link id="link02">
<cmns:url>https://www.elsevier.com</cmns:url>
<cmns:description>
<cmns:text lang="en">the description</cmns:text>
</cmns:description>
<cmns:type>unspecified</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc2">
<title>Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/Barringer_Crater_aerial_photo_by_USGS.jpg/274px-Barringer_Crater_aerial_photo_by_USGS.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>
<managedBy lookupId="organisation1"/>
<keywords><!-- Keyword group on impact with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on impact with logical name /dk/atira/pure/sustainabledevelopmentgoals that is related to classification scheme /dk/atira/pure/sustainabledevelopmentgoals must exist -->
<keyword logicalName="/dk/atira/pure/sustainabledevelopmentgoals"
key="affordable_and_clean_energy"/>
</keywords>
<visibility>Campus</visibility>
<workflow>approved</workflow>
<ids>
<cmns:id type="external" id="id01">1</cmns:id>
<cmns:id type="external">value_as_id</cmns:id>
</ids>
</impact>
</impacts>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="impacts">
<xs:annotation>
<xs:documentation>The root element of the document</xs:documentation>
</xs:annotation>
<xs:complexType>
<xs:sequence>
<xs:element ref="impact" 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>impact
For each impact record to be created in Pure there should be a new entry of this element
XML Example
<impact xmlns="v1.impact.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="impact1"
type="impact"
managedInPure="false"><!--Required title-->
<title>Main title</title>
<!--Optional list of -->
<translatedTitles>
<title lang="de">Title in other language</title>
</translatedTitles>
<description>Impact Description</description>
<additionalDescriptions>
<description type="impactdescription" lang="de">Impact Desecription - Deutsch</description>
<!--'additionaldescription' classification is not present in a standard Pure, only used as example on how to add an additional type -->
<description type="additionaldescription">Additional description</description>
</additionalDescriptions>
<startDate>
<cmns:year>2001</cmns:year>
<cmns:month>9</cmns:month>
<cmns:day>11</cmns:day>
</startDate>
<endDate>
<cmns:year>2021</cmns:year>
<cmns:month>12</cmns:month>
<cmns:day>24</cmns:day>
</endDate>
<!--corresponds to classification /dk/atira/pure/impact/impactstatus -->
<impactStatus>open</impactStatus>
<!--corresponds to classification /dk/atira/pure/impact/impactnature -->
<impactCategories>
<impactCategory>culturalimpacts</impactCategory>
<impactCategory>publicpolicyimpacts</impactCategory>
</impactCategories>
<!--corresponds to classification /dk/atira/pure/impact/impactlevel -->
<impactLevel>engagement</impactLevel>
<impactEvidence>
<impactEvidence id="evidence01"><!--corresponds to classification /dk/atira/pure/impact/evidenceindicator -->
<evidenceIndicator>qualitative</evidenceIndicator>
<evidenceTitle>Evidence Title</evidenceTitle>
<evidenceTitlesTranslated>
<title lang="de">Title in other language</title>
</evidenceTitlesTranslated>
<summary>Summary in primary language</summary>
<translatedSummaries>
<summary lang="de">Summary of evidence in other language</summary>
</translatedSummaries>
<startDate>
<cmns:year>2010</cmns:year>
</startDate>
<endDate>
<cmns:year>2018</cmns:year>
</endDate>
<evidenceContactInformation>
<evidenceContactInformation id="contact1">
<contactName>John Doe</contactName>
<contactDetails>Email: John.Doe@evidence.net</contactDetails>
<corroborateText>Optional corroborate text</corroborateText>
<consentObtained>true</consentObtained>
</evidenceContactInformation>
</evidenceContactInformation>
<links>
<cmns:link id="link01">
<cmns:url>https://www.elsevier.com</cmns:url>
<cmns:description>
<cmns:text lang="en">the evidence link description</cmns:text>
<cmns:text lang="de">das beschreibung</cmns:text>
</cmns:description>
<cmns:type>evidence</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc1">
<title>Evidence Doc Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Tycho_crater_on_the_Moon.jpg/256px-Tycho_crater_on_the_Moon.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>
</impactEvidence>
</impactEvidence>
<persons><!-- If a person is internal no origin needs to be set -->
<associatedPerson id="personAssociation1"><!-- lookupHint is key from /dk/atira/pure/person/personsources, use this to prefer Scopus author ID when looking for a match -->
<person lookupId="person1" lookupHint="scopusauthor"/>
<organisations><!-- lookupHint is key from /dk/atira/pure/organisation/organisationsources, use this to prefer Organisation ID when looking for a match -->
<organisation lookupId="organisation1" lookupHint="organisationid"/>
</organisations>
<!--corresponds to classification /dk/atira/pure/impact/roles/impact -->
<personRole>participant</personRole>
</associatedPerson>
<associatedPerson id="personAssociation2"><!-- lookupHint synchronisedUnifiedPerson, use this to prefer external id of a person from the Person synchronisation when looking for a match -->
<person lookupId="supervisor1" lookupHint="synchronisedUnifiedPerson"/>
<organisations><!-- lookupHint synchronisedUnifiedOrganisation, use this to prefer external id of an organisation from the Organisation synchronisation when looking for a match -->
<organisation lookupId="organisation3" lookupHint="synchronisedUnifiedOrganisation"/>
</organisations>
<!--corresponds to classification /dk/atira/pure/impact/roles/impact -->
<personRole>participant</personRole>
</associatedPerson>
<associatedPerson id="personAssociation3"><!-- 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>US</country>
</person>
<personRole>participant</personRole>
<organisations>
<organisation lookupId="extOrganisation" origin="external">
<name>External Organisation - One</name>
<type>unknown</type>
</organisation>
</organisations>
</associatedPerson>
</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>unknown</type>
</organisation>
<organisation lookupId="organisation2"/>
</organisations>
<links>
<cmns:link id="link02">
<cmns:url>https://www.elsevier.com</cmns:url>
<cmns:description>
<cmns:text lang="en">the description</cmns:text>
</cmns:description>
<cmns:type>unspecified</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc2">
<title>Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/0/0c/Barringer_Crater_aerial_photo_by_USGS.jpg/274px-Barringer_Crater_aerial_photo_by_USGS.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>
<managedBy lookupId="organisation1"/>
<keywords><!-- Keyword group on impact with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on impact with logical name /dk/atira/pure/sustainabledevelopmentgoals that is related to classification scheme /dk/atira/pure/sustainabledevelopmentgoals must exist -->
<keyword logicalName="/dk/atira/pure/sustainabledevelopmentgoals"
key="affordable_and_clean_energy"/>
</keywords>
<visibility>Campus</visibility>
<workflow>approved</workflow>
<ids>
<cmns:id type="external" id="id01">1</cmns:id>
<cmns:id type="external">value_as_id</cmns:id>
</ids>
</impact>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="impactType">
<xs:annotation>
<xs:documentation>For each impact record to be created in Pure there should be a new entry of this element</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="title" type="commons:string_256" minOccurs="1">
<xs:annotation>
<xs:documentation>The title of the impact</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedTitles" type="translatedTitles" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the impact. Use if the title is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="startDate" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>Start Date of the impact. This field will only show in editor if extended impact model is enabled.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="endDate" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>End Date of the impact. This field will only show in editor if extended impact model is enabled.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="description" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The description of the impact, this will add a description of the type /dk/atira/pure/impact/descriptions/impactdescription</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="additionalDescriptions" type="descriptions" minOccurs="0">
<xs:annotation>
<xs:documentation>Additional descriptions of the impact, use if description is different in another language, or if description is of another type than /dk/atira/pure/impact/descriptions/impactdescription</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="impactStatus" type="commons:classification">
<xs:annotation>
<xs:documentation>The status of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactstatus. Only use the last part of the uri (token). If the classification scheme only contains one classification the editor will not show this status.</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="impactCategories" type="impactCategories" minOccurs="0">
<xs:annotation>
<xs:documentation>The category of the impact. The type should be defined in the /dk/atira/pure/impact/impactnature classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="impactLevel" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
The level of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactlevel. Only use the last part of the uri (token)
This field will only show in editor if extended impact model is enabled.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="impactEvidence" type="impactEvidences" minOccurs="0">
<xs:annotation>
<xs:documentation>
Evidence of the impact.
This field will only show in editor if extended impact model is enabled.
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="persons" type="associatedPersons" minOccurs="0">
<xs:annotation>
<xs:documentation>The persons that the impact is associated with</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The organisations that are directly related to the impact, rather than related through a person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="managedBy" type="managedBy" minOccurs="0">
<xs:annotation>
<xs:documentation>The organisation by which the impact is managed, this must always be an internal organisation</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="keywords" type="keywords" minOccurs="0">
<xs:annotation>
<xs:documentation>Keywords of the impact</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>Links to related online information about the impact. Type of link should be defined in /dk/atira/pure/links/impact classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>The documents related to the impact. This document will be uploaded to Pure. Type of document should be defined in the /dk/atira/pure/core/document/types classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>The visibility of the impact. Should be one of Public, Campus, Restricted or Confidential</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 impact (workflow states: forApproval and approved (If enabled in the Pure backend))</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/impact/impactsources</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 impact, this must be an unique value</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="commons:classification" name="type" use="required">
<xs:annotation>
<xs:documentation>Classifications from the scheme: /dk/atira/pure/impact/impacttypes. Only use the last part of the uri (token)</xs:documentation>
</xs:annotation>
</xs:attribute>
<xs:attribute type="xs:boolean" name="managedInPure" use="optional">
<xs:annotation>
<xs:documentation>Determines whether the impact is managed in Pure, if set to to true the impact 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 impact, this must be an unique value |
Yes |
|
@type |
Classifications from the scheme: /dk/atira/pure/impact/impacttypes. Only use the last part of the uri (token) |
Yes |
|
@managedInPure |
Determines whether the impact is managed in Pure, if set to to true the impact will be fully editable and deletable in Pure |
xsd:boolean |
Yes |
title |
The title of the impact |
Yes |
|
translatedTitles |
Translated titles of the impact. Use if the title is different in another language |
No |
|
startDate |
Start Date of the impact. This field will only show in editor if extended impact model is enabled. |
No |
|
endDate |
End Date of the impact. This field will only show in editor if extended impact model is enabled. |
No |
|
description |
The description of the impact, this will add a description of the type /dk/atira/pure/impact/descriptions/impactdescription |
xsd:string |
No |
additionalDescriptions |
Additional descriptions of the impact, use if description is different in another language, or if description is of another type than /dk/atira/pure/impact/descriptions/impactdescription |
No |
|
impactStatus |
The status of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactstatus. Only use the last part of the uri (token). If the classification scheme only contains one classification the editor will not show this status. |
Yes |
|
impactCategories |
The category of the impact. The type should be defined in the /dk/atira/pure/impact/impactnature classification scheme |
No |
|
impactLevel |
The level of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactlevel. Only use the last part of the uri (token) This field will only show in editor if extended impact model is enabled. |
No |
|
impactEvidence |
Evidence of the impact. This field will only show in editor if extended impact model is enabled. |
No |
|
persons |
The persons that the impact is associated with |
No |
|
organisations |
The organisations that are directly related to the impact, rather than related through a person |
No |
|
managedBy |
The organisation by which the impact is managed, this must always be an internal organisation |
No |
|
keywords |
Keywords of the impact |
No |
|
links |
Links to related online information about the impact. Type of link should be defined in /dk/atira/pure/links/impact classification scheme |
No |
|
documents |
The documents related to the impact. This document will be uploaded to Pure. Type of document should be defined in the /dk/atira/pure/core/document/types classification scheme |
No |
|
visibility |
The visibility of the impact. Should be one of Public, Campus, Restricted or Confidential |
No |
|
workflow |
Used to set the workflow state of the impact (workflow states: forApproval and approved (If enabled in the Pure backend)) |
xsd:string |
No |
ids |
Type attribute must be a token from the classification scheme /dk/atira/pure/impact/impactsources |
No |
Translations
translatedTitles
A list of title elements of type commons:localized_text_256_lang
XML Example
<translatedTitles xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<title lang="de">Title in other language</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_256_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated title of the impact. Can be specified in multiple 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 impact. Can be specified in multiple languages, if your Pure is multilingual |
Yes |
translatedSummaries
A list of summary elements of type commons:localized_text_lang
XML Example
<translatedSummaries xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<summary lang="de">Summary of evidence in other language</summary>
</translatedSummaries>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="translatedSummaries">
<xs:sequence>
<xs:element name="summary"
type="commons:localized_text_lang"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>Translated summary of the impact evidence. Can be specified in multiple languages, if your Pure is multilingual</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
summary |
Translated summary of the impact evidence. Can be specified in multiple languages, if your Pure is multilingual |
Yes |
Categories
impactCategories
A list of impactCategory elements of type commons:classification
XML Example
<impactCategories xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<impactCategory>culturalimpacts</impactCategory>
<impactCategory>publicpolicyimpacts</impactCategory>
</impactCategories>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="impactCategories">
<xs:sequence>
<xs:element name="impactCategory"
type="commons:classification"
minOccurs="0"
maxOccurs="unbounded">
<xs:annotation>
<xs:documentation>The category of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactnature. Only use the last part of the uri (token)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
impactCategory |
The category of the impact. Classifications from the scheme: /dk/atira/pure/impact/impactnature. Only use the last part of the uri (token) |
No |
Persons
associatedPersons
A list of associatedPerson elements of type associatedPerson
XML Example
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="associatedPersons">
<xs:sequence>
<xs:element ref="associatedPerson" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>associatedPerson
XML Example
<associatedPerson xmlns="v1.impact.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="personAssociation1"><!-- lookupHint is key from /dk/atira/pure/person/personsources, use this to prefer Scopus author ID when looking for a match -->
<person lookupId="person1" lookupHint="scopusauthor"/>
<organisations><!-- lookupHint is key from /dk/atira/pure/organisation/organisationsources, use this to prefer Organisation ID when looking for a match -->
<organisation lookupId="organisation1" lookupHint="organisationid"/>
</organisations>
<!--corresponds to classification /dk/atira/pure/impact/roles/impact -->
<personRole>participant</personRole>
</associatedPerson>XSD Definition
<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="associatedPerson">
<xs:complexType>
<xs:all>
<xs:element name="person" type="person" minOccurs="0">
<xs:annotation>
<xs:documentation>Can be an internal or external person</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="organisations" type="organisations" minOccurs="0">
<xs:annotation>
<xs:documentation>The internal/external organisations the person is affiliated with on this impact</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="personRole" type="commons:classification" minOccurs="1">
<xs:annotation>
<xs:documentation>The role of the person on the impact. Must be a valid classification from the /dk/atira/pure/impact/roles/impact classification scheme</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:attribute type="commons:string_1024" name="id">
<xs:annotation>
<xs:documentation>The ID of this associated person relation</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>
</xs:element>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
The ID of this associated person relation |
Yes |
|
person |
Can be an internal or external person |
No |
|
organisations |
The internal/external organisations the person is affiliated with on this impact |
No |
|
personRole |
The role of the person on the impact. Must be a valid classification from the /dk/atira/pure/impact/roles/impact classification scheme |
Yes |
|
country |
Token from the classification scheme /dk/atira/pure/core/countries |
No |
person
Can be an internal or 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, then matching 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.impact.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="person1"
lookupHint="scopusauthor"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="person">
<xs:annotation>
<xs:documentation>
Can be an internal or 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, then matching 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:annotation>
<xs:documentation>The id used to lookup the person. Origin can be used to indicate if they are an internal or external person</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The id used to lookup the person. Origin can be used to indicate if they are an internal or external person |
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.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- lookupHint is key from /dk/atira/pure/organisation/organisationsources, use this to prefer Organisation ID when looking for a match -->
<organisation lookupId="organisation1" lookupHint="organisationid"/>
</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 either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
XML Example
<organisation xmlns="v1.impact.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
lookupId="organisation1"
lookupHint="organisationid"/>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="organisation">
<xs:annotation>
<xs:documentation>
Can be either an internal or an external organisation, indicated with the 'origin' attribute.
If the organisation is an internal organisation in Pure, only the lookupId attribute is used.
If the organisation is an external organisation and ID is given, matching will be done on the ID. If no match is found, matching will be done on name. If still no match is found, an external organisation will be created, using the available data. (TODO is this true)
</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 to unknonwn, if nothing is written)</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attributeGroup ref="commons:originId">
<xs:annotation>
<xs:documentation>The id used to lookup the organisation. Origin can be used to indicate if they are an internal or external person</xs:documentation>
</xs:annotation>
</xs:attributeGroup>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:originId |
The id used to lookup the organisation. Origin can be used to indicate if they are an internal or external person |
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 to unknonwn, if nothing is written) |
No |
managedBy
XML Example
<managedBy xmlns="v1.impact.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="managedBy">
<xs:attributeGroup ref="commons:lookupId"/>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@commons:lookupId |
|
Yes |
Evidence
impactEvidences
A list of impactEvidence elements of type impactEvidence
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="impactEvidences">
<xs:sequence>
<xs:element name="impactEvidence" type="impactEvidence" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>impactEvidence
Evidence of the impact
XML Example
<impactEvidence xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<impactEvidence id="evidence01"><!--corresponds to classification /dk/atira/pure/impact/evidenceindicator -->
<evidenceIndicator>qualitative</evidenceIndicator>
<evidenceTitle>Evidence Title</evidenceTitle>
<evidenceTitlesTranslated>
<title lang="de">Title in other language</title>
</evidenceTitlesTranslated>
<summary>Summary in primary language</summary>
<translatedSummaries>
<summary lang="de">Summary of evidence in other language</summary>
</translatedSummaries>
<startDate>
<cmns:year>2010</cmns:year>
</startDate>
<endDate>
<cmns:year>2018</cmns:year>
</endDate>
<evidenceContactInformation>
<evidenceContactInformation id="contact1">
<contactName>John Doe</contactName>
<contactDetails>Email: John.Doe@evidence.net</contactDetails>
<corroborateText>Optional corroborate text</corroborateText>
<consentObtained>true</consentObtained>
</evidenceContactInformation>
</evidenceContactInformation>
<links>
<cmns:link id="link01">
<cmns:url>https://www.elsevier.com</cmns:url>
<cmns:description>
<cmns:text lang="en">the evidence link description</cmns:text>
<cmns:text lang="de">das beschreibung</cmns:text>
</cmns:description>
<cmns:type>evidence</cmns:type>
</cmns:link>
</links>
<documents>
<document id="doc1">
<title>Evidence Doc Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Tycho_crater_on_the_Moon.jpg/256px-Tycho_crater_on_the_Moon.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>
</impactEvidence>
</impactEvidence>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="impactEvidence">
<xs:annotation>
<xs:documentation>Evidence of the impact</xs:documentation>
</xs:annotation>
<xs:all>
<xs:element name="startDate" type="commons:compoundDate" minOccurs="1">
<xs:annotation>
<xs:documentation>Start date that the evidence relates to. Can be just a year or year and month</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="endDate" type="commons:compoundDate" minOccurs="0">
<xs:annotation>
<xs:documentation>End date of the evidence period. Can be omitted to indicate the time period is still ongoing</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="evidenceIndicator"
type="commons:classification"
minOccurs="0">
<xs:annotation>
<xs:documentation>The evidence indicator for the evidence. Classifications from the scheme: /dk/atira/pure/impact/evidenceindicator. Only use the last part of the uri (token)</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="evidenceTitle" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>Title of the evidence</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="evidenceTitlesTranslated"
type="translatedTitles"
minOccurs="0">
<xs:annotation>
<xs:documentation>Translated titles of the evidence</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="summary" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>The summary of the evidence</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="translatedSummaries" type="translatedSummaries" minOccurs="0">
<xs:annotation>
<xs:documentation>Translated summaries of the impact evidence. Use if the summary is different in another language</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="evidenceContactInformation"
type="evidenceContactInformations"
minOccurs="0">
<xs:annotation>
<xs:documentation>Contact information regarding the evidence</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="links" type="commons:links" minOccurs="0">
<xs:annotation>
<xs:documentation>Links to related online information about the evidence. Link type should be defined in the /dk/atira/pure/links/impact classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="documents" type="documents" minOccurs="0">
<xs:annotation>
<xs:documentation>The documents related to the evidence. This document will be uploaded to Pure. Type of document should be defined in the /dk/atira/pure/core/document/types classification scheme</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>Unique ID(across a single impact) for the evidence</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
Unique ID(across a single impact) for the evidence |
Yes |
|
startDate |
Start date that the evidence relates to. Can be just a year or year and month |
Yes |
|
endDate |
End date of the evidence period. Can be omitted to indicate the time period is still ongoing |
No |
|
evidenceIndicator |
The evidence indicator for the evidence. Classifications from the scheme: /dk/atira/pure/impact/evidenceindicator. Only use the last part of the uri (token) |
No |
|
evidenceTitle |
Title of the evidence |
No |
|
evidenceTitlesTranslated |
Translated titles of the evidence |
No |
|
summary |
The summary of the evidence |
xsd:string |
No |
translatedSummaries |
Translated summaries of the impact evidence. Use if the summary is different in another language |
No |
|
evidenceContactInformation |
Contact information regarding the evidence |
No |
|
links |
Links to related online information about the evidence. Link type should be defined in the /dk/atira/pure/links/impact classification scheme |
No |
|
documents |
The documents related to the evidence. This document will be uploaded to Pure. Type of document should be defined in the /dk/atira/pure/core/document/types classification scheme |
No |
evidenceContactInformations
A list of evidenceContactInformation elements of type evidenceContactInformation
XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
name="evidenceContactInformations">
<xs:sequence>
<xs:element name="evidenceContactInformation"
type="evidenceContactInformation"
maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>evidenceContactInformation
XML Example
<evidenceContactInformation xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<evidenceContactInformation id="contact1">
<contactName>John Doe</contactName>
<contactDetails>Email: John.Doe@evidence.net</contactDetails>
<corroborateText>Optional corroborate text</corroborateText>
<consentObtained>true</consentObtained>
</evidenceContactInformation>
</evidenceContactInformation>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema"
name="evidenceContactInformation">
<xs:all>
<xs:element name="contactName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>Name of the contact</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="contactDetails" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Contact details</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="corroborateText" type="xs:string" minOccurs="0">
<xs:annotation>
<xs:documentation>Free text details of the way the person corrobated the impact</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="consentObtained" type="xs:boolean" minOccurs="0">
<xs:annotation>
<xs:documentation>Whether consent has been given for future contact with this person</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_400" name="id" use="required">
<xs:annotation>
<xs:documentation>ID of this contact relation. Used for syncing purposes</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of this contact relation. Used for syncing purposes |
Yes |
|
contactName |
Name of the contact |
No |
|
contactDetails |
Contact details |
xsd:string |
No |
corroborateText |
Free text details of the way the person corrobated the impact |
xsd:string |
No |
consentObtained |
Whether consent has been given for future contact with this person |
xsd:boolean |
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
XML Example
<description xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">Impact Description</description>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="description">
<xs:simpleContent>
<xs:extension base="commons:localized_text_lang">
<xs:attribute name="type" type="commons:classification" use="required">
<xs:annotation>
<xs:documentation>token from the classification scheme /dk/atira/pure/impact/descriptions</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:extension>
</xs:simpleContent>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@type |
token from the classification scheme /dk/atira/pure/impact/descriptions |
Yes |
Keywords
keywords
A list of keyword elements of type commons:keyword
XML Example
<keywords xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!-- Keyword group on impact with logical name keywordContainers must exist -->
<keyword>Java</keyword>
<keyword lang="en">Programming</keyword>
<keyword lang="de">Programmierung</keyword>
<!-- Keyword group on impact with logical name /dk/atira/pure/sustainabledevelopmentgoals that is related to classification scheme /dk/atira/pure/sustainabledevelopmentgoals must exist -->
<keyword logicalName="/dk/atira/pure/sustainabledevelopmentgoals"
key="affordable_and_clean_energy"/>
</keywords>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="keywords">
<xs:sequence>
<xs:element name="keyword" type="commons:keyword" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
keyword |
|
Yes |
Documents
documents
A list of document elements of type document
XML Example
<documents xmlns="v1.impact.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
<document id="doc1">
<title>Evidence Doc Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Tycho_crater_on_the_Moon.jpg/256px-Tycho_crater_on_the_Moon.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>
</documents>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="documents">
<xs:sequence>
<xs:element name="document" type="document" maxOccurs="unbounded"/>
</xs:sequence>
</xs:complexType>document
XML Example
<document xmlns="v1.impact.pure.atira.dk"
xmlns:cmns="v3.commons.pure.atira.dk"
id="doc1">
<title>Evidence Doc Title Test</title>
<fileLocation>https://upload.wikimedia.org/wikipedia/commons/thumb/f/f8/Tycho_crater_on_the_Moon.jpg/256px-Tycho_crater_on_the_Moon.jpg</fileLocation>
<fileName>impact-documents.jpeg</fileName>
<mimeType>image/jpeg</mimeType>
<license>cc_by</license>
<visibility>Restricted</visibility>
<type>text</type>
</document>XSD Definition
<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="document">
<xs:all>
<xs:element name="type"
type="commons:classification"
minOccurs="0"
default="other">
<xs:annotation>
<xs:documentation>A token from classification scheme /dk/atira/pure/core/document/types</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>
The mime type of file
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="fileName" type="commons:string_256" minOccurs="0">
<xs:annotation>
<xs:documentation>
The name of the file. This will be derived from the file if not specified
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="title" type="commons:string_1024" minOccurs="0">
<xs:annotation>
<xs:documentation>
The title of the file
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="license" type="commons:classification" minOccurs="0">
<xs:annotation>
<xs:documentation>
Token from the classification scheme /dk/atira/pure/core/document/licenses
</xs:documentation>
</xs:annotation>
</xs:element>
<xs:element name="visibility" type="commons:visibility" minOccurs="0">
<xs:annotation>
<xs:documentation>
Visibility cannot be set on application documents.
</xs:documentation>
</xs:annotation>
</xs:element>
</xs:all>
<xs:attribute type="commons:string_1024" name="id" use="required">
<xs:annotation>
<xs:documentation>ID of the document. Used for synchronisation purposes</xs:documentation>
</xs:annotation>
</xs:attribute>
</xs:complexType>XML Attribute/Element |
Description |
Type |
Mandatory |
|---|---|---|---|
@id |
ID of the document. Used for synchronisation purposes |
Yes |
|
type |
A token from classification scheme /dk/atira/pure/core/document/types |
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 |
The mime type of file |
No |
|
fileName |
The name of the file. This will be derived from the file if not specified |
No |
|
title |
The title of the file |
No |
|
license |
Token from the classification scheme /dk/atira/pure/core/document/licenses |
No |
|
visibility |
Visibility cannot be set on application documents. |
No |
Published at December 26, 2023