How Can We Help?

Journal XMLJournal XML

Overview

This page details the Journal content type. On this page you will find different representations of the data elements contained within this type.

Below is the xsd for the Journal 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 Journal 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.

The journal content type represents a journal produced by a publisher. This can be related to research outputs that are published in journals or to activites where a researcher has been an editor or peer reviewer for the journal.

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

Journals

journals

A list of journal elements of type journal

XML Example

<journals xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk"><!--1 or more repetitions:-->
           <journal id="journal1" type="journal"><!-- Title(s) of the journal -->
              <titles>
                 <title startDate="10-05-2015" endDate="10-05-2016">Journal Title</title>
                 <title>Journal Title 2</title>
              </titles>
              <additionalTitles>
                 <title>Journal Additional Title</title>
              </additionalTitles>
              <issns>
                 <issn startDate="02-06-2014" endDate="03-07-2015">6666-6666</issn>
              </issns>
              <additionalISSNs>
                 <issn>6666-6666</issn>
              </additionalISSNs>
              <additionalElectronicISSNs>
                 <issn>9666-6666</issn>
              </additionalElectronicISSNs>
              <publisher lookupId="publisher1">
                 <name>Publisher 1</name>
              </publisher>
              <ids>
                 <cmns:id type="scopusid">scopusID</cmns:id>
              </ids>
              <keywords>
                 <keyword logicalName="ASJCSubjectAreas" key="1200/1201">test</keyword>
              </keywords>
              <country>dk</country>
           </journal>
        </journals>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="journals">
           <xs:complexType>
              <xs:sequence>
                 <xs:element ref="journal" 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>

journal

For every journal to be created in Pure there should be an instance of this element

XML Example

<journal xmlns="v1.journal.pure.atira.dk"
                 xmlns:cmns="v3.commons.pure.atira.dk"
                 id="journal1"
                 type="journal"><!-- Title(s) of the journal -->
           <titles>
              <title startDate="10-05-2015" endDate="10-05-2016">Journal Title</title>
              <title>Journal Title 2</title>
           </titles>
           <additionalTitles>
              <title>Journal Additional Title</title>
           </additionalTitles>
           <issns>
              <issn startDate="02-06-2014" endDate="03-07-2015">6666-6666</issn>
           </issns>
           <additionalISSNs>
              <issn>6666-6666</issn>
           </additionalISSNs>
           <additionalElectronicISSNs>
              <issn>9666-6666</issn>
           </additionalElectronicISSNs>
           <publisher lookupId="publisher1">
              <name>Publisher 1</name>
           </publisher>
           <ids>
              <cmns:id type="scopusid">scopusID</cmns:id>
           </ids>
           <keywords>
              <keyword logicalName="ASJCSubjectAreas" key="1200/1201">test</keyword>
           </keywords>
           <country>dk</country>
        </journal>

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="journalType">
           <xs:annotation>
              <xs:documentation>For every journal to be created in Pure there should be an instance of this element</xs:documentation>
           </xs:annotation>
           <xs:all>
              <xs:element name="titles" type="temporalTitles" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Titles of the journal. Can include details of when the title applied in the case of name changes.</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="additionalTitles" type="additionalTitles" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Additional searchable titles</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="issns" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>ISSNs attached to the journal</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="additionalISSNs" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Additional searchable ISSNs</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="additionalElectronicISSNs" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Additional searchable ISSNs (Electronic)</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="publisher" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The publisher of the journal</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="ids" type="commons:ids" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Used to set additional ids on the journal, e.g. scopusid</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="country" type="commons:classification" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>The country of origin for the journal. Should be a two letter country code as defined in the Countries classification scheme</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element ref="commons:metrics" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Metrics related to the journal</xs:documentation>
                 </xs:annotation>
              </xs:element>
              <xs:element name="keywords" type="keywords" minOccurs="0">
                 <xs:annotation>
                    <xs:documentation>Keywords of the Journal</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 journal (workflow states: forApproval and approved (If enabled in the Pure backend))
                            </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 journal, 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/journal/journaltypes. 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 journal is managed in Pure, if set to to true the journal 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 journal, this must be an unique value	commons:string_400	Yes
@type	Classifications from the scheme: /dk/atira/pure/journal/journaltypes. Only use the last part of the uri (token)	commons:classification	Yes
@managedInPure	Determines whether the journal is managed in Pure, if set to to true the journal will be fully editable and deletable in Pure	xsd:boolean	Yes
titles	Titles of the journal. Can include details of when the title applied in the case of name changes.	temporalTitles	No
additionalTitles	Additional searchable titles	additionalTitles	No
issns	ISSNs attached to the journal	issns	No
additionalISSNs	Additional searchable ISSNs	additionalISSNs	No
additionalElectronicISSNs	Additional searchable ISSNs (Electronic)	additionalElectronicISSNs	No
publisher	The publisher of the journal	publisher	No
ids	Used to set additional ids on the journal, e.g. scopusid	commons:ids	No
country	The country of origin for the journal. Should be a two letter country code as defined in the Countries classification scheme	commons:classification	No
commons:metrics	Metrics related to the journal	commons:metrics	No
keywords	Keywords of the Journal	keywords	No
workflow	Used to set the workflow state of the journal (workflow states: forApproval and approved (If enabled in the Pure backend))	xsd:string	No

Titles

temporalTitles

A list of title elements of type temporalTitle

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="temporalTitles">
           <xs:sequence>
              <xs:element name="title"
                          type="temporalTitle"
                          minOccurs="1"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>

temporalTitle

Title of the journal and the dates that it was applicable for

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="temporalTitle">
           <xs:annotation>
              <xs:documentation>Title of the journal and the dates that it was applicable for</xs:documentation>
           </xs:annotation>
           <xs:simpleContent>
              <xs:extension base="commons:string_512">
                 <xs:attribute name="startDate" type="commons:date">
                    <xs:annotation>
                       <xs:documentation>Optional start date for when the title applies</xs:documentation>
                    </xs:annotation>
                 </xs:attribute>
                 <xs:attribute name="endDate" type="commons:date">
                    <xs:annotation>
                       <xs:documentation>Optional end date for when the title no longer applied</xs:documentation>
                    </xs:annotation>
                 </xs:attribute>
                 <xs:attributeGroup ref="commons:id"/>
              </xs:extension>
           </xs:simpleContent>
        </xs:complexType>

XML Attribute/Element	Description	Type	Mandatory
@startDate	Optional start date for when the title applies	commons:date	Yes
@endDate	Optional end date for when the title no longer applied	commons:date	Yes
commons:id		commons:id	Yes

additionalTitles

A list of title elements of type commons:string_1024
Additional titles that might not be the main official titles, but are useful for searchability

XML Example

<additionalTitles xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
           <title>Journal Additional Title</title>
        </additionalTitles>

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="additionalTitles">
           <xs:annotation>
              <xs:documentation>Additional titles that might not be the main official titles, but are useful for searchability</xs:documentation>
           </xs:annotation>
           <xs:sequence>
              <xs:element name="title"
                          type="commons:string_1024"
                          minOccurs="1"
                          maxOccurs="unbounded"/>
           </xs:sequence>
        </xs:complexType>

XML Attribute/Element	Description	Type	Mandatory
title		commons:string_1024	Yes

ISSNs

issns

XML Example

<issns xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
           <issn startDate="02-06-2014" endDate="03-07-2015">6666-6666</issn>
        </issns>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="issns">
           <xs:complexType>
              <xs:sequence maxOccurs="unbounded" minOccurs="1">
                 <xs:element name="issn" type="string_9_with_date"/>
              </xs:sequence>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
issn		string_9_with_date	Yes

string_9_with_date

Should be a string in the format 1234-123X. Optionally start and end date for the use of this issn can be added

XSD Definition

<xs:complexType xmlns:xs="http://www.w3.org/2001/XMLSchema" name="string_9_with_date">
           <xs:annotation>
              <xs:documentation>
                        Should be a string in the format 1234-123X. Optionally start and end date for the use of this issn can be added
                    </xs:documentation>
           </xs:annotation>
           <xs:simpleContent>
              <xs:extension base="commons:string_9">
                 <xs:attribute type="commons:date" name="startDate">
                    <xs:annotation>
                       <xs:documentation>Optional start date for when the issn was used</xs:documentation>
                    </xs:annotation>
                 </xs:attribute>
                 <xs:attribute type="commons:date" name="endDate">
                    <xs:annotation>
                       <xs:documentation>Optional end date for when the issn was used</xs:documentation>
                    </xs:annotation>
                 </xs:attribute>
                 <xs:attributeGroup ref="commons:id"/>
              </xs:extension>
           </xs:simpleContent>
        </xs:complexType>

XML Attribute/Element	Description	Type	Mandatory
@startDate	Optional start date for when the issn was used	commons:date	Yes
@endDate	Optional end date for when the issn was used	commons:date	Yes
commons:id		commons:id	Yes

additionalElectronicISSNs

Can include other electronic issns to improve searchability

XML Example

<additionalElectronicISSNs xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
           <issn>9666-6666</issn>
        </additionalElectronicISSNs>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema"
                    name="additionalElectronicISSNs">
           <xs:annotation>
              <xs:documentation>Can include other electronic issns to improve searchability</xs:documentation>
           </xs:annotation>
           <xs:complexType>
              <xs:sequence maxOccurs="unbounded" minOccurs="1">
                 <xs:element name="issn" type="commons:string_256">
                    <xs:annotation>
                       <xs:documentation>Should be a string in the format 1234-123X</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:sequence>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
issn	Should be a string in the format 1234-123X	commons:string_256	Yes

additionalISSNs

Can include other print issns to improve searchability

XML Example

<additionalISSNs xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
           <issn>6666-6666</issn>
        </additionalISSNs>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="additionalISSNs">
           <xs:annotation>
              <xs:documentation>Can include other print issns to improve searchability</xs:documentation>
           </xs:annotation>
           <xs:complexType>
              <xs:sequence maxOccurs="unbounded" minOccurs="1">
                 <xs:element name="issn" type="commons:string_256">
                    <xs:annotation>
                       <xs:documentation>Should be a string in the format 1234-123X</xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:sequence>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
issn	Should be a string in the format 1234-123X	commons:string_256	Yes

Publisher

publisher

The publisher of the journal. If ID is not provided then Pure will attempt to match to existing
publishers with the same name. If none are found a new record will be created

XML Example

<publisher xmlns="v1.journal.pure.atira.dk"
                   xmlns:cmns="v3.commons.pure.atira.dk"
                   lookupId="publisher1">
           <name>Publisher 1</name>
        </publisher>

XSD Definition

<xs:element xmlns:xs="http://www.w3.org/2001/XMLSchema" name="publisher">
           <xs:annotation>
              <xs:documentation>
                        The publisher of the journal. If ID is not provided then Pure will attempt to match to existing
                        publishers with the same name. If none are found a new record will be created
                    </xs:documentation>
           </xs:annotation>
           <xs:complexType>
              <xs:all>
                 <xs:element name="name" type="commons:string_1024" minOccurs="0">
                    <xs:annotation>
                       <xs:documentation>
                                    Name is a required field when creating a new publisher (if publisher id is not provided)
                                </xs:documentation>
                    </xs:annotation>
                 </xs:element>
              </xs:all>
              <xs:attributeGroup ref="commons:originId">
                 <xs:annotation>
                    <xs:documentation>Can search by Pure ID, Source ID or other IDs that may have been added to the publisher record</xs:documentation>
                 </xs:annotation>
              </xs:attributeGroup>
           </xs:complexType>
        </xs:element>

XML Attribute/Element	Description	Type	Mandatory
commons:originId	Can search by Pure ID, Source ID or other IDs that may have been added to the publisher record	commons:originId	Yes
name	Name is a required field when creating a new publisher (if publisher id is not provided)	commons:string_1024	No

Keywords

A list of keyword elements of type commons:keyword

XML Example

<keywords xmlns="v1.journal.pure.atira.dk" xmlns:cmns="v3.commons.pure.atira.dk">
           <keyword logicalName="ASJCSubjectAreas" key="1200/1201">test</keyword>
        </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:annotation>
                    <xs:documentation>
                                Free text and/or classified keywords. These should be defined under
                                Administrator -&gt; Keywords for the Journal content type first before loading
                            </xs:documentation>
                 </xs:annotation>
              </xs:element>
           </xs:sequence>
        </xs:complexType>

XML Attribute/Element	Description	Type	Mandatory
keyword	Free text and/or classified keywords. These should be defined under Administrator -> Keywords for the Journal content type first before loading	commons:keyword	Yes

Updated at July 27, 2024

How Can We Help?

Search Results

Filter By Category

Contact Us

Journal XMLJournal XML

Overview

Journals

journals

XML Example

XSD Definition

journal

XML Example

XSD Definition

Titles

temporalTitles

XSD Definition

temporalTitle

XSD Definition

additionalTitles

XML Example

XSD Definition

ISSNs

issns

XML Example

XSD Definition

string_9_with_date

XSD Definition

additionalElectronicISSNs

XML Example

XSD Definition

additionalISSNs

XML Example

XSD Definition

Publisher

publisher

XML Example

XSD Definition

Keywords

XML Example

XSD Definition