CrossRef Help Site

CrossRef Help
copyright CrossRef. All rights reserved.

http://help.crossref.org/
The information contained in this document is subject to change without notice.
This document contains proprietary information which is protected by copyright.
All rights are reserved. No part of this document may be photocopied, reproduced,
or translated to another language without the prior written consent of CrossRef.
Table of Contents
Help Center ..................................................................................................................................................................................... 1
About CrossRef DOIs .................................................................................................................................................................... 1
What is a DOI .......................................................................................................................................................................... 1
How do CrossRef DOIs work? .................................................................................................................................................. 2
Who uses CrossRef DOIs ......................................................................................................................................................... 3
Examples of DOI use ............................................................................................................................................................... 4
Getting Started ............................................................................................................................................................................. 5
How CrossRef works ............................................................................................................................................................... 5
Getting Started with CrossRef ................................................................................................................................................ 6
CrossRef publishers and titles ................................................................................................................................................ 7
Publishers ............................................................................................................................................................................... 8
Becoming a member ......................................................................................................................................................... 8
Obtaining a DOI prefix ....................................................................................................................................................... 9
Creating a DOI suffix pattern .......................................................................................................................................... 10
Creating response pages ................................................................................................................................................. 11
How depositing works ..................................................................................................................................................... 12
How querying works ........................................................................................................................................................ 13
Outbound linking ............................................................................................................................................................. 14
Libraries ................................................................................................................................................................................ 15
Opening a library account ............................................................................................................................................... 15
DOIs, OpenURL, and link resolvers .................................................................................................................................. 16
Setting up your system for localized linking .................................................................................................................... 17
CrossRef Affiliates ................................................................................................................................................................. 18
Depositing DOIs and metadata .................................................................................................................................................. 19
Deposit basics ...................................................................................................................................................................... 19
Deposit content types ........................................................................................................................................................... 20
Resource-only deposits ......................................................................................................................................................... 21
Journal title-level DOIs .......................................................................................................................................................... 22
Depositing and distributing references ................................................................................................................................. 23
Deposit fees .......................................................................................................................................................................... 24
Troubleshooting Deposits ..................................................................................................................................................... 25
Verifying your XML .......................................................................................................................................................... 25
ISSN errors ...................................................................................................................................................................... 26
Interpreting submission logs ........................................................................................................................................... 27
Errors and warning messages ......................................................................................................................................... 28
Multiple Resolution ............................................................................................................................................................... 31
Overview ......................................................................................................................................................................... 31
Steps for implementation ................................................................................................................................................ 32
1. Permissions ................................................................................................................................................................. 33
2. Interim page template ................................................................................................................................................ 34
3. Enable DOIs ................................................................................................................................................................. 35
Role of the DOI proxy ...................................................................................................................................................... 36
Reversing multiple resolution .......................................................................................................................................... 37
Depositing secondary URLs ............................................................................................................................................. 38
Using special characters ....................................................................................................................................................... 39
Depositing translations ......................................................................................................................................................... 40
Components ......................................................................................................................................................................... 41
Best practices for depositing ................................................................................................................................................ 42
NLM/JATS to CrossRef conversion ......................................................................................................................................... 43
Ancillary metadata ................................................................................................................................................................ 44

Including JATS abstracts in deposits ................................................................................................................................ 44
Including non-CrossRef DOIs in deposits ......................................................................................................................... 45
Access Indicators ............................................................................................................................................................ 46
As-crawled URLs .............................................................................................................................................................. 47
Queries & retrieving metadata ................................................................................................................................................... 48
How to query ........................................................................................................................................................................ 48
Controlling query execution .................................................................................................................................................. 49
Controlling query execution ............................................................................................................................................ 49
Allowing multiple hits ...................................................................................................................................................... 51
Secondary query ............................................................................................................................................................. 52
DOI-to-metadata query ......................................................................................................................................................... 54
Author / article title query ..................................................................................................................................................... 55
Querying with formatted citations ........................................................................................................................................ 56
Querying with special characters .......................................................................................................................................... 57
Querying for books ............................................................................................................................................................... 58
Query samples ...................................................................................................................................................................... 59
Best practices for querying ................................................................................................................................................... 60
Query results ........................................................................................................................................................................ 61
Query results ................................................................................................................................................................... 61
UNIXSD ............................................................................................................................................................................ 62
UNIXREF .......................................................................................................................................................................... 63
Query error messages ..................................................................................................................................................... 64
Storing queries to get future results ..................................................................................................................................... 65
Deprecated query formats .................................................................................................................................................... 66
Retrieving DOI info-metadata ............................................................................................................................................... 71
Bulk metadata formats ......................................................................................................................................................... 72
Retrieving DOIs by title ......................................................................................................................................................... 73
Publication IDs ...................................................................................................................................................................... 74
Maintaining & working with DOIs ............................................................................................................................................... 75
Building URLs with DOIs ........................................................................................................................................................ 75
Updating URLs ...................................................................................................................................................................... 76
Updating DOIs and metadata ............................................................................................................................................... 77
Platform transfer ................................................................................................................................................................... 78
Transferring DOI ownership .................................................................................................................................................. 79
Updating title information ..................................................................................................................................................... 80
Best practices for journal titles ............................................................................................................................................. 81
Best Practices for maintaining DOIs ...................................................................................................................................... 82
Resolving conflicts ................................................................................................................................................................ 83
What are conflicts? .......................................................................................................................................................... 83
Resolving conflicts .......................................................................................................................................................... 84
Sample conflict scenarios ................................................................................................................................................ 85
Viewing conflicts using the web interface ....................................................................................................................... 86
Assigning primary and alias status .................................................................................................................................. 88
Accepting a conflict as is ................................................................................................................................................. 91
Updating metadata to resolve conflicts ........................................................................................................................... 94
Forcing prime/alias .......................................................................................................................................................... 95
Sample conflict resolution files ....................................................................................................................................... 96
Reports ................................................................................................................................................................................. 97
Reports Overview ............................................................................................................................................................ 97
Depositor report .............................................................................................................................................................. 98
Missing Metadata / Field Report ...................................................................................................................................... 99

DOI Crawler ................................................................................................................................................................... 100
Conflict report ............................................................................................................................................................... 101
Browsable Title List ....................................................................................................................................................... 102
Go-Live report ............................................................................................................................................................... 103
Status report ................................................................................................................................................................. 104
XML Journal List (mddb.xml) ......................................................................................................................................... 105
Resolution report ........................................................................................................................................................... 106
Working with your Resolution report ............................................................................................................................. 107
MIssed Conflict report ................................................................................................................................................... 108
Quarterly deposit report ................................................................................................................................................ 109
DOI Error report ............................................................................................................................................................. 110
Schematron report ........................................................................................................................................................ 111
User Interfaces ......................................................................................................................................................................... 112
CrossRef user interfaces ..................................................................................................................................................... 112
System Interface ................................................................................................................................................................. 113
Accessing the CrossRef system ..................................................................................................................................... 113
Submissions Administration .......................................................................................................................................... 114
Tracking submissions .................................................................................................................................................... 115
Submission queue ......................................................................................................................................................... 116
Retrieving DOI history ................................................................................................................................................... 117
Web deposit form ............................................................................................................................................................... 118
Simple Text reference deposit ............................................................................................................................................ 119
Machine Interfaces / APIs ......................................................................................................................................................... 120
Using HTTP to POST files ..................................................................................................................................................... 120
Using HTTP to query ........................................................................................................................................................... 121
Retrieve submission results via HTTP ................................................................................................................................. 123
OpenURL query interface .................................................................................................................................................... 124
OAI-PMH query interface ..................................................................................................................................................... 127
Deposit Harvester ............................................................................................................................................................... 129
DOI Registration Agency tool .............................................................................................................................................. 131
Advanced topics ....................................................................................................................................................................... 132
Content negotiation ............................................................................................................................................................ 132
CrossRef Services ..................................................................................................................................................................... 133
CrossRef Metadata Services ............................................................................................................................................... 133
CMS Basic ...................................................................................................................................................................... 133
CMS Enhanced .............................................................................................................................................................. 135
Cited-by linking ................................................................................................................................................................... 136
Cited-by linking overview .............................................................................................................................................. 136
Retrieving cited-by links ................................................................................................................................................ 137
Depositing references ................................................................................................................................................... 138
FundRef .............................................................................................................................................................................. 139
FundRef ......................................................................................................................................................................... 139
FundRef Deposits .......................................................................................................................................................... 144
FundRef API ................................................................................................................................................................... 146
FundRef Registry ........................................................................................................................................................... 148
CrossRef Schema ..................................................................................................................................................................... 150
Deposit schema .................................................................................................................................................................. 150
CrossRef schema ................................................................................................................................................................ 151
Elements ............................................................................................................................................................................. 153
Face Markup ....................................................................................................................................................................... 156
MathML ............................................................................................................................................................................... 157

Deprecated schema ............................................................................................................................................................ 158
Guidelines, Policies, and FAQs .................................................................................................................................................. 159
FAQ: DOI display guidelines ................................................................................................................................................ 159
Guidelines, Procedures, and Resources .............................................................................................................................. 160
DOI Conflicts policy ............................................................................................................................................................. 161
Useful Tools ........................................................................................................................................................................ 163
Help Site
CrossRef Help
About CrossRef DOIs
What is a DOI?
Similar to a bar code for a physical object, a Digital Object Identifier (DOI) is a unique alphanumeric string assigned to a digital
object, such as an electronic journal, article, report, or thesis. Each DOI is unique and serves as a stable, persistent link to the fulltext of an electronic item on the Internet. Unlike a URL, a DOI doesn't change over time; even if the item moves to a new location,
the DOI stays the same.
DOIs are the only widely adopted persistent identifier for scholarly works. DOI names appear in printed materials and online as
links.
A DOI name consists of two segments:
Prefix: a unique numeric string beginning with the numeral 10 assigned by CrossRef to the publisher that submitted the
information about the digital object
Suffix: an alphanumeric string or series of strings used internally by the publisher to identify the digital object.
In this sample DOI name: 10.1006/jmbi.1995.0238 - 10.1006 is the prefix (in this case, for the publisher Elsevier)
and jmbi.1995.0238 is the publisher-assigned suffix for the particular item (in this case, indicating that it is from the Journal of
Molecular Biology and was published in 1995).
Print, PDF, and HTML versions of the same digital item all use the same DOI names. Generally, a DOI name points to the item in a
single location; however, with multiple resolution, it is possible to point to more than one location.
For a more extensive discussion of DOIs, see The DOI Handbook (pdf) on the Digital Object Identifier System web
site.
Not all DOIs are CrossRef DOIs - use the DOI RA tool to identify the DOI registration agency.
Copyright 2012 CrossRef
Page 1
Help Site
CrossRef Help
About CrossRef DOIs
How do CrossRef DOIs work?

A DOI link consists of two parts: the DOI directory URL (http://dx.doi.org/), and the DOI itself. When combined with dx.doi.org, the
DOI is made into a link. When you click on a DOI link you are directed to the URL registered for the DOI.
For example:
http:/dx.doi.org/10.1006/jmbi.1995.0238
URLs in the DOI directory are updated when an item changes location, ensuring persistence. The DOI System and directory is
managed by the International DOI Foundation.
CrossRef DOIs
In addition to creating durable links, CrossRef DOIs reliably identify content. If you follow a CrossRef DOI to an article youre assured
that the page you view is the publisher maintained version of the article.
CrossRef members deposit DOIs by submitting XML containing citation metadata and DOIs to the CrossRef system. CrossRef stores
the metadata in our lookup service, and registers the DOI and URL in the central DOI directory. As a result, citation metadata is
associated with all CrossRef DOIs, making them retrievable via CrossRef lookup services. This allows CrossRef DOIs to be widely
distributed, and supports collaborative reference linking between CrossRef members. See How CrossRef works for details.
Page 2
Help Site
CrossRef Help
About CrossRef DOIs
Who uses CrossRef DOIs and why?

The four primary types of CrossRef DOI users are publishers, affiliates (including agents and journal hosting platforms), libraries,
and individual researchers. Using CrossRef DOIs offers significant benefits to each of these groups:
Publisher + show benefits

Affiliate + show benefits
Library + show benefits
Researcher + show benefits
CrossRef publishers and titles
Page 3
Help Site
CrossRef Help
About CrossRef DOIs
Examples of CrossRef DOIs in use

DOI names appear in both print and online materials. DOI names are often included in tables of contents; header information for a
digital item, such as an article; and citations, such as a footnote.
CrossRef DOIs should always be displayed as a permanent URL, for example:
http://dx.doi.org/10.1115/1.2803632
DOI response page for journal article: + show/hide example
DOI response page for journal article with journal DOI: + show/hide example
DOI response page for book chapter: + show/hide example
CrossRef DOI Display Guidelines
Page 4
Help Site
CrossRef Help
Getting Started
How CrossRef works

CrossRef enables linking in scholarly content on a cross-publisher basis by providing two basic services:
1. DOI deposit and registration: CrossRef registers DOI names and URLs in a central DOI directory (developed and
maintained by the International DOI Foundation) on behalf of publisher members. The directory works by looking up the
current URL for the specific DOI and sending the end user to that location. When a publisher changes the location of the
content they need to update the URL in only one place: with CrossRef. If the item moves to a new location, the URL link seen
by users will still work, thereby establishing a permanent link. All CrossRef DOIs must resolve to a valid response page.For
each content item deposited with CrossRef, the publisher creates a unique DOI name by appending a suffix of their choosing
to the prefix they've been assigned by CrossRef . The publisher also creates an XML file which associates citation metadata
with the DOI. The publisher then submits (uploads) the file to the CrossRef system.The metadata associated with a DOI can
include:
Basic bibliographic values including all authors, volume, issue, page number or article number, article title
The references being cited within the item
A list of figures, tables, images or other parts of the item (we call these components) which may benefit from having their
own DOI for linking.
2. DOI lookup service: CrossRef's query interfaces allow users (including publishers, libraries, researchers, authors or the
public) who know some amount of information about an item to retrieve a DOI and create persistent links. Users submit
queries to CrossRef which include as much metadata as they have (e.g. journal title, author, article title) and CrossRef looks
for the corresponding DOI and returns it to the user.Although most transactions with CrossRef are made by automated
systems we have put in place several services designed for use by people. For smaller publishers who have limited technical
resources or for end users like authors, researchers and librarians these services are intended for low volume activity. For
detailed instructions on these services please see User Interfaces.
How it fits together

The data flow described in this diagram (+ show/hide diagram ) has a 'target' entity which is the item being referenced and the
'referring' entity contains the citation to the target.
1. Using a DOI prefix assigned by CrossRef, publishers create DOIs for content items. A publisher must also construct an XML file
and upload to the CrossRef system. When content is published online, the DOI name and metadata should be deposited with
CrossRef as soon as possible (within 24 hours is preferable).
2. The publisher also submits the citations contained in each deposited content item to CrossRef. This way, the publisher can, as
part of its electronic production process or online publishing system, add outbound links to any of an item's citations that
point to content already registered in the CrossRef system. The member can also use DOI names to link references to their
own content. It is an obligation of CrossRef members to link references using the DOI name. See "CrossRef DOI Display
Guidelines".
3. Members then use the DOI names retrieved from CrossRef to create persistent outbound links to other members' content.
4. An end user reading the content on-line finds a DOI based link and clicks on it.
5. The user's browser first goes to the DOI central registry to retrieve the actual URL of the item.
6. The user's browser is redirected to the DOI response page URL registered by the publisher.
CrossRef provides initiatives and tools that supplement our core DOI registration and linking services, see CrossRef
Services.
Page 5
Help Site
CrossRef Help
Getting Started
Getting started
Organizations participate in CrossRef by joining under one of these three categories:
1. Member: a publisher or content owner who will be depositing DOIs with metadata
2. Library: a no-fee account for querying the CrossRef system primarily used to support a local linking service
3. Affiliate: an organization (commercial or non-profit) which will be querying the CrossRef system, using CrossRef bulk
metadata or acting as an agent for member publishers.
To see who is currently participating in CrossRef please see:
Publishers & Societies: current publishers and societies that participate in CrossRef.
CrossRef Voting Members: a listing of all voting members.
Libraries: list of library members
CrossRef Affiliates: organizations that are affiliates or agents
Qualifications for membership

Publishers International Linking Association, Inc. (PILA) is a not-for-profit membership organization. PILA runs the CrossRef service,
enabling links to and from online scholarly content. According to the PILA bylaws, membership is open to any organization engaged
in the business of publishing original scholarly materials.
The following conditions must also be met:
The organization applying for membership must publish primary scholarly content that is available online in full text.
The organization must submit metadata, as defined by PILA, for substantially all its content that is online in full text.
In an organization with multiple divisions, the largest legal entity is considered the PILA member and all the divisions are
subject to the terms of the PILA Membership Agreement.
To ensure fairness in reviewing candidates for membership, prospective members must supply information about the content
they intend to deposit.
Only publishers who pay an annual membership fee and own the content represented by CrossRef's metadata are considered
members who are entitled to vote for CrossRef's board of directors. Publishers may participate in CrossRef without actually being a
member themselves if they are represented by a Sponsoring Member.
Page 6
Help Site
CrossRef Help
Getting Started
CrossRef publishers and titles

CrossRef has hundreds of participating publishers depositing for thousands of journals, book, conference proceedings, working
papers, dissertations/thesis and databases. Please use the links below to find out who they are and what publications are
represented.
View a list of the publishers that use CrossRef DOIs

Use the browsable title list to view a list of the titles for which CrossRef DOIs have been deposited
Lists of libraries and affiliates (associations, organizations, agents, and linking solution partners) that use CrossRef are also
available.
Page 7
Help Site
CrossRef Help
Publishers
Becoming a member
CrossRef operates a technical service on behalf of its member publishers helping them establish URL links between their content
and the content of other CrossRef publishers. These links primarily go from the references listed in an item's bibliography to the
item being cited by the author. CrossRef services are technical in nature and require member's staff responsible for integrating with
CrossRef's offerings to have some understanding of XML and Web technologies and to have a thorough understanding of their own
production processes.
Membership process
Publishers join CrossRef by completing and signing the membership application and membership agreement. After joining CrossRef,
you receive a DOI prefix, a user name and password to access the CrossRef system, and the general login to the members' area of
the CrossRef web site. For information about the cost of joining CrossRef as a publisher, see Publisher Fees on the CrossRef web
site.
1. Join CrossRef using our membership request form.
2. When you become a member, you will be assigned a DOI prefix. You must establish a DOI suffix pattern before creating DOIs.
3. Build deposit XML for containing your DOIs and their metadata (non-technical users try our basic Web deposit form).
4. Add DOIs to your DOI response pages
5. Retrieve and construct outbound DOI links for the references in your content
Publishers may also participate in other CrossRef services.
Member obligations
When participating in CrossRef members are expected to:
Build and operate the necessary systems on their side which compose the XML deposit files and submit them to CrossRef
add DOI links (when available) to the reference list for journal articles deposited with CrossRef
Regularly monitor their transactions with CrossRef, and identify and correct errors.
Remain vigilant about updating the metadata for their DOIs, particularly the URL of the resource.
Review the various CrossRef reports issued to members and correct any identified errors.
Use commercially reasonable efforts to make your content available and ensure persistance of links through an authorized
archive if you are no longer able to host your content.
More information on becoming a CrossRef member is available on the CrossRef website. For a complete list of
member obligations, see Publisher Rules.
Page 8
Help Site
CrossRef Help
Publishers
Obtaining a DOI prefix

Once your organization joins CrossRef, CrossRef assigns it a unique DOI prefix beginning with "10.". You do not need to get a DOI
prefix prior to joining CrossRef nor pay a separate fee to the International DOI Foundation (IDF). Member organizations may also
obtain multiple DOI prefixes upon request.
Note that the prefix of a DOI does not reliably identify the current publisher of the item. Once you associate an individual DOI with a
particular content item, the DOI is permanently assigned to that content regardless of the owner. While specific publishers must
assign DOIs using their unique prefix, ownership and control of individual DOIs can (and should) be transferred when a title changes
hands.
Page 9
Help Site
CrossRef Help
Publishers
Establishing a DOI suffix pattern

Before you can assign DOIs to articles or other content items, you must devise a DOI assignment scheme. CrossRef gives you a DOI
prefix that you must use, but you can create your own pattern and system for suffixes.
The DOI suffix has a very flexible syntax. It can be any alphanumeric string, consisting of a single node or multiple nodes. A node is
a portion of a character string. A single node has no delimiters (periods, colons, pipes, and so on), for example: 123456. A character
string with multiple nodes must include a delimiter (a period, colon, pipe, and so on) between each one, for example: 12.34.56.
Each suffix must be unique within a prefix.
Because the DOI is an opaque string intended to remain unique and persistent throughout changes in ownership and location of the
content, you do not need to include any specific or descriptive information in the DOI. Such information forms the metadata
associated with each DOI, which is submitted along with the DOI and URL. If you choose to include such bibliographic information in
a DOI string, it will have no meaning within the CrossRef or DOI system. Existing identifiers can also be used for the DOI suffix, such
as an ISBN, PII (personally identifying information), or existing internal numbering scheme.
Sample suffix patterns

CrossRef members have established a variety of schemes for creating their DOI suffixes. One or more of these patterns may be
appropriate for your situation: Sample DOI suffix patterns
Guidelines
Be concise: Make the suffix as concise as possible to facilitate human readability. Remember, DOIs will appear online and in
print; users will also re-type DOIs.
Be unique: A suffix must be unique within a given prefix.
Be case insensitive: A suffix is case insensitive, so 10.1006/abc is the same as 10.1006/ABC.
Be consistent: The suffix should reflect a consistent, logical system that can be easily documented and readily understood
by employees of your organization, so that the task of assigning DOIs can be passed from one employee to the next. For
example, you might want the suffix to include existing internal identifiers.
Avoid page numbers: It is possible to use traditional bibliographic metadata (such as journal, volume, and page) in
constructing DOI suffixes because both this metadata and the DOI are persistent. However, some issues need careful
consideration before choosing such an approach. DOIs should be active as soon as articles appear online. Choosing a scheme
that is tied to page numbers makes it difficult to put content online before pagination is complete for a print version or if the
items are published online only.
Only use approved characters: "a-z", "A-Z", "0-9" and "-._;()/"
Use one or more nodes: You can use suffix nodes to reflect hierarchical information or levels of granularity. For example,
the first node might be a multiple-letter code for the journal title, while successive nodes encode the year of article acceptance
and the order of article acceptance. This is the scheme used by Academic Press, with resulting DOIs such as
10.1006/jmbi.1998.2354.
Make suffixes extensible: DOI suffixes should be extensible. In the future, for instance, parts of articles, such as figures,
graphs, and supplementary materials, might be assigned DOIs. Using the preceding Academic Press example, the second
figure in the article might be assigned this DOI: 10.1006/jmbi.1998.2354.f002.
DOIs are case-insensitive: 10.5555/ABC123 is the same DOI as 10.5555/abc123
DSpace repositories should review DOIs and DSpace repositories before constructing a DOI suffix pattern
Page 10
Help Site
CrossRef Help
Publishers
Creating response pages

Response pages (sometimes called landing pages) should be created before DOIs and metadata are deposited. DOI names are
active immediately after deposit.
When metadata and DOIs are deposited with CrossRef, the publisher must have active response pages so that incoming links can
be received. As soon as metadata and DOIs are deposited in CrossRef, users will be able to retrieve the DOIs and create links. Most
CrossRef publishers take users to the abstract page and permit authenticated users to access the full text automatically. If the full
text is available at no charge, users can access it immediately. Many publishers also present unauthenticated users with pay-pe-view options.
A minimal response page consists of a full bibliographic citation, including the DOI, displayed to the user. The DOI should be
displayed as a URL. Additionally, a response page must display some mechanism by which the user can access the full text. Access
to the full text is completely controlled by the publisher but the response page must be accessible to anyone. CrossRef highly
encourages including a full abstract.
Sample response page: + show/hide

CrossRef DOI display guidelines are available here. The guidelines recommend that CrossRef DOIs always be displayed as
a permanent URL.
Page 11
Help Site
CrossRef Help
Publishers
How depositing works

Depositing metadata to CrossRef involves the creation of XML according to our deposit schema. This XML is submitted to the
CrossRef System via public or machine interfaces. During the submission process, DOIs and metadata are added to the CrossRef
system, and DOIs are registered with the Handle resolver. Once deposited, DOIs may be resolved by prepending the DOI with
http://dx.doi.org. DOIs (and metadata) may also be retrieved by querying once a deposit has been processed successfully.
The deposit process is described in detail in Deposit basics.
Page 12
Help Site
CrossRef Help
Publishers
How querying works

Querying is the process of retrieving data from CrossRef. There are two basic query modes:
1. Metadata query: you know the bibliographic data and wish to retrieve the DOI for the item
2. DOI query: you have a DOI and would like to retrieve associated metadata
The majority of query transactions occur automatically by users who build systems that make simple HTTP GET requests to our
server. XML query files may also be submitted by HTTP POST or via the CrossRef system web interface. Bulk query options are also
available.
CrossRef provides web-based query forms which are useful for individual authors or researchers looking to find a specific article, or
by a member's technical staff when trying to investigate a particular problem.
Query processes and options are described in detail in Queries & retrieving metadata
Page 13
Help Site
CrossRef Help
Publishers
Outbound linking
CrossRef Members are required to create outbound DOI links within their references, meaning members must add DOI links (when
available) to the reference list for journal articles deposited with CrossRef. Outbound linking for other content types is encouraged
but not required.
The CrossRef Board of Directors has changed the penalty for members who have not implemented outbound linking. Starting in
2011, instead of being charged a non-linking fee of 22 cents per DOI, CrossRef members who are not linking within the initial 18
months of joining CrossRef may have their accounts suspended.
Creating outbound links

1. Query for DOIs: The first step is to retrieve DOIs for all available references. Several different query interfaces are available:
Simple Text Query form: cut-and-paste reference lists into a web form. This is a manual interface suitable for low volume
querying.
Simple Text Query upload: upload reference lists as .txt files and receive query results via email. This is a manual interface
suitable for low volume querying.
XML Queries: XML formatted using the CrossRef query schema may be submitted to our system as individual requests or as a
batch upload. XML querying allows for significant control over query execution and results, and is the preferred method of
querying for most members (details).
2. Link to DOIs in your references: After DOIs have been retrieved via querying, members must display and link DOIs in their
references. To make a DOI into a link, precede it with http://dx.doi.org/ (as in http://dx.doi.org/10.1006/jmbi.1998.2354).
Sample outbound linking
Queries & retrieving metadata, Querying with XML, crossref_query_input2.0.xsd schema documentation, CrossRef
DOI Display Guidelines, Building URLs for DOIs containing special characters
Page 14
Help Site
CrossRef Help
Libraries
CrossRef for libraries

Through CrossRef, libraries can create links to CrossRef member publishers without signing bilateral linking agreements with each
publisher, and without having to track publishers' individual linking schemes. The CrossRef system also serves as a source of
metadata to enhance OpenURL-based local link resolvers and supports DOI re-direction for the purposes of localized linking within
library holdings. Some libraries have created their own link resolvers, and many libraries purchase the services of one of a number
of vendors who now provide link resolution software.
In most cases, information providers (publisher, database producers, and so on) use CrossRef to add DOIs to their content and
databases, so libraries do not need to use CrossRef for DOI retrieval alone. If libraries host local content, the content providers
should add DOIs before delivering the content. Users browsing online content will see DOI links and click them; there is no charge
for clicking and following DOIs links.
There is no charge for libraries to get a CrossRef account to retrieve DOIs or metadata. More information is available on the
CrossRef website.
To view a list of libraries with CrossRef accounts, see Libraries on the CrossRef web site.
For information about how the DOI integrates with local link servers, see DOIs, OpenURL, and link resolvers.
Page 15
Help Site
CrossRef Help
Libraries
DOIs, OpenURL, and link resolvers

For optimal integration with library linking systems, information providers are implementing the OpenURL standard. OpenURL is a
mechanism for transporting metadata and identifiers describing a publication for the purpose of context-sensitive linking through a
local link resolver.
A link resolver is a system for linking within an institutional context that can interpret incoming OpenURLs, take the local holdings
and access privileges of that institution (usually a library) into account, and display links to appropriate resources. A link resolver
allows the library to provide a range of library-configured links and services, including links to the full-text, a local catalogue to
check print holdings, document delivery or ILL services, databases, search engines, and so on.
Why libraries need local link resolvers

DOIs point to the authoritative version of content on the publisher's web site and to publisher-designated resources. Yet for the
user working in an institutional context, it is often useful to be directed to other resources. For example, the institution may not
subscribe to the electronic journal itself but may still be able to offer the user access to the desired article through an aggregated
database or through print holdings. In addition, the library may want to provide a range of linking options beyond what is available
at the publisher's web site.
How the DOI System and OpenURL work together

The DOI and the OpenURL work together in several ways. First, the DOI directory itselfwhere link resolution occurs in the CrossRef
systemis OpenURL-enabled. This means that it can recognize a user with access to a local resolver. When such a user clicks a
DOI, the CrossRef system allows the DOI to be used as a key to pull the metadata needed to create the OpenURL targeting the local
link resolver out of the CrossRef database and redirects that DOI back to the user's local resolver. Consequently, the institutional
user clicking the DOI is directed to appropriate resources. By using the CrossRef DOI system to identify their content, publishers in
effect make their products OpenURL aware.
Localized linking via DOI redirection occurs in this sequence, as shown in the following illustration: + show/hide illustration
1. A library user clicks a DOI link within a link resolver-enabled resource.
2. A cookie on the users machine alerts the DOI proxy server to redirect this DOI to the local linking server.
3. The local linking server receives the metadata needed for local resolution either from the source of the link or from CrossRef
via OpenURL.
An OpenURL link that contains a DOI name is persistent in the same way a DOI name is. Publishers who use the CrossRef DOI
system to identify their content, in effect, make their products OpenURL-aware.
Using the Open URL Query Interface, Setting up your system for localized linking
For more information on OpenURL, see http://library.caltech.edu/openurl.
Page 16
Help Site
CrossRef Help
Libraries
Setting up your system for localized linking

To take advantage of localized linking, your localized linking server must have a recognized BASE-URL. BASE-URLs are collected
from library affiliates when they sign up with CrossRef, and forwarded to the IDF for registration.
Once the BASE-URL is registered, go to http://www.doi.org/cgi-bin/pushcookie.cgi?BASE-URL={your BASE-URL} to download a
cookie, which contains the URL for your local content server. This cookie makes your browser OpenURL-enabled, which means that
the CrossRef system will redirect relevant requests to your local resolver.
If you upgrade or change your local link resolver, send your new BASE-URL to support@crossref.org.
For more detailed information about BASE-URL and cookie pusher script, see
http://www.exlibris-usa.com/sfx_cookiepusher.htm.
Page 17
Help Site
CrossRef Help
Getting Started
CrossRef Affilates
CrossRefs Affiliate programs are for organizations that are not primary publishers but want to retrieve CrossRef DOIs and
bibliographic metadata for persistent linking to publisher full text. A range of affiliate programs are available. More information is
available on the CrossRef website.
Page 18
Help Site
CrossRef Help
Depositing DOIs and metadata
Deposit basics
How depositing works
Depositing metadata to CrossRef involves the creation of XML according to our deposit schema. This XML is submitted to the
CrossRef System via public or machine interfaces. During the submission process, DOIs and metadata are added to the CrossRef
system, and DOIs are registered with the Handle resolver. Once deposited, DOIs may be resolved by prepending the DOI with
http://dx.doi.org. DOIs (and metadata) may also be retrieved by querying once a deposit has been processed successfully.
Step-by-step
The basic process for depositing consists of these steps:
1. Create XML using the CrossRef deposit schema (non-technical users may use the Web Deposit form).
2. Verify your XML.
3. Upload your XML (via a web interface or programatically).
6. Submit your deposit.
The upload process is very basic and performs no data validation at the time of upload. The 'Success' acknowledgment you receive
after submission step simply indicates that your file has been received. Each uploaded file then goes into a queue to await
processing which validates your XML using the Xerces parser. This step verifies that the XML is well formed and conforms to the
rules of the CrossRef schema and performs certain logic checks on the data in the file (see below).
Reviewing submission logs

After a deposit is processed, you receive an email indicating the results (in an XML format) which lists the status of each DOI
contained in the file. Note that while many DOIs in a file may successfully get deposited, individual DOIs may fail. Submission logs
must be examined, and any flagged problems should be corrected and the file(s) resubmitted.
Deposit tips
For efficient processing, keep file sizes under 150KBytes. File size should not exceed 1.5MBytes. During times of very heavy loads,
jobs may take several hours to reach the top of the queue and large files can take an hour or more to process. You can track your
submission's progress and, if necessary, request that CrossRef staff move it up in the queue.
Deposit rules
Most of the rules which govern the data allowed/required in a deposit are specified in the CrossRef schema and enforced via XML
validation. A few rules exist outside the schema and are enforced by the software which processes the deposit:
1. DOIs may only contain the following characters: "a-z", "A-Z", "0-9" and "-._;()/"
2. Publication title ownership is enforced. This means that CrossRef recognizes a single publisher as owning a title and thus only
DOIs using the prefix of that publisher may be assigned to the publication. Please contact support@crossref.org to resolve any
issues associated with this rule.
3. Every time a DOI is deposited it must be given a timestamp, the value of which must increment with subsequent updates.
This value is a string of text that gets interpreted as a number. The recommended format is YYYYMMDDHHMM (ex:
200810021422). Timestamps need to be incremented when DOIs are updated.
Deposit content types, Best practices for depositing
Page 19
Help Site
CrossRef Help
Deposit content types: what can be deposited?

CrossRef enables DOI assignment for a variety of content types and at multiple levels:
Journals: DOIs may optionally be assigned to the journal itself, a specific volume or a specific issue. However, we strongly
encourage the assignment of a DOI at the journal title level (journal title DOIs often use the ISSN as the suffix). DOIs should be
assigned to all articles published within the journal and may be assigned to other content as well (e.g. book reviews, editorials
etc.). Items that are part of an article which may benefit from having their own identifier can be registered as components and
given a DOI unique from that of the article. These items include figures, tables or supporting data files.
Books: DOIs are always assigned at the book title level and frequently at the chapter level as well. Books may also be
deposited as part of a series in which case the series is assigned a DOI unique from the DOI of any volume within the series.
Book deposits should have an ISBN when available for each volume title and must have an ISSN for each series title.
Conference proceedings: Conference proceedings are quite similar to journals/articles with the major exception being the
metadata includes information about the conference event as well as the proceedings title. Each paper within the proceedings
is treated like a journal article.
Components: Components are parts of some other content type which are to be given their own DOI. They require a parent
DOI which may be the DOI of an article, journal, book, chapter, standard or any other DOI. Components may be deposited
along with their parent or they can be deposited by themselves in a separate XML file.
Dissertations and thesis: DOIs are assigned to each dissertation or thesis. DOIs are not assigned to an aggregation of this
content type (e.g. if a collection of dissertations is published together it most likely would be deposited as a book).
Reports and working-papers: This content type resembles books in many ways with the major difference being an ISBN is
not required. DOIs need not but are strongly encouraged to be assigned at the title level. Lower level "content-items" may also
be given their own DOI (similar to chapters in a book). Reports/working-papers may be published as part of a series in which
case the series title is given a unique DOI and must have an ISSN. Volumes published with a series must also have an ISBN.
Standards: Standards are assigned a DOI at the title level and may also have DOIs assigned to lower level "content-items".
Standards published as stand alone publications do not need an ISBN but like reports if they're published in a series ISBNs and
ISSNs are required. The metadata for standards differ primarily in the inclusion of additional designators along with the title
which are commonly used when referring to a standard.
Database: Databases are another top level construct which can be assigned a DOI. Lower level items within a database, called
datasets, are each given a unique DOI and any database/dataset DOI may include components. This content type has been
used to address a number of situations that do not easily fall into the other categories. While originally intended for more
traditional collections of data we have found this content type useful for allowing to DOIs to be assigned to a number of
collections which might not be considered a 'database' but which defy easy classification into the other content type.
DOIs can be assigned to any object that is accessible online. Each DOI is assigned a primary URL during the deposit process which
points to what we call the response page. DOI response pages must meet CrossRef membership rules, which at a minimum requires
display of the bibliographic data (article title, author, publication title, date of publication) and the DOI displayed as a URL.
CrossRef deposit schema
Page 20
Help Site
CrossRef Help
DOI resource deposits

Some ancillary metadata may be deposited separately from metadata deposits as resource deposits. These deposits append the
included metadata to the citation metadata already stored in the CrossRef system, and do not need to be included in citation
metadata updates. Resource deposits use the doi_resources4.3.2.xsd schema (documentation) with the exception of stand-alone
components which use the main deposit schema.
Reference deposits
URLs: A primary URL must be included in all DOI deposits. Additional URLs may also be included, for:
as-crawled URLs (used for CrossCheck)
Multiple Resolution secondary URLs
content version or text mining URLs
Components
FundRef
CrossMark
Access Indicators
Page 21
Help Site
CrossRef Help
Journal title-level DOIs

CrossRef publishers are not required to create DOIs for journal titles but are strongly encouraged to do so. There are no deposit
fees for title-level DOIs.
Title-level DOI best practices are as follows:
A distinct DOI should be created for each version of a title deposited with CrossRef. Any changes requiring a new ISSN should
result in a new title-level DOI as well.
A title-level DOI should resolve to a response page that displays the same title and ISSN recorded in the CrossRef database.
Once assigned, a title-level DOI should be maintained.
Responsibility for maintaining a title-level DOI transfers to the new owner when title ownership is transferred.
As with all DOIs registered via CrossRef, the DOI being resolved should appear on the DOI response page.
The ISSN standard, ISO 3297, recommends that a DOI suffix contain the ISSN (with hyphen), preceded by the lowercase letters
issn and a period, for example: 10.5930/issn.1994-4683
Journal DOIs are required to comply with COUNTER release 4.
Depositing title-level DOIs

Title, volume, and issue DOIs may be included with journal article deposits, or may be deposited separately. Once deposited, a
journal, volume, or issue DOI does not need to be included in subsequent deposits but, as with all DOIs, the URL should be
maintained. The web deposit form supports deposit of title-level DOIs.
Page 22
Help Site
CrossRef Help
Depositing and distributing references

In addition to article metadata, CrossRef members may also deposit reference lists. Reference deposit is optional, but required for
cited-by linking participants.
By default, references deposited for a DOI are only distributed to the current owner of the DOI or to OAI-PMH subscribers (when
given permission by the current publisher). CrossRef member publishers may also now elect to include deposited references in
UNIXML query results as well as OAI-PMH results, making references publically available. This feature is managed on a prefix basis.
Contact support@crossref.org if you would like reference distribution enabled for your prefix(es). Reference distribution is
encouraged for all members.
Page 23
Help Site
CrossRef Help
Deposit fees and publication date

DOI deposit fees are determined by the content type and publication date included in a deposit, with backfile deposits being
charged at a lower rate. The publication year included in the initial DOI metadata submission determines whether or not a DOI is
considered a Current Year (CY) or Back Year (BY) DOI. The CrossRef schema supports deposit of both an online and print publication
dates. For individual items, when both online and print publication years are present, the fee charged is determined by the print
year. If a print year is not included in the deposit, the online publication year is considered.
When depositing journals be aware that each individual item is considered separately, regardless of the publication year included at
the journal volume or issue level. For example, a deposit including both a print publication date of 1990 and an online date of
2013 at the issue level and only an online publication date of 2013 at the article level will be considered a current year deposit. If
the print date of 1990 is included at the article level, the back year fee will be charged.
Example: Fees charged by publication year type
Issue Year
Article Year
DOI1 2013 (online), 1971 (print) 2013 (online), 1971 (print)
Fee level
BY rate
DOI2 2013 (online), 1971 (print) 2013 (online), no print date CY rate
DOI3 2013 (online), no print
2013 (online), 1971 (print)
BY rate
DOI4 2013 (online), no print
1971 (print)
BY rate
Current deposit fees
Page 24
Help Site
CrossRef Help
Troubleshooting Deposits
Verifying your XML

If you are new to CrossRef or intend to deposit a new content type, it is recommended that you verify the format and structure of
an XML file before submitting it as a deposit to the system. Using these methods is quicker than verifying your XML by trial and
error.
You can validate your XML by:
1. Using the XML Parser on the CrossRef web site
When you send data to the XML Parser no processing occurs. If the files parses successfully you will see a count of the number
of DOIs found in the file. Failures will be displayed as errors generated by the Xerces parser.
The validator will validate against all CrossRef schema but only schema versions 4.3.0 and up are valid for deposits.
Best for: quickly validating a few files
2. Using the test system at http://test.crossref.org

CrossRef maintains a test system at http://test.crossref.org. The test system functions identically to our live system but uses a test
database and does not register DOIs with Handle. To use, direct your browser or deposit program to test.crossref.org instead of
doi.crossref.org.
Best for: testing large numbers of files or new titles
If you are a new CrossRef member the test database might not be have been updated with your login credentials or
prefix. If you are denied access, contact support@crossref.org.
Page 25
Help Site
CrossRef Help
Common ISSN and ISBN Errors

CrossRef has implement strict title, ISSN, and ISBN checks to prevent title duplication and errors. The title/ISSN/ISBN combination
submitted in a deposit must match the title/ISSN/ISBN combination in the CrossRef database. title/ISSN/ISBN combinations are
extracted from the first deposit of a title, and can only be edited by CrossRef staff.
Error: ISSN "{ISSN}" has already been assigned to a different title/publisher/genre

This error indicates the ISSN and/or title in your deposit does not match data in our system, or the title is owned by another
publisher. Possible causes:
Title and ISSN in deposit do not match title associated with ISSN in the system
Title is owned by another publisher
DOI is owned by another publisher (if DOI is being updated)
+ show/hide solution
Error: ISSN "{ISSN}" has already been assigned to a different publisher {publisher name}({publisher
prefix}) or ISBN "{ISBN}" has already been assigned to a different publisher {publisher
name}({publisher prefix})
This error indicates that the title you are depositing is owned by another publisher/prefix. If you are the correct publisher for the
title being deposited, verify that you have followed the title ownership procedures described in Transferring DOI ownership. If you
have followed transfer procedures. contact support@crossref.org.
Error: ISSN "{ISSN}" is invalid

This error indicates that the ISSN provided in the deposit is not valid. All ISSNs must have a valid check digit as described here. This
validation prevents transcription errors, which are common. If your deposit failes because of this error:
Carefully verify that the ISSN in your deposit is correct. If it is not, correct and resubmit your deposit.
If the ISSN matches the ISSN you believe is assigned to your title, check your ISSN against the ISSN assigned by the ISSN
Register (or your ISSN registrar). Transcription errors may occur when the ISSN is assigned. If you are not able to verify your
ISSN, contact support@crossref.org and we will look it up for you.
Updating or correcting title information, Best practices for journal titles
Page 26
Help Site
CrossRef Help
Interpreting submission logs

Submission logs contain valuable information about items submitted to the CrossRef system. After a file has been processed, a
report is emailed to the address specified in the submission.
Successful submission + show/hide example

In this example, the number of items submitted (<record_count>) equals the number of successful deposits
(<success_count>).
Submission with problems + show/hide example

This example contains failures (<failure_count>4</failure_count> ). Records with a status of "Failure" indicate the DOI was not
deposited. A status of "Warning" indicates that the DOI was deposited but may need further action.
Each error should be corrected and the deposit resubmitted. See Error and warning messages for details.
If you do not receive an email:
verify that the email address included in your submission is correct

use the Submission Administration interface to retrieve your report
if you are still not able to retrieve your report, contact support@crossref.org. Please specify the time and date of your deposit.
Deposits whose XML will not parse will be rejected in their entirety.
All DOIs in the file will not be processed if any XML errors are encountered whether the error is just a simple omission of data
from one record or a major structural problem with the XML.
Page 27
Help Site
CrossRef Help
Error and warning messages

DOIs with a "Warning" status have been deposited but may need extra attention. A status of "Failure" means that a DOI within a
deposit, or an entire deposit, has failed. Failures may be the result of a system check or validation / processing error.
Warnings
Warning
Added with
conflict
Meaning
Solution
Two DOIs are in the system with the same metadata. This usually
occurs when an article is published ahead of print such that no
enumeration or page values are available.
Review and resolve

conflicts
Error messages: system checks

The CrossRef system performs a number of checks that are beyond the scope of schema validation. These checks prevent the
introduction of bad data to our system.
Error Message
Meaning
Solution
Record not processed because

submitted version: xxxxxxx is
less or equal to previously
submitted version (DOI match)
The timestamp in this update is

dated before a previous update.
The timestamp in the submission
needs to be numerically greater
than the timestamp in the previous
submission.
Review and edit the timestamp

included in the deposit. Timestamps
can be found in the Depositor report,
by reviewing DOI history, or by
retrieving DOI info-metadata.
User with ID: {0} cant submit

into handle, please contact the
CrossRef admin
The handle system username and

password assigned to this prefix is
incorrect in the CrossRef system
Contact support@crossref.org - include

submission ID in your email
User not allowed to add records

for prefix: {0}
The CrossRef account used does

not allow deposits for this prefix
Confirm that you are using the

appropriate account and prefix then
contact support@crossref.org. Include
submission ID in your email.
All prefixes in a submission

must match (DOI[{0}])
In a given XML file all DOIs being

deposited must have the same
prefix, regardless of ownership.
Revise submission to include a single

prefix (create multiple submissions if
needed)
year: {0} in not a valid integer
Year must be a string that converts Review and edit year

to a valid 4 digit year
title "{title}" was previously

deleted by a CrossRef admin
The title being deposited/updated

previously existed in the system
but was deleted
Review your title and compare to

previous deposits - if it is correct,
contact support@crossref.org. Include
submission ID in your email
user not allowed to add or

update records for the title
"{title}"
The CrossRef account used does

not allow deposits for this title.
Review title to confirm that you are

using the appropriate account and
prefix then contact
support@crossref.org. Include
submission ID in your email.
ISSN "12345678" has already
The ISSN, title, or ownership of

your deposit does not match
information in the system
Refer to ISSN error troubleshooting

guide
been assigned to a different

title/publisher/genre
Error messages: common validation and processing errors
Page 28
Help Site
CrossRef Help
Error Message
Meaning
Solution
[error] :286:24:Invalid content starting with element {element

name}'. The content must match
'(("http://www.crossref.org/schema/4.3.0": item_number) {0-3},
("http://www.crossref.org/schema/4.3.0": identifier) {0-10})
This is an example
of a parsing error
being reported in
the log file. Since
this output comes
directly from the
Xerces parser the
actual message
will vary
depending on the
error.
Review file at line /

column indicated (in
this example line 286
col. 24) edit and resubmit.
Contact
support@crossref.org
for help if needed.
org.jdom.input.JDOMParseException: Error on line 312 of

document
file:///export/home/resin/journals/crossref/inprocess/395032106:
The content of elements must consist of well-formed character
data or markup.
Indicates
unacceptable
markup in file
Review the file as

indicated, correct, and
re-submit.
[fatal error] :1:1: Content is not allowed in prolog.
Indicates
characters (BOM)
precede the XML usually occurs
when word
processing
programs are used
Open file in a text /

XML editor and
remove characters
(usually )
java.io.UTFDataFormatException: invalid byte 1 of 1-byte > UTF8 sequence (0x92)
Indicates badly
Locate and correct
encoded character character - see Using
Special Characters for
more information
java.sql.SQLException: ORA-00001: unique constraint

(ATYPON.NDX1_CIT_RELS) violated
This error message

occurs when 2 files
containing the
same DOIs are
submitted
simultaneously,or
when a DOI is
included twice in
the same file. The
system attempts
to process both
deposits - only one
deposit will be
successful. The
unsuccessful
deposit will
generate this
error.
Review DOI history to

make sure DOI is
updated with correct
metadata
Page 29
Help Site
CrossRef Help
Error Message
Meaning
Solution
java.lang.NullPointerException
Most often this

means a citationonly deposit or
multiple resolution
resource-only
deposit has been
uploaded as a
metadata deposit
(or vice-versa)
Resubmit deposit as
'DOI Resources' (when
using the CrossRef
System) or
doDOICitUpload (HTTP
transaction). If this
does not apply to your
deposit, contact
support@crossref.org
with details.
Submission version NULL is invalid
Schema
declaration is not
correct
Resubmit with correct

schema declaration
Interpreting submission logs, Submission details, Viewing the Submission Administration report
Page 30
Help Site
CrossRef Help
Multiple Resolution
Multiple Resolution Overview

CrossRef's Multiple Resolution service allows multiple URLs to be assigned to a single DOI. The DOI resolves to an interim page,
which presents a list of link choices to the end user. Publishers most commonly implement Multiple Resolution for content with cohosting agreements.
Multiple Resolution operates by directing the DOI to a service hosted by CrossRef which uses a HTML template to present a branded
page (known as an interim page) to the end user. Templates may be assigned on a title or prefix basis (e.g. a unique template per
publication title, or one template for all titles associated with a given prefix).
Example interim page: + show/hide
Multiple Resolution details
Implementing Multiple Resolution

Depositing secondary URLs
Role of the DOI proxy
Reversing multiple resolution
The current version of CrossRef's Multiple Resolution service has been active since May 2008. The pilot version has been
discontinued. Differences between the pilot and production version are described here.
Page 31
Help Site
CrossRef Help
Multiple Resolution
Implementing Multiple Resolution

Multiple resolution typically involves coordination between a primary depositor and a secondary depositor, the primary depositor
being the content owner, and the secondary depositor(s) being additional entities with permission to assign additional URLs to a
DOI. The primary depositor deposits metadata for a DOI and creates the multiple resolution interim page, whereas the secondary
depositor supplies URLs.
Steps involved in depositing Multiple Resolution DOI:
1. Establish permissions: the primary depositor notifies CrossRef of their intention to deposit Multiple Resolution DOIs
If needed, the secondary depositor may coordinate multiple resolution activity with CrossRef. Permission from the primary
depositor must be provided. (more info)
CrossRef assigns appropriate permissions to depositors and prefixes, and creates MR-only deposit accounts (if necessary).
2. Interim page template: an interim page template is constructed and sent to CrossRef (typically this is done by the primary
depositor)
3. Enable DOIs: the primary depositor deposits (if necessary) and unlocks Multiple Resolution DOIs.
4. Deposit secondary URLs: secondary depositor(s) deposits secondary URLs
Page 32
Help Site
CrossRef Help
Multiple Resolution
Authorizing Multiple Resolution deposits

Multiple resolution typically involves two (or more) publishers involved in a co-hosting agreement. For the purposes of multiple
resolution, the primary depositor is the content owner, meaning they represent the organization that holds copyright for the
content or is otherwise known as the publisher. Multiple resolution DOIs are owned by the primary depositor's prefix. The
secondary depositor co-hosts content with the primary depositor - they have been authorized by the content owner to serve the
content on-line and assign additional URL to DOIs. CrossRef will always defer to the primary depositor's instructions regarding
changes to DOI metadata including all assigned URLs.
Permissions
Before depositing, the primary or secondary depositor must notify CrossRef of the intention to deposit multiple resolution DOIs, and
all titles and prefixes involved. The secondary depositor may coordinate multiple resolution activity with CrossRef with permission
from the primary depositor - this can be an email to support@crossref.org stating "XYZ Publishing has permission to coordinate
multiple resolution activity on our behalf for titles (...)"
Enabling a deposit account for multiple resolution

The Multiple Resolution process only permits URL data to be deposited by secondary depositors - other metadata can only be
deposited and updated by the primary depositor. The primary depositor will be able to perform all multiple resolution functions
using their current CrossRef system account. The secondary depositor will be assigned a new system account to be used for
multiple resolution deposits only.
Creating an interim page template, Enable DOIs for Multiple Resolution, Deposit Secondary URLs
Page 33
Help Site
CrossRef Help
Multiple Resolution
Building the interim page template

The interim page is displayed based on an HTML template. The template operates on a simple text replacement process. The
current interim page function currently supports directives which can appear anywhere in the template HTML file:
 will be replaced by the DOI

 will be replaced by metadata associated with the DOI as HTML table rows and data cells
 will be replaced by URL of one MR target (multiple uses of this directive will iterate through the available MR
secondary targets)
 will be replaced by the primary URL (presumably the content owner's URL)
 will be replaced by the URL of the MR target deposited with the specified label. Labels used in <!-link label="XYZ"--> must match the label supplied in deposits by the secondary depositor.
HTML template download sample or + show/hide example

Example HTML (populated with MR data) + show/hide example
Example interim page: http://dx.doi.org/10.1177/152216280100400206
Images and stylesheets may be provided along with the template as needed.
Multiple resolution DOIs deposited without an associated template will default to a generic CrossRef template (not
recommended)
The directive  will be replaced by all links to all MR targets as a HTML table rows and data cells (one link per row).
This directive is part of the system template but is not recommended as the result is ugly.
Establishing Multiple Resolution permissions, Enable DOIs for Multiple Resolution, Deposit Secondary URLs
Page 34
Help Site
CrossRef Help
Multiple Resolution
Enable DOIs for Multiple Resolution

The primary depositor must enable (or 'unlock') each multiple resolution DOI before secondary URLs can be deposited. This can be
done by using either the main deposit schema or the DOI resources schema. It is expected that once a content owner gives
permission for multiple resolution to be attached to DOIs of a given title, or to all their content, that the content owner will routinely
enable multiple resolution when creating/updating their DOIs.
Unlock DOIs using the main deposit schema

This mode should be used for all new DOIs created after the content owner has recognized that secondary deposits will be taking
place. It allows the primary content owner to enable the DOI MR permission at the same time the DOI is initially created.
The XML used by the content owner to create (or update) the DOI must include an a <collection> element with the multi-resolution
attribute set to 'unlock'. + show/hide example
Unlock DOIs using the DOI resources schema

This approach can be used for all pre-existing DOIs or can be used for new DOIs if the content owner does not wish to include this
metadata in their main DOI deposit. The resource file can be uploaded using the Web form on the doi.crossref.org system or using a
programmed HTTP transaction. + show/hide example
Resource-only deposits should be uploaded as 'DOI Resources' when using the system interface or
'operation=doDOICitUpload' when doing a programmed HTTP transaction
Establishing Multiple Resolution permissions, Creating an interim page template, Deposit Secondary URLs
Page 35
Help Site
CrossRef Help
Multiple Resolution
Role of the DOI proxy

Significant changes were made to the DOI proxy (dx.doi.org), which is maintained by CNRI on behalf of the IDF, in order to
implement multiple resolution. Prior to these changes the resolution service provided by the proxy were a very simple redirection to
single URL (known by many as the default URL). In this mode each DOI had one URL which would always be selected whenever a
user requested resolution. The Handle system stores DOI data in properties or name value pairs and the name for this property was
URL.
Multiple resolution required the introduction of an additional Handle property for DOIs to exhibit this new behaviour. This property is
called "10320/loc", which is itself a Handle.
Sample Handle record:
In the sample handle record the default URL is set to represent the content's primary location. This is typically the platform of the
content owner, or its primary publisher. The presence of property 10320/loc, containing an XML snippet, indicates to the proxy that
multiple resolution is enabled for this DOI. The XML is interpreted as follows:
<locations> element, chooseby: specifies the order of rules to be applied by the proxy when selecting from the<location>
elements.
locatt: used if the DOI request specifies a specific location item
country: used if any location item specifies a specific country which must match the country of the requester
weight: a weighted random selection from those <location> elements having weight values
<location> element identifies a specific location
id: a unique ID given to each location element
cr_type: a CrossRef property that specifies the type of multiple resolution to support
cr_src: a CrossRef property that identifies which CrossRef user deposited the location value
label: used by CrossRef to identify the co-host
href: the URL of the location
weight: the weighted value to use when applying the weighted-random selection process
The presence/absence of a rule in the chooseby property will enable/disable that type of selection process by the proxy.
For CrossRef's interim page multiple resolution we are setting the weight of the interim page location to 1 and all other locations to
zero. This will cause the weighted-random rule to always select the interim page location. CrossRef's interim page application will
then display to the use the set of choices which will consist of the default URL along with all other <location>s.
DOI resolution requests may be structured to bypass the CrossRef interim page using features built into the proxy's multiple
resolution capabilities.
To force the DOI to resolve to the primary (original) host location:
http://dx.doi.org/10.50505/200806091300?locatt=mode:legacy
To force the DOI to resolve to a specific location:
http://dx.doi.org/10.50505/200806091300?locatt=label:HOST-XYZ
Page 36
Help Site
CrossRef Help
Multiple Resolution
Reversing multiple resolution

Multiple Resolution can be reversed if the service is no longer needed for a DOI. This can be done by either:
1. Deleting deposited interim page data: secondary depositor multiple resolution data can be deleted from a DOI by
submitting a secondary deposit with an empty <item> element within a collection, or with an empty <collection> element.
This will remove any URLs submitted by the secondary depositor from both the interim page and query response XML.
+ show/hide exampleDeposits made by primary and other secondary depositors will not be affected, and the DOI may still
be updated with new Multiple Resolution URLs.
2. Locking a Multiple Resolution DOI: the content owner of a DOI may "lock" the DOI, preventing any future Multiple
Resolution deposits. The empty <item> element described above should be submitted as well if the content owner wishes to
remove already-deposited Multiple Resolution URLs.
+ show/hide example
Submitting an empty collection tag (as is done when unlocking DOIs)will remove any deposited secondary URLs.
Page 37
Help Site
CrossRef Help
Multiple Resolution
Depositing secondary URLs

Content owners (or their agents) will continue to make deposits of DOIs, metadata and prime URL using the main CrossRef
metadata schema. Aside from unlocking multiple resolution DOIs, content owners need not do anything different when multiple
resolution activity is occuring.
Secondary depositors will build XML files per our DOI Resources schema, which allows them to supply additional URLs for a DOI.
+ show/hide example
Each secondary depositor is allowed to deposit only one additional URL per label for a DOI. If multiple URLs are being deposited for
a single DOI, a distinct label must be applied to each URL. The <item> element's label attribute is optional according to the
schema, but should be included in secondary URL deposits. The value assigned to this attribute allows for building a stable
relationship to the specific link presented in the interim page template. The labels should be included in the interim page template
as well - without the label within it is not possible to assign the proper <resource> to the corresponding link item in the template.
label is case-sensitive
A secondary depositor may update their URL by simply resending the XML file to CrossRef with the modified value.
Creating an interim page template, Establishing Multiple Resolution permissions, Enable DOIs for Multiple Resolution
Page 38
Help Site
CrossRef Help
Using special characters

Special characters are those characters that are not part of the ASCII or ISO 8859-1 (Latin-1) character sets. ASCII and Latin-1
characters can be represented in one octet (byte) of information and are displayed properly in almost all editors and viewers on
most computer systems. Special characters go beyond this set and are best represented as Unicode characters. Information about
Unicode is available at the Unicode Consortium's web site, which includes a link to an interactive code chart.
Unicode is a 16-bit (two octet) format and requires viewers and editors that understand the format to allow users to work with these
characters. If you view a Unicode character set file in a non-Unicode viewer, you'll likely see gibberish such as a series of little
square boxes and question marks. To further complicate matters, UTF-8 is an encoding scheme that lets you include Unicode
characters in single-octet format files, like XML files. Again, you need a UTF-8 capable viewer to work with these types of files.
The XML you use to submit files to CrossRef are encoded with UTF-8. The ASCII and Latin-1 sets map directly into UTF-8 so that any
ASCII file can be viewed and edited in a UTF-8 compliant application, such as a browser. The issue arises when you want to include
a special Unicode character in an XML CrossRef file, for example, the name Mller, which contains a "u" with an umlaut.
There are two ways to include a special Unicode character in a CrossRef deposit XML file:
1. Use a UTF-8 editor or tool when creating the XML and insert characters directly into the file, which results in a one or more
byte sequence per character in the file.For example, an "S" with a hek () has a decimal value of 352 which is 160hex. This
value converts to the UTF-8 sequence C5,A0 in hex. You can create a small XML file in which you insert this two-byte
sequence (shown here between the <UTF_encoded> tags). <?xml version="1.0" encoding="utf-8" ?>
<start>
<UTF_encoded></UTF_encoded>
</start>The character displays properly in a browser but if you save the XML source and try to view it in certain editors, it
will not display correctly.
2. Encode the special character using a numerical representation. This is the preferred approach and is implemented by
constructing an entity reference in the XML that is the numerical value of the character. For example,
<surname>Šumbera</surname> includes the special character "S" with a hek ().
Character entities
XML based on schema does not support named character entities. For example, é or – are not allowed . In order to
include these characters you must use their numerical representation, é or – respective. These are called
numerical entities as signified by the presence of the '#' character. The 'x' following the pound sign indicates the value is in hex,
as opposed to decimal if the 'x' were omitted. All entities must end with the ';' character.
Character numerical values may be found on the Unicode web site at The Unicode Character Code Charts.
Face markup
Some style markup is supported by the CrossRef schema but we recommend minimal use of this capability. The metadata being
deposited with CrossRef is primarily intended to support DOI lookup and retrieval. Only when style markup is essential to the
meaning of the text should it be used.
For more information about Unicode and UTF-8, see UTF-8 and Unicode FAQ for Unix/Linux and The ISO 8859 Alphabet
Soup.
Page 39
Help Site
CrossRef Help
Assigning DOIs to translations

If the deposit metadata for the translation differs from the metadata for original language item, a distinct DOI may be assigned to
the translation.
At least one of the following elements must be distinct: ISSN, ISBN, volume, issue, first page.
The original language title should be deposited in the translated article metadata in the <original_language_title>
element.
Assigning separate DOIs to article translations is recommended but optional. Publishers wishing to assign one DOI to an
article and its translations may do so. The DOI response page should contain links to translated versions of the article.
This can be managed by the publisher web site or using Multiple Resolution.
Page 40
Help Site
CrossRef Help
Components
DOIs may be assigned to items that are part of a journal article, book chapter, or any other content item. A component would
typically be a figure, table, or image which is part of or referred to by the parent item. Assigning a DOI to a component allows direct
linking to the component item.
Depositing Components
Components have their own metadata which is separate from that of the parent DOI(s). They may be deposited with the parent DOI
as part of a metadata deposit (schema documentation), or in a separate deposit using the sa_component element in the 4.3.0
schema. Components may belong to more than one parent item. For example, two journal articles may include the same
component DOI.
Sample stand-alone component deposit

Sample journal article deposit containing a component (last article in example)
Querying for Components

Currently there is no support for querying CrossRef to discover components but a list of components belonging to a given (parent)
DOI may be retrieved using an XML query with the list-components attribute set to "true". + show/hide example
Page 41
Help Site
CrossRef Help
Best practices for depositing

Depositing References: all members are encouraged to deposit references. References can be deposited as part of a metadata
deposit or as a reference-only deposit.
Reference by default are not distributed with query results, but can be distributed with publisher consent. Contact
support@crossref.org to enable reference distribution.
Title-level DOIs: members are strongly encouraged to deposit title-level DOIs for journals deposited with CrossRef.
For electronic-only journals, you may want to include an alternate number in lieu of page numbers. In these cases, do not use
the <first_page> tag; instead, use the <item_number> tag with the item_number_type attribute set accordingly:
<item_number item_number_type="article-number">3D9324F1-16B1-11D7-8645000102C/item_number>
First author metadata: Within the <contributors> tag, the first <person_name> or <organization> with an attribute of
"sequence=first" is stored and used to match against queries. For <person_name>, the important value is in <surname> while the
entire value of <organization> is used. Care should be taken to ensure that the entire person's name, or their last name with
initials, are not placed into the <surname> element.
ISSN order: The CrossRef system saves every ISSN associated with a given journal title over the course of several deposits.
However, the first ISSN (print and/or electronic) is what appears in the metadata database (MDDB.XML). A subsequent query using
any of the ISSNs will match all the deposits regardless of which ISSN was associated with a particular item at the time of deposit.
Only one ISSN can be assigned per journal title. Contact support@crossref.org in advance of title or ISSN changes.
DOI makeup: follow DOI suffix pattern guidelines

File Size: Keep deposit file sizes under 1 megabyte (avoids file upload problems)
Large volumes of Deposits: When making a large number of back file deposits, particularly if they include references, contact
CrossRef for queue management support.
Deposit logs: Be sure to examine the submission log file you'll receive via email. If you do not get a log file when expected, you
can review your submissions using the Submission Administration function.
Page 42
Help Site
CrossRef Help
NISO JATS to CrossRef conversion (beta)

We are potentially going to allow members to send NLM / JATS metadata directly to CrossRef. We've prepared a preliminary XSLT
conversion:
NLM.JATS2CrossRef.v1.0.xsl
Please note:
The journal title used for CrossRef deposits be included in the <journal-title element>.
The DOI should be included in <article-id> with attribute pub-id-type='doi'
The DOI URL should be included in <self-uri>
The JATS DTD does not have an appropriate place to include the email element used in CrossRef deposits, this currently needs
to be added manually. When we create the conversion we'll probably allow this to be included as an upload parameter.
Comments are welcome, please email support@crossref.org.
Page 43
Help Site
CrossRef Help
Ancillary metadata
Include NLM/JATS abstracts in deposits

Beginning with schema version 4.3.3, abstracts from JATS XML may be included in CrossRef deposits. A namespace prefix (jats)
must be used for the abstract and all child elements.
Schema declaration:
<doi_batch version="4.3.2" xmlns="http://www.crossref.org/schema/4.3.2" xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation=
"http://www.crossref.org/schema/4.3.2 http://www.crossref.org/schemas/crossref4.3.2.xsd"
xmlns:jats="http://www.ncbi.nlm.nih.gov/JATS1">
Deposit example:
. . .
</person_name>
</contributors>
<jats:abstract><jats:p>We describe a method for cloning nucleic acid molecules onto the
surfaces of 5-μm microbeads rather than in biological hosts. A unique tag sequence
is attached to each molecule, and the tagged library is amplified. Unique tagging of the
molecules is achieved by sampling a small fraction (1%) of a very large repertoire
of tag sequences. The resulting library is hybridized to microbeads that each carry
≈10<jats:sup>6<jats:/sup> strands complementary to one of the tags. About
10<jats:sup>5<jats:/sup> copies of each molecule are collected on each microbead. Because
such clones are segregated on microbeads, they can be operated on simultaneously and then
assayed separately. To demonstrate the utility of this approach, we show how to label and
extract microbeads bearing clones differentially expressed between two libraries by using a
fluorescence-activated cell sorter (FACS). Because no prior information about the cloned
molecules is required, this process is obviously useful where sequence databases are
incomplete or nonexistent. More importantly, the process also permits the isolation of
clones that are expressed only in given tissues or that are differentially expressed
between normal and diseased states. Such clones then may be spotted on much more costeffective, tissue- or disease-directed, low-density planar
microarrays.</jats:p></jats:abstract>
<publication_date media_type="print">
<year>2000</year>
</publication_date>
. . .
Page 44
Help Site
CrossRef Help
Ancillary metadata
Including non-CrossRef DOIs in deposits

Beginning with schema version 4.3.2 (crossref4.3.2.xsd | documentation), publishers may now include non-CrossRef DOIs in
CrossRef DOIs. These DOIs will be deposited as components. This feature allows publishers to deposit journal article or book
DOIs and describe their association to content which has been assigned a DOI by another Registration Agency. Including a nonCrossRef DOI in a deposit does not affect the registration of the DOI with Handle.
For example: a journal article could define a relationship to a database which has been assigned a DOI via DataCite.
When depositing and registering a component DOI with CrossRef, the DOI is enclosed within the <doi_data> element, which also
encloses URL(s) within the <resource> and <collection> elements. Non-CrossRef DOIs should be included within a <doi> tag, the
<doi_data> element is not allowed:
<component_list>
<component parent_relation="isReferencedBy">
<description>Dataset for parent article</description>
<doi>10.5061/xxxxx</doi>
</component>
</component_list>
Components are currently how CrossRef supports the identification of supplemental material. This feature will be
enhanced to reflect terminology and organization defined by the NISO/NFAIS Supplemental Journal Article Materials
Project.
Page 45
Help Site
CrossRef Help
Ancillary metadata
Depositing Access Indicators

Members may include access indicators (most commonly license information) in deposits. An additional element (<ai:program>)
has been added beginning with schema version 4.3.2 to support the Access Indicators schema (AccessIndicators.xsd).
License information metadata collected includes:
license URL element (license_ref)

start_date attribute, optional, date formated YYYY-MM-DD
applies_to attribute, optional, allowed values are:
vor (version of record)
am (accepted manuscript)
tdm (text mining)
Access Indicators may be included in a metadata deposit or submitted as a resource deposit, and may be included with CrossMark
metadata where applicable.
Sample metadata deposit:

<year>2013</year>
</publication_date>
<pages>
<first_page>13</first_page>
</pages>
<crossmark>
<ai:program name="AccessIndicators">
<ai:license_ref applies_to="vor"
start_date="2011-02-11">http://www.crossref.org/license</ai:license_ref>
</ai:program>
</crossmark>
<doi_data>
<doi>10.5555/openAI_test2</doi>
<resource>http://www.crossref.org/test</resource>
</doi_data>
Page 46
Help Site
CrossRef Help
Ancillary metadata
As-crawled URLs
CrossRef metadata is often distributed to search engines and other crawler-based services that index the full text of content on a
publisher's site. For some publishers the URL associated with the DOI is appropriate for crawling, meaning the publisher's platform
recognizes the crawler's incoming request and responds by supplying the appropriate content. If a DOI URL isn't crawler friendly, a
publisher may supply a specific URL to the indexing service by depositing as-crawled URLs.
A substantial advantage for an indexing service is the ability to associate the DOI of the item with the location at which it was
indexed. Search services often index content by where it was found (URL) which may not be a stable/reliable key. Adding the
DOI as an index key adds stability.
Depositing as-crawled URLs

Publishers wishing to deposit 'as-crawled' URLS will be required to use the CrossRef deposit schema or DOI resource schema. With
either schema the as-crawled URLS are specified using a <collection>. The schema provides a list indexing services. The property
attribute of the <collection> tag must be set to 'crawler-based'. The crawler property of the <item> tag is set to identify the
indexing service as demonstrated in the examples below.
URL only deposit: if a DOI has already been deposited, add as-crawled URLs to the existing metadata with a URL-only deposit. +
show/hide example
Metadata deposit with as-crawled URLs: as-crawled data is included in the <doi_data> element + show/hide example
URL updates for CrossCheck indexing should set the value of the crawler attribute to iParadigms (<item
crawler="iParadigms">)
Page 47
Help Site
CrossRef Help
Queries & retrieving metadata
How to query
Queries may be submitted via HTTP POST or GET or (in small batches) through the system interface. Most queries are formatted as
XML. XML queries allow significant control over the matching process Transactions are performed using HTTP GET or POST (batch
queries).
The following is an example of a journal XML query: + show/hide
HTTP queries
This process is described in detail in Using HTTP to Query. Some rules of thumb:
Synchronous queries using HTTP GET should be limited to less than 5-10 queries per request
The response time for an HTTP GET query with one query in the request is generally under 1 second
Batch queries
CrossRef supports a batch upload feature to accomodate large query volumes. Query files are uploaded to the CrossRef system
where they will wait in a queue for processing (similar to the deposit process). Files can contain either metadata formatted using
our query input schema (schema | documentation) or DOI queries (but not a mix). Uploaded query files should be less than
150KBytes in size.
When the queries are processed, the results are emailed to the address supplied in the query XML. Users may request that their
CrossRef account be configured so that the email results notice contains a link to the result file which would subsequently be
downloaded by the user. This avoids problems associated with large email files.
Query results
You may request the system to return query results in a number of formats. See Query Results for more information.
User-friendly query tools are also available.
Page 48
Help Site
CrossRef Help
Controlling query execution

Many query elements have optional properties that control how a query is executed by the system. The CrossRef query engine
operates by evaluating several logic rules in series. Each rule focuses on certain fields in the query with the first rule processing the
entire query. If any rule returns a single DOI as its output, this DOI is taken as the result for the query, and rule processing
terminates.
Query control attributes are described in detail in the table below. These controls include:
Match: use to specify level of fuzzy or exact matching. This attribute may be applied to several elements (ISSN, author, issue,
article_title)
Enable-multiple-hits: allows or prevents matches returning more than one DOI
Secondary-query: instructs the system to perform a specific query if the default query mode does not produce a result.
Current options include author/title, multiple hits, and author/title multiple hits.
Element attribute values

Element
query
Property
Value
Purpose
key
string
to track a query to its results
enable-multiple-hits
false (default)
have the system reduce the query to one DOI and return nothing if
it can not do so
true
have the system return one DOI for each query rule it executes
multi_hit_per_rule
have the system return many DOIs for each query rule it executes will produce up to 50 candidate DOIs which partially match the
query
exact
forward-match
list-components
expanded-results
secondary-query
false (default)
No query is stored
true
Stored this query and re-run it automatically and notify via email
any matches that are found
false (default)
Components not included in results
true
list the DOIs of any components that have deposited which are
linked to this DOI
false(default)
true
include article title in the results (only applicable when results

format=XML_XSD)
author-title
perform author-title search if metadata search fails
multiple-hits
returns multiple hits (if present)
author-title-multiple-hits performs author/title and multiple hits search if initial search fails
issn
match
journal_title
author
match
optional
value may be missing from deposited metadata
exact
match exactly as it appears in the query
optional
not required
fuzzy(default)
use fuzzy string matching
exact
optional
instructs the query engine that this field may be ignore.
fuzzy (default)
use fuzzy string matching
null
match if author is missing in the metadata
exact
Page 49
Help Site
CrossRef Help
Element
issue
Property
Purpose
fuzzy(default)/exact
-- see above --
first_page
-- see above --
year
optional(default)/exact
-- see above --
-- see above --
article_title
match
Value
match
Page 50
Help Site
CrossRef Help
Allowing multiple hits

The CrossRef query engine operates by processing many different rules in series. Normally if the output of any rule is a single
DOI, processing terminates and that DOI is returned as the result of the query. If no rule can produce only one DOI the query fail
results (its results are an ambiguous set). This behaviour is necessary because most processes querying CrossRef are automated
and are incapable of deciding what to do with multiple DOI records.
However, in an editorial environment where a person is involved, getting multiple results may be valuable if the system is unable to
reduce the match to a single item.
To enable the CrossRef system to return more than result, set the enable-multiple-hits attribute for query to ''true", "exact" or
"multi_hit_per_rule" for a given query item.
To retrieve a candidate list of DOIs use the enable-multiple-hits attribute:
<query key="key" enable-multiple-hits="true/false/multi_hit_per_rule/exact">
Each option invokes the following responses:
True: Instructs the query function to return the single DOI produced by all the various rules. The output of a rule that
produces more than one DOI will not be included.
MULTI_HIT_PER_RULE: Instructs the query engine to return all DOIs uncovered by each rule.
Exact: Disables the normal rule processing and instructs the query engine to perform a simple comparison to the query
values and return all DOIs that match (up to a limit of 40).
Page 51
Help Site
CrossRef Help
Secondary queries
The CrossRef query engine operates by processing many different rules. By default, all metadata provided in a query is used to
generate a match, and a match is only returned if one DOI is present. Enabling a secondary query instructs the query engine to
perform specific searches when the initial search fails to find a match.
Author/title secondary query

Queries by default use all metadata present in the request. Requests with only an author and title are treated as author/ article title
queries. When other fields are present, the request is submitted as a metadata search.
Setting the secondary-query attribute to "author-title" causes an author/title search to be performed when the initial metadata
search fails to produce a result.
<query key="cit-3" enable-multiple-hits="true" secondary-query="author-title">

<issn>0360-3016</issn>
<volume>54</volume>
<issue>2</issue>
<year>2002</year>
<author>Kim</author>
<article_title match="fuzzy">Potential radiation sensitizing effect of SU5416 by downregulating the COX-2 expression in human lung cancer cells</article_title>
</query>
An author/ article title query will only be performed if both author and article title are included in the query.
Multiple hits secondary query

By default, the query engine will only return a result if a single DOI is found. Queries returning multiple results (or hits) are
unresolved. Setting the secondary-query attribute to "multi-hit" instructs the query engine to return all available results.
<query key="cit-3" secondary-query="multiple-hits">

<issn>0360-3016</issn>
<volume>54</volume>
<issue>2</issue>
<year>2002</year>
</query>
This option can also be performed by setting attribute enable-multiple-hits to "true"
Author/title multiple hits secondary query

Setting the secondary-query attribute to "author-title-multiple-hits" instructs the query engine to perform an author/title query and
return multiple hits if the initial search fails.
<query key="cit-3"
enable-multiple-hits="true" secondary-query="auhtor-title-multiple-hits">
<issn>0360-3016</issn>
<volume>54</volume>
<issue>2</issue>
Page 52
Help Site
CrossRef Help
<year>2002</year>
</query>
Secondary query results

Query results will specify which method was used to return the result. Successful metadata searches will specify "metadata":
<query key="cit-3" status="multiresolved" fl_count="0" query_mode="metadata">
Queries resolved by the secondary author/title query will specify "author-title":
<query status="resolved" fl_count="0" query_mode="author-title">
Queries with multiple hits will have a status of "multiresolved">
<query status="multiresolved" query_mode="metadata">
Page 53
Help Site
CrossRef Help
DOI-to-metadata query
Metadata may be retrieved for all CrossRef DOIs. Most DOI-to-metadata queries are done via HTTP using synchronous HTTP
queries but may also be submitted as asynchronous batch queries or (for non-technical users) via a web form.
Sample HTTP Queries:

http://doi.crossref.org/search/doi?pid=<EMAIL or USERNAME:PASSWORD>&format=unixsd&doi=<DOI>
http://doi.crossref.org/servlet/query?pid=<EMAIL or USERNAME:PASSWORD>&format=unixref&id=<DOI>
Open URL query:

CrossRef supports DOI queries formatted as OpenURL version 0.1 requests.
http://www.crossref.org/openurl/?pid=<EMAIL>&format=unixref&id=doi:10.1577/H02-043&noredirect=true
For complete metadata (UNIXREF format), submit your request with format="unixref"
Results:
Default (xsd_xml) format + show/hide
UNIXREF format + show/hide
DOI-to-metadata XML Batch Query:

DOI-to-metadata queries can also be performed using XML, allowing use of control features available only with XML queries. See
Querying with XML for details.
Sample XML query + show/hide
Page 54
Help Site
CrossRef Help
Author / article-title query

The CrossRef system now supports a query mode where only article title and/or first author surname are required. These queries
can be performed using an XML query.
Example: XML author / article-title query
...
<query enable-multiple-hits="false" key="key1">
<article_title match="fuzzy">Concluding remarks</article_title>
<author search-all-authors="true">Somiari</author>
</query>
<query enable-multiple-hits="false" key="key1">
<article_title match="fuzzy">Off-line Approaches</article_title>
<author search-all-authors="true">Gustafsson</author>
</query>
...
When performing a bulk upload using HTTP POST, the value of the HTTP parameter operation must be doQueryUpload (please
see Using HTTP to POST files).
This service by default returns only one DOI record per query. As with other metadata queries if the system finds more than
one possible DOI the results are considered ambiguous and thus no results are returned. The user may override the one result
rule and request that multiple hits may be returned.
When performing XML queries, an author-title query may be submitted as a secondary query if the initial full metadata query is
unsuccessful.
Only the <author> and <article_title> elements should appear in an author / article title query - if other elements are present,
the query will be performed as a full metadata query.
Page 55
Help Site
CrossRef Help
Querying with formatted citations

Formatted citations are sometimes referred to as "plain text references." For example, an APA formatted citation for the DOI
10.1038/nclimate1398 is:
Hungate, B. A., & Hampton, H. M. (2012). Ecosystem services: Valuing ecosystems for climate.
Nature Climate Change, 2(3), 151-152. http://dx.doi.org/10.1038/nclimate1398
CrossRef has two interfaces that can be used for making formatted citation queries:
Simple Text Query (STQ): tool which allows a user to cut-and-paste references into an interactive form and receive instant
results or to upload a text file and receive HTML format results via email.
CrossRef API: supports two options:
1. HTTP Get: When enabled, this option accepts XML queries that may contain formatted citations. + show/hide example
2. HTTP Post: A file upload service which accepts an XML file and returns results via email. This option is only available to
CrossRef members and affiliates. + show/hide example
Using HTTP to Query, Using HTTP to POST Files (Upload)
CrossRef has two distinct servicing technologies (mutually exclusive) that support these interfaces: eXtyles RefXpress (a tool
licensed from Inera, Inc.), and Formatted Citation Search (FCS).
eXtyles RefXpress
RefXpress is a powerful citation parser, meaning citations are broken up into their parts (publication title, author, volume, issue,
page, publication date, etc.). These parts can then easily be transformed into an XML query. Usage limits are in place, see Use
Options below.
Formatted Citation Search

This option is a full-text-search technique- citations are not parsed into parts. Instead, the citation as a whole is compared against
CrossRef's repository of publication meta-data. The Formatted Citation Search handles basic citations very well but accuracy is not
guaranteed. Results from Formatted Citation Search must be evaluated to ensure accuracy.
CrossRef pays no transaction fees for the use of the FCS technology and therefore unlimited use is permissible.
Use Options
RefXpress usage: As much as is possible CrossRef's goal is to meet our user's needs. The STQ tools backed by RefXpress meets
the needs of nearly all individuals and many very small publishers. CrossRef licenses RefXpress from Inera and pays a per
transaction fee and therefore is not able to provide unlimited free access to CrossRef STQ or API users.RefXpress is the default
back-end used by CrossRefs Simple Text Query tools. Queries are limited to 1,000 per month for each registered email account.
In some cases additional free usage may be made available or arrangements may be made to provide metered service for a fee.
RefXpress may also be enabled for use via the HTTP API for CrossRef members but usage limits will have to be enforced. Contact
support@crossref.org for details.
Please do not create/register multiple email accounts to circumvent this measure. CrossRef monitors activity and may
block querying for abusers or direct STQ activity to the FCS servicing technology.
Formatted Citation Search usage: Any CrossRef user (members or registered email accounts) may ask to use the API or STQ
interfaces with the FCS technology. Please contact support@crossref.org to have this permission enabled on your account.
Page 56
Help Site
CrossRef Help
Querying with special characters

The CrossRef system does perform some fuzzy matching but for best results, when the deposited metadata for a
DOI has special characters, queries for the DOI should also include special characters.
Example: DOI 10.1260/095830506778119452 was deposited with the metadata shown below. Notice that the first author
surname (mon) has a numerical character entity, in this case the character .
+ show/hide example
If we formulate a query that does not include page number we must include the author using the entity
and not some other form of character, for example:
No match:
<query key="mykey" enable-multiple-hits="false">

<journal_title>Energy & Environment</journal_title>
<author>mon</author>
<volume>17</volume>
<issue>3</issue>
<year>2006</year>
</query>
No match:

<author>amon</author>
<volume>17</volume>
<issue>3</issue>
<year>2006</year>
</query>
Match found:

<author>ámon</author>
<volume>17</volume>
<issue>3</issue>
<year>2006</year>
</query>
Page 57
Help Site
CrossRef Help
Querying for books

Book chapter query: a query which will return the DOI for a single chapter in the specific title: + show/hide example
Searching for individual chapters within a book may also be done by using just the author name and chapter title (author name
is optional but should be included for better results): + show/hide example
Book title query: The deposit for this book also created a DOI for the book itself which can be found with a query containing the
book's editor: + show/hide example
Book title query without author:Many title-level book DOIs do not have author information deposited. If you do not have author
information to include in your query or you are querying for an authorless book, for best results your query should instruct the
system to ignore author by setting the author match attribute to null. + show/hide example
Page 58
Help Site
CrossRef Help
XML Query Samples
Book queries: See Querying for books
Cited-by queries
An XML query to obtain a list of cited-by articles (forward links): + show/hide example
This query can only be performed by the owner of the cited article.
Controlling query result XML

CrossRef query results can be retrieved in several formats (see Query Results). By default the XSD_XML format will only contain
basic bibliographic metadata. Setting expanded-results to TRUE will also return the article title.
This example shows use of this property along with multiple hits: + show/hide example
The system will return no DOIs if an ambiguity exists. Setting enable-multiple-hits to "true" instructs the system to return
the list of DOIs.
Searching all authors

Normally the author name supplied in a query must be that of the article's 'first' author. First author is an optional designation
made by the publisher when depositing a DOI's metadata. Articles deposited without a 'first' author designation handicap queries
that depend on author (e.g. do not supply a page number) In an XML query there is a property called search-all-authors which
forces the process to examine all authors associated with the article.
This example shows a query that would not return any results if this feature were not used: + show/hide example
Reverse metadata query

Retrieve metadata for a DOI: + show/hide example
Page 59
Help Site
CrossRef Help
Best practices for querying

Journal Titles & ISSN - One of the most powerful features of the CrossRef system is its fuzzy matching processes. Consequently
we strongly encourage the use of journal title as an identifier instead of ISSN. Queries that supply only ISSN tend not to resolve as
well as those that supply just journal title or both title and ISSN. ISSN is essentially treated as a number resulting in the need to
perform an exact match on the text string representation. Very little normalization can be done. Title however is a very complex
value that can be normalized in several ways giving the matching function more options as it seeks to locate the proper DOI.
Use XML - XML is the preferred format to use when sending queries into the CrossRef system. This format is more precise, offers
more functionality and is extensible. All new query features will only be offered through the XML format. Support of the legacy
pipe'd format will continue but it will not be extended. See Querying with XML.
Include complete metadata - include all available metadata in your query whenever possible.
Page 60
Help Site
CrossRef Help
Query results
Query results
CrossRef supports a number of formats for query results:
UNIXSD: (corresponding schema) contains as-deposited metadata and meta-metadata for the DOI (information about the DOI such
as current prefix owner, date of last update, cited-by count).
UNIXREF: (corresponding schema) UNIXREF returns the exact data submitted by the publisher of the DOI.
XSD_XML: returns very basic citation metadata. XSD_XML is currently the default format. This format may be deprecated in the
future.
A list of DOIs by title may be retrieved using format=doilist, details are available here.
References for a given article (if deposited) are only included in results when permitted by the DOI owner. References are
always included when querying for content you own.
Page 61
Help Site
CrossRef Help
Query results
UNIXSD query result format

CrossRef's UNIXSD query result format combines the status features available in the XSD_XML format with the full publisher records
received in the UNIXREF format. In addition, UNIXSD has namespace declarations which are not available in UNIXREF.
The body of the UNIXSD query result is broken into two sections:
1. Immediately following the <query> will be a sequence of CrossRef produced meta-metadata for the DOI. + show/hide
example
2. Publishers as-deposited XML will begin with the <crossref> element. (This is the same as the <crossref>element in the
UNIXREF format). + show/hide example
The meta-metadata describes attributes of the DOI that are produced by the operation of the CrossRef system and should be
interpreted as augmenting the publisher's metadata.
+ show/hide full UNIXSD response
UNIXSD schema
UNIXSD results are generated using crossref_query_output3.0.xsd (schema | documentation)
This query format was introduced April 2012. All users should migrate towards using the UNIXSD as it will become the
default query result format.
CrossRef members may now elect to include deposited references in UNIXML query results as well as OAI-PMH results.
This feature is managed on a prefix basis. Contact support@crossref.org if you would like reference distribution enabled
for your prefix(es).
Page 62
Help Site
CrossRef Help
Query results
UNIXREF
CrossRef's Unified XML format (UNIXREF) returns the exact data submitted by the publisher of the DOI. This differs from other query
result formats, which return data that has been processed by the CrossRef system.
The UNIXREF format will return deposited citations if the depositing publisher has enabled reference distribution for their prefix.
Citations will also be returned to members querying for their own deposited data.
UNIXREF schema
The majority of UNIXREF results use the unixref1.1.xsd schema (schema | documentation). Some results involving book or
conference proceeding data deposited prior to a deposit schema change use unixref1.0.xsd (schema | documentation).
Page 63
Help Site
CrossRef Help
Query results
Error messages for malformed queries

Possible errors returned by malformed or insufficient queries include:
Either first page or author must be supplied.

Either ISSN or Journal title must be supplied.
unreasonable DOI found
* an 'unreasonable DOI' does not follow the expected DOI format (10.XXXX/yyy..) and/or exceeds 200 characters.
Piped Query must contain either 9 (for journals) or 11 (for books/conference proceedings) pipes.
Either ISSN/ISBN or Series/Volume title must be supplied.
Page 64
Help Site
CrossRef Help
Storing queries to get future results

If the CrossRef system can't find a suitable match for a query, it returns a result of "unresolved." In this case, you can resubmit the
same query at a later time, or you can instruct the CrossRef system to store your query and email results if a match is found.
For example, suppose you are querying to find a particular article in an issue of a journal but the journal's publisher is not a current
CrossRef member or has not deposited that issue yet. Initially, the CrossRef system returns a result of "unresolved." Three weeks
later, the publisher deposits the article you were looking for. The CrossRef systems sends an email that includes the query results
to the address included in the query.
Stored queries are enabled by setting a forward-match attribute for each query item. To set the forward-match attribute, use this
format:
<query key="key" forward-match="true">

The combination of the submitterID, doi_batch_id, and key in the query must be unique in order for forward matching to work.
Stored query process

1. A query is submitted with the forward-match attribute set to "true": + show/hide example
2. The response to the query contains a status of 'unresolved' (no DOI found) and the query is stored: + show/hide
example
3. A match is found after the initial query, an alert email is sent out to the email address provided in the initial query XML: +
show/hide example
Polling for stored query results

You can also retrieve a list of stored queries that resolved within a specific date range using the following URL:
http://doi.crossref.org/servlet/downloadStoredQueries?usr=<USERNAME>&pwd=<PASSWORD>&startDate=<FIRSTDATE>&
endDate=<LASTDATE>
where:
usr is your CrossRef-supplied login name.

pwd is your CrossRef password.
startDate is the first date in the range (inclusive) and in the format yyyy-mm-dd.
endDate is the last date in the range (inclusive) and in the format yyyy-mm-dd.
The result is returned in XML format based on the CrossRef query schema. + show/hide example
Page 65
Help Site
CrossRef Help
Deprecated query formats

CrossRef currently supports but does not recommend use of the following legacy formats:
XSD_XML
Piped Queries
Piped Queries: author / article title
XSD_XML
The XSD_XML format follows the CrossRef query output schema. It provides basic metadata that has been processed by the
CrossRef system.
Processed vs. un-touched DOI metadata

When deposits are made to CrossRef the metadata is subject to two parallel tracks of processing. One writes the data, untouched
by any modification, to a database record associated with the DOI name. The other processes the metadata in a way that better
supports the query engine operation. This processing may modify values by separating alpha and numeric characters. One key area
of processing involves publication title and ISSNs. In order for the query engine to work effectively DOI names are grouped
according to the publication to which they belong. This is done based on the publication title. Consequently the CrossRef system
has a limitation regarding which ISSNs are associated to a given title. The system takes the first print and first electronic ISSNs and
binds them to the publication title. Subsequent ISSNs received with DOI names for this publication will be stored as 'other ISSNs'
and will not be returned in the query results for any DOI belonging to this publication. These ISSN values are used to improve the
query matching function but can be incorrect values when returned in query results. CrossRef administrators are able to manually
correct this when errors occur.
Examples:
The two examples below show data for the same DOI (10.1664/0028-7199(2004)112[0183:ANSOMK]2.0.CO;2). The XSD_XML
example shows the effect of adding expanded-results="true" to the query. In the UNIXREF example a partial list of citations for this
article (its bibliography) is also shown.
this would only happen if the user making the query was also the publisher who owned the DOI, or if the publisher had
enabled citation distribution. Citation lists are not currently given out by CrossRef to all query users.
XSD_XML Format
Without expanded results: + show/hide example

With expanded results: + show/hide example
with list-components set to true: + show/hide example
Page 66
Help Site
CrossRef Help
UNIXREF Format:
+ show/hide example
Piped queries
Content in CrossRef is stored according to genre since variations exist in the structure of references to these different kinds of
content. Consequently, piped queries come in two types: a 10 field query used to search journal or conference proceeding DOIs and
a 12 field query used to search conference proceedings or book/reference DOI names.
Since conference proceedings often have metadata identical to journal articles but may have metadata similar to books
both types of piped queries search against this genre.
A piped query must include either a starting page number, the author's last name, or both. If a query contains neither field, the
CrossRef system will reject it.
Piped queries are written one per line. If more than one query is to be submitted in a single request they should be separated by a
new line character (*n or %0A). The recommended maximum query batch size is 30 queries for synchronous, or interactive
Page 67
Help Site
CrossRef Help
queries. For queries that are uploaded for asynchronous processing the maximum is limited by file size which should be kept under
1 Megabyte.
A piped query may also be used to perform a 'reverse lookup', aka DOI namequery, which retrieves metadata for a known DOI
name.
Field descriptions:
* ISBN, ISBN/ISSN: Journal, book or conference proceedings ISBN or ISSN
* TITLE: journal title or abbreviation
* SER_TITLE: The serial title.
* VOL_TITLE: The book title.
* FIRST AUTHOR, AUTHOR/EDITOR: First Author surname.
* VOLUME: Book/Conference proceedings volume
* EDITION_NUMBER: Edition number for the book or conference proceeding (e.g. 3)
* PAGE: First page.
* YEAR: Year book or conference proceedings was published.
* COMPONENT_NUMBER: Chapter, section or part inside the book/conf. proceeding (e.g. Section 3)
* DOI: The DOI, left blank in the query
* RESOURCE_TYPE: The resource type (full_text, abstract_only or bibliographic_record)
* KEY: submitted buy the user to track queries (e.g. echoed back in the corresponding query result)
10 field query
The fields appear in this order:
ISSN|TITLE/ABBREV|FIRST AUTHOR|VOLUME|ISSUE|START PAGE|YEAR|RESOURCE TYPE|KEY|DOI
Examples:
1. A query using an abbreviated journaltitle
Query: |Biol J Linn Soc|Hardy|64|2|239|1998||MyKey1|
Results: 00244066,10958312|Biological Journal of the Linnean
Society|HARDY|64|2|239|1998|full_text|MyKey1|10.1006/bijl.1998.022
2. This query contains an ISSN instead of a title or abbreviated title:
00244066||Hardy|64||239|1998||MyKey2|
3. Here, only the title, author, starting page, and year are passed.
|Biol J Linn Soc|Hardy|||239|1998||MyKey1|
4. Here a several piped queries together:
|Trends Ecol Evol|Murcia|10||58|1995||k1|
|Urban Ecosyst|Jokimki|3||21|1999||k2|
|Science|Maniatis|278||818|1997||k3|
|Annu Rev Immunol|Baeuerle|12||141|1994||k4|
|Proc Natl Acad Sci USA|Miagkov|95||13859|1998||k5|
|Lancet|Bonn|351||1710|1998||k6|
Page 68
Help Site
CrossRef Help
|N Engl J Med|Barnes|336||1066|1997||k7|
Results:
01695347|Trends in Ecology & Evolution|Murcia|10|2|58|1995|full_text|k1|10.1016/S0169-5347(00)88977-6
10838155,15731642|Urban Ecosystems|Jokim?ki|3|1|21|1999|full_text|k2|10.1023/A:1009505418327
00368075,10959203|Science|Maniatis|278|5339|818|1997|full_text|k3|10.1126/science.278.5339.818
|Annu Rev Immunol|Baeuerle|12||141|1994||k4|
00278424,10916490|Proceedings of the National Academy of
Sciences|Miagkov|95|23|13859|1998|full_text|k5|10.1073/pnas.95.23.13859
01406736,1474547X|The Lancet|BONN|351|9117|1710|1998|full_text|k6|10.1016/S0140-6736(05)77753-9
00284793,15334406|New England Journal of Medicine|Barnes|336|15|1066|1997|full_text|k7|10.1056/NEJM199704103361506
The query with Key k4 did not match any DOI. In query 'k5' the results contain two ISSNs, the first is for the print journal
while the second is for the online edition. Notice the problem with the author name in 'k2'. Here the special character in the
query (small a with diaeresis) was not handled properly by the browser , whose default character set was UTF-8. XML queries
and result formats are better suited to handle special characters.
12 field query
The fields appear in this order:
ISBN/ISSN|SER_TITLE|VOL_TITLE|AUTHOR/EDITOR|VOLUME|EDITION_NUMBER|PAGE|YEAR|COMPONENT_NUMBER|RESOURCE_TYPE|K
EY|DOI
Examples:
1. Several book queries shown together

Query:
|IEEE Press Series on Digital & Mobile Communication|Theory of Code Division Multiple Access
Communication|Zigangirov|||137|2004|||| ||Physical Chemistry of Macromolecules|Sun|||267|2004|||| |Contributions to
Nephrology|Nutritional and Acid-Base Aspects of Amino Acid Metabolism|Lardner|121||117|1997|||| |Methods in
Enzymology|Carotenoids Part B Metabolism Genetics and Biosynthesis|LAKSHMAN|214||256|1993||||
Results:
0471457124,0471 0471457124,047165549X|IEEE Press Series on Digital & Mobile Communication|Theory of Code Division
Multiple Access Communication|Zigangirov|||137|2004||full_text|k1|10.1002/047165549X.ch4
0471281387,0471623571||Physical Chemistry of Macromolecules|Sun|||267|2004||full_text|k2|10.1002/0471623571.ch12
3805564902|Contributions to Nephrology|Nutritional and Acid-Base Aspects of Amino Acid
Metabolism|Lardner|121||117|1997||full_text|k3|10.1159/000059861
00766879,0121821153|Methods in Enzymology|Carotenoids Part B Metabolism Genetics and
Biosynthesis|LAKSHMAN|214||256|1993||full_text|k4|10.1016/0076-6879(93)14070-Y
Page 69
Help Site
CrossRef Help
Author / article title piped query

The CrossRef system supports a query mode where only article title and/or first author surname are required. These queries can be
performed using the piped or XML formats.
Example: HTTP request with piped author/title query
The query type must be set to a (for article/author), otherwise the request will be considered a malformed metadata query.
http://doi.crossref.org/servlet/query?usr=%3cusername%3e&pwd=%3cpassword%3e&type=a
&format=unixref&qdata=Offline+Approaches|Gustafsson||key|
Example: piped bulk (asynchronous) query
These queries may also be submitted in bulk (asynchronous) using our batch upload feature. The uploaded file should be formatted
with a header containing the email address to which the results will be sent followed by one query per line as shown here.:
H:email=youremail@publisher.org
Concluding remarks|Somiari||key1|
Off-line Approaches|Gustafsson||key2|
Monoclonal antibodies to feline sarcoma|Veronese||key3|
When performing a bulk upload using HTTP POST, the value of the HTTP parameter operation must be doQueryUpload (please
see Using HTTP to POST files).
Page 70
Help Site
CrossRef Help
Retrieving DOI info-metadata

CrossRef system-specific information about a DOI may be retrieved by including the appropriate parameters in the following URL:
http://doi.crossref.org/search/doi?pid=<USERNAME:PASSWORD>&format=info&doi=<DOI>
This data is distinct from item metadata deposited for each DOI, and includes information such as timestamp, owner prefix, and
primary/alias status.
Sample info-metadata:
DOI: 10.2353/jmoldx.2009.090037
CITATION-ID: 39306481
JOURNAL-TITLE: The Journal of Molecular Diagnostics
JOURNAL-CITE-ID: 58207
BOOK-CITE-ID:
SERIES-ID:
DEPOSIT-TIMESTAMP: 20110701073812000
OWNER: 10.1016
LAST-UPDATE: 2011-07-04 21:13:59
PRIME-DOI: none
A list of DOIs for a title may be retrieved using format=doilist, details are available here.
Page 71
Help Site
CrossRef Help
Bulk metadata formats

CrossRef will distribute the entire metadata repository to CMS subscribers. The data is made available using two transaction
models. Each model produces a slightly different format of data.
FTP/HTTP of ZIP Archives

In this model CrossRef produces an XML file for each title containing all DOIs for that publication. The files are built to the CrossRef
output schema (schema | documentation).
CrossRef runs daily and weekly processes that create files containing new or updated DOIs during these periods. The files are then
combined into a compressed archive (Zip'd Unix tar files). The archives are stored in a set of 7 daily folders, named day0 through
day6, and 4 weekly folders, named week0 through week3. After 7 days the daily runs reuse the
folders overwriting the older daily data while after 4 weeks the weekly run overwrites the oldest weekly data. A control file is used
to indicate to which folders the most recent runs wrote their data. In addition, once a month a 'full' run is made that produces a file
for each title that contains all DOIs, regardless of when they were deposited or last updated.
In the XML <publication> element the attribute 'filedate' defines the date when this data was created and the attribute 'mode'
defines the production mode as daily,weekly or full. On each <doi_element> record the attribute 'citationid' is an internal database
key used for the DOI and 'datestamp' is the date when the DOI was deposited or last updated (useful in weekly or full mode)
CMS Basic for additional information and sample data
OAI-PMH
OAI-PMH is a protocol for metadata harvesting and a full description is available at www.openarchives.org. To summarize, this
protocol defines a set of HTTP requests that allow a harvester to interact with a repository to pull selective metadata or all available
data. Normally, an OAI-PMH compatible repository provides free and open access to its data. CrossRef however has implemented
an access control mechanism based on recipients and their IP address. Each recipient must be registered with CrossRef. CrossRef
member publishers may choose to opt-out for a given recipient. The publishers may also choose to opt-out/opt-in on a title by title
basis, making a subset of their metadata available to the specific recipient.
By default all members are set as opt-in, including all titles. When CrossRef is made aware that a new recipient intends to subscribe
to the PMH service a window of time will be allowed for members to decide to opt-out, if they take no action the default opt-in
settings will be applied.
Dublin Core (DC) is the standard format for metadata distribution by a PMH compliant repository. However, DC is not expressive
enough to represent the full metadata available in CrossRef. While DC is not currently support by CrossRef's PMH interface we will
likely add support in the near future to achieve compatibility with the specification. Our PMH currently generates data formatted
using our Unified XML schema (schema | documentation).
Each record retrieved through the PMH interface will have the complete metadata as deposited by the publisher for that DOI.
CrossRef's repository supports a two level hierarchical set organization. At the top level are the publisher sets where the set
identifier is the DOI prefix for the publisher. The next level is the publication title level where the set identifier is an internal value
assigned by CrossRef for the publication.
All PMH identifiers are DOIs expressed using the IETF RFC 4452 "The 'info' URI Scheme for Information Assets with Identifiers in
Public Namespaces" (see the info-uri registry).
CMS Enhanced for additional information and sample data
Page 72
Help Site
CrossRef Help
Retrieving DOIs by title

A list of DOIs by title may be retrieved using the following format:
http://doi.crossref.org/search/doi?pid=<LOGIN>&format=doilist&pubid=<content type><PUBID>
where:
pid = CrossRef system login or query services email address

content type = J for journals, B for books or confererence proceedings, S for series
pubid = publication ID
for example:
http://doi.crossref.org/search/doi?pid=your@email.com&format=doilist&pubid=J173705
The results returned match the title detail results from the depositor report, and include a list of all DOIs for the title, the owner
prefix for each DOI, the timestamp used in the most recent deposit, and the data the DOI was last updated.
Page 73
Help Site
CrossRef Help
Publication IDs
Every publication in the CrossRef system is assigned a unique publication ID. These are used mostly for internal purposes, but may
be useful when retrieving data in bulk or identifying a specific title.
Publication IDs may be retrieved via the following:
OAI-PMH
An OAI-PMH ListSets request will return titles and publication IDs for journals, books, conference proceedings, and series-level data:
http://oai.crossref.org/OAIHandler?verb=ListSets
http://oai.crossref.org/OAIHandler?verb=ListSets&set=B
J (journal) is the default set, set=B must be specified to retrieve book or conference proceeding titles, S for series-level titles. Sets
may be further limited by publisher prefix, details are available in Using OAI-PMH.
The publication ID is listed within the <setspec> element, after the set and publisher prefix. For example, within the following set,
24 is the publication ID for Journal of Clinical Psychology:
<set>
<setSpec>
J:10.1002:24
</setSpec>
<setName>
Journal of Clinical Psychology
</setName>
</set>
Browsable title list

The Browsable title list includes the publication ID next to each title in the search results, select
to reveal the ID.
For most purposes, publication IDs are always preceded by the publication type (J, B, or S)
Page 74
Help Site
CrossRef Help
Maintaining & working with DOIs
Building URLs for DOIs containing special characters

Some characters require special treatment in outbound DOI links.
Encode the pound (#) character using %23. For example, use:
http://dx.doi.org/10.1002/(SICI)1521-3951(199911)216:1<135::AID-PSSB135>3.0.CO;2-%23
instead of:
http://dx.doi.org/10.1002/(SICI)1521-3951(199911)216:1<135::AID-PSSB135>3.0.CO;2-#
Encode the left bracket or less than symbol (<) as $lt; and the right bracket or greater than symbol (>) as >.
Do not encode the forward slash (/) character.
Establishing a DOI suffix pattern
Page 75
Help Site
CrossRef Help
Updating URLs
A URL-only update can be performed without resubmitting metadata using a simple tab-separated list of DOIs and their new URLs.
Sample update file:
H:email=support@crossref.org;fromPrefix=10.5555;toPrefix=10.5555
10.5555/doi1 http://www.crossref.org/newurl1
Submit the update file with a CrossRef Support ticket, or email the update file to support@crossref.org.
A list of DOIs for a title may be retrieved using format=doilist, details are available here.
Page 76
Help Site
CrossRef Help
Updating DOIs and metadata

Once an article's metadata has been deposited with CrossRef, you may update it as often as you want at no additional fee. When
making an update you must supply all the metadata for the article, not just the fields that need to be changed. During the update
process the CrossRef system completely overwrites the existing metadata with the information you submit, including inserting null
values for any fields not supplied in the update.
To update DOIs and metadata, deposit the updated information in the same way that you would deposit any other DOI or metadata.
Be sure to supply the correct DOI name in your submission to ensure that the CrossRef system updates the appropriate content
item.
When updating a deposit, be sure to increment the timestamp value to avoid deposit errors.
Page 77
Help Site
CrossRef Help
Updating DOIs during platform transfers

Most updates occur on a title-by-title basis. Occasionally members need to update DOI URLs for all their content. In practice this
works like a URL-only update, but since multiple titles and sometimes prefixes are involved, migrations can be complex. DOIs are
updated at a rate of 1 DOI per second. Massive updates (>1,000,000 DOIs) may take up to a week to complete, so plan
accordingly.
Updating URLs
The primary need is for DOI URLs to be redirected from one URL to another. This can be done using a URL-only update. When
updating DOIs involving multiple titles and prefixes, be aware of the following when updating URLs:
The fromPrefix and toPrefix are the prefix owning the DOIs to be updated. Only one prefix is allowed per update file.
Update files should not exceed 2 MB. If necessary, split the update into multiple files. Each file should contain a header.
If needed, CrossRef can provide members with a list of the DOIs and URLs deposited to our system.
Publishers may also update URLs by redepositing metadata. Use the Deposit Harvester to retrieve metadata that has
been deposited with CrossRef.
Page 78
Help Site
CrossRef Help
Transferring DOI ownership

Once a DOI is assigned to a content item it should remain unchanged. When ownership of a publication is transferred from one
publisher to another, the DOIs associated with the publication must also be transferred to the new owner.
Here are the basic steps involved in transferring ownership:
1. The acquiring publisher contacts CrossRef to initiate an ownership transfer. When requesting a DOI name ownership transfer,
the acquiring publisher must provide CrossRef with confirmation that the disposing publisher is aware of and agrees with the
ownership transfer.
New: Title transfers that have been posted to the Transfer notification list will be accepted. Otherwise, the confirmation may
be an email from the disposing publisher to the acquiring publisher that is forwarded to CrossRef.
2. The acquiring publisher sends CrossRef a tab-separated list of the DOIs to be transferred and the new URLs to be associated
with the DOIs:10.5555/1234xxxx
http://www.newurl.com/doi/10.5555.1234xxxx
10.5555/1234xxxy
http://www.newurl.com/doi/10.5555.1234xxxy
10.5555/1234xxxz
http://www.newurl.com/doi/10.5555.1234xxxz
10.5555/1234xxxa
http://www.newurl.com/doi/10.5555.1234xxxa
The publisher should obtain the DOI names from the disposing publisher. If necessary, CrossRef can supply a list of all the DOI
names associated with the publication.
3. The acquiring publisher supplies CrossRef with the file and its DOI name prefix. Note that only the ownership of the DOI
names changes, not the prefix. If you supply new URLs, they are updated at the same time that ownership is transferred.
For more detailed information, see Title and DOI name ownership/control policies and transfer procedures (pdf).
Page 79
Help Site
CrossRef Help
Updating or correcting title information in the CrossRef system

Titles in the CrossRef system are created from publisher metadata with the first deposit of a journal, book, conference proceeding,
or report. The publisher determines the exact title and ISSN included in the deposit.
Title and ISSN combinations are not verified with an external agency. A check digit validation is performed on every ISSN submitted
in a deposit. Once a title or ISSN is introduced into the CrossRef system, a new publication with the same title or ISSN cannot be
created without CrossRef intervention. Deposits containing title/ISSN combinations that do not match the tite/ISSN combination in
the CrossRef system will be rejected.
Although publishers can't edit titles once they have been created, CrossRef administrators can adjust the following types of title
information when necessary:
Add or adjust ISSNs: correct ISSN errors or add additional ISSNs not included in a submission
Add or adjust alternate spellings of titles:alternate title spellings and abbreviations are recorded for each title and used in
query matching. They can be included in the <abbrev> elements in deposits or added manually by a CrossRef administrator.
Correct title spelling: title spellings introduced with deposits must be correct by a CrossRef administrator.
Merge titles: if two title entries have been created in error, CrossRef administrators will merge the titles entries into one upon
request.
Delete titles: titles submitted in error can be deleted once DOIs assigned to the title have been migrated to another title.
Title maintenance is sometimes required when a title changes ownership. View Transferring DOI ownership for more
information. For assistance, contact support@crossref.org.
Page 80
Help Site
CrossRef Help
Best practices for journal titles

Titles in the CrossRef system are created from publisher metadata with the first deposit of a journal. The publisher determines the
exact title and ISSN included in the deposit.
We recognize the value of the ISSN as a unique identifier of key title information accordingly, CrossRefs title management
policies comply with the requirements provided by the ISSN centre regarding title management. Practices that directly impact
CrossRef deposits include:
All series (journal, book, conference proceedings) must have an ISSN.
The ISSN is crucial for identifying a serial. If you are supplying us with data for older titles that predate ISSN assignment, you should
request ISSNs from your ISSN agency as they can be assigned retroactively. This isnt only for CrossRefs convenience - libraries,
database providers, and other organizations using your data will welcome (and often require) an ISSN for anything defined as a
journal.
A distinct ISSN must be supplied for each distinct version of a title.
If a title changes significantly, the publisher needs to get new ISSNs (both print and online). This rule is established by the
International ISSN Centre, not CrossRef, but we support and enforce it. Minor title changes (such as changing and to &) dont
require a new ISSN.
Original title: Journal of CrossRef Metadata
Minor change (no new ISSN required): The Journal of CrossRef Metadata
Major change (new ISSN required): Journal of CrossRef Metadata Quality
Online versions of journals encompassing multiple historic print titles should each be assigned distinct print and
online ISSNs.
Its common practice for publishers to publish all versions of a title as an online journal with a single ISSN. This isnt recommended
practice as it causes a lot of linking and citing confusion youve essentially created two versions of a title. This is particularly
confusing when volume and issue numbers overlap between title iterations.
Assign DOIs at the journal title level
Members are strongly encouraged to assign DOIs at the journal title level.
ISSN Manual, Presentation & Identification of E-Journals (NISO recommended practice)
Page 81
Help Site
CrossRef Help
Best practices for maintaining CrossRef DOIs

Displaying CrossRef DOIs
Follow CrossRef DOI Display guidelines.

DOIs, along with volume, issue and page numbers, should be part of the standard bibliographic metadata for an article
DOIs should be displayed in bibliographic headers for online AND print articles
The DOI should be an active link
Include information about using DOIs in your instructions for authors. For an example, see the information Nature provides for
authors about Advanced Online Publication.
Maintaining DOI and metadata
Update URLs when needed

Review reports regularly to identify issues
redeposit DOIs with new metadata options (ORCID, FundRef) whenever possible.
Page 82
Help Site
CrossRef Help
Resolving conflicts
What are conflicts?

When two (or more) DOIs share identical metadata, CrossRef considers the DOIs to be in conflict. Conflicts generally occur for two
reasons:
1. Deposited metadata isn't sufficient to distinguish among DOIs. For example, items like "Book Reviews", "Letters" and
"Errata" often share a single page and have no author
2. Two or more DOIs have the same metadata. In this case, either the DOIs are missing titles and/or sequence numbers, or they
have the same metadata, same titles, and/or same sequence numbers.
Review sample conflict scenarios for specific examples.
Conflicts compromise query results. With many forms of querying, no match will be returned if the CrossRef system is not able to
conclusively identify a single DOI to match the metadata in a query. To prevent this problem, conflicts should be resolved as soon
as possible.
A DOI Conflict Penalty Fee of $2.00 per conflict may charged at CrossRef's discretion.
Page 83
Help Site
CrossRef Help
Resolving conflicts
Resolving conflicts
You can resolve such conflicts in one of three ways:
Update the metadata for one or more DOIs so each is unique

Make one DOI primary and the other DOI an alias
Accept a conflict as-is by changing its status to "resolved"without making any changes
CrossRef has instituted a penalty fee which may be imposed when staff is required to resolve a conflict
To resolve conflicts:
1. Identify the conflicts and view details about them by examining your deposit log, examining the Conflict report or using the
web interface.
2. Resolve conflicts by:
uploading a special control file to the system (best option for resolving multiple conflicts).
Assigning primary and alias status to DOIs using the system's user interface.
Updating the metadata for one or more of the DOIs involved in the conflict so that it can be distinguished from each other.
Then re-deposit this new metadata will CrossRef.
Accepting the conflicts as-is.
If you need to resolve a large number (hundreds or more) of conflicts, contact CrossRef for assistance.
If a conflict involves another publisher's DOI(s), contact CrossRef for assistance.
Publishers can force a DOI to be an alias of another even if those 2 DOIs are not in conflict.
For specific scenarios that cause conflicts, see sample conflict scenarios.
Page 84
Help Site
CrossRef Help
Resolving conflicts
Sample Conflict Scenarios

The following scenarios describe situations in which conflicts do or do not arise and why:
Scenario 1: No conflict due to distinguishing type element + show/hide example
Scenario 2: Conflict resolved by assigning primary status + show/hide example
Scenario 3: Conflict resolved by updating data (version 1) + show/hide example
Scenario 4: Pre-publication conflict resolved when page numbers updated + show/hide example
Scenario 5: Multi-way conflict created + show/hide example
Scenario 6: One conflict resolved but another created (version 1) + show/hide example
Scenario 7: One conflict resolved but another created (version 2) + show/hide example
Scenario 8: Conflict partially resolved + show/hide example
Scenario 9: Conflict resolved by updating data (version 2) + show/hide example
Page 85
Help Site
CrossRef Help
Resolving conflicts
Viewing conflicts using the web interface

If you know the submission ID, conflict ID, or DOI involved in a conflict, you can view details about it using the CrossRef web
interface.
If you submit an item to the CrossRef system that creates a conflict, the system notifies you in the submission log it returns by
email. For example, this email:
<record_diagnostic status="Warning">
<doi>10.1103/PhysRev.69.674</doi>
<msg>Added with conflict</msg>
<conflict_id>865</conflict_id>
<dois_in_conflict>
<doi>10.1103/PhysRev.69.674a</doi>
</dois_in_conflict>
</record_diagnostic>
indicates that 10.1103/PhysRev.69.674 is in conflict with 10.1103/PhysRev.69.674 and that the conflict has been assigned an ID
number of 865.
Because you know the conflict ID, you can view detailed information about it within the CrossRef system. To do so:
1. Access the CrossRef system.
2. Click the Metadata Admin tab.
3. Click the Conflict tab, if necessary.
4. Enter one of the following and select the appropriate options:
Submission ID:
Unresolved Displays only unresolved conflicts

Primary/Alias Displaysconflicts that have been resolved in prime/alias pairs
Auto Displays only conflicts that the CrossRef system automatically resolved only
Resolved Displays only unresolved conflicts
Submission is conflict source ID entered is for the submission that caused the conflict
Submission is NOT conflict source ID entered is for a submission that is involved in a conflict but not the cause of it
Conflict ID:
Show consolidated conflicts Displays the conflict IDs but not the details
Show auto-resolved conflicts Includes in the list conflicts that the CrossRef system automatically resolved
DOI ID
Show consolidated conflicts Displays the conflict IDs but not the details
Show auto-resolved conflicts Includes in the list conflicts that the CrossRef system automatically resolved
Unresolved Displays only unresolved conflicts
Primary/Alias Displays conflicts that have been resolved in prime/alias pairs
Auto Displays only conflicts that the CrossRef system automatically resolved only
Resolved Displays only unresolved conflicts
5. Click Submit to see the DOIs associated with the conflict.
Page 86
Help Site
CrossRef Help
Resolving conflicts
6. Click the conflict ID to see the DOIs involved, the Submission IDs involved, the status, and the metadata for the items
involved in the conflict.
Page 87
Help Site
CrossRef Help
Resolving conflicts
Assigning primary and alias status

One way to resolve a conflict between two DOIs with identical metadata is to assign primary status to one of them and make the
other one an alias.
For example, if the metadata for 10.1103/PhysRev.69.674 and 10.1103/PhysRev.69.674.2 are the same, you might assign make
10.1103/PhysRev.69.674 primary. In this case, metadata queries that match both DOIs will resolve to 10.1103/PhysRev.69.674, and
DOI queries for either 10.1103/PhysRev.69.674 or 10.1103/PhysRev.69.674.2 will return results.
You can assign primary status to DOIs in conflict one by one using the system interface, or you can assign primary or alias status to
multiple DOIs by uploading a .txt file.
You can confirm the conflicts have been resolved.
Assigning primary status from the system interface

To assign primary status to a DOI from the Conflict tab:
4. Enter either the submission ID, the conflict ID, or the DOI ID in the appropriate box.
5. Select Show Consolidated Conflicts, if available.
7. Select the DOI that you want to make primary.
8. Click Make Selected DOI Primary in All Conflicts.
If you make a mistake, you can undo it by returning to this page and clicking ' Unresolve All Conflicts'.
The CrossRef system updates the records. In this case, it makes 10.1103/PhysRev.69.674 the primary DOI.
Assigning primary or alias status by uploading conflict management submissions

To assign primary or alias status to multiple DOIs by uploading a text file. The status you assign applies to all conflicts that involve
the DOIs.
1. Create the .txt file such as the one shown here where op has a value of either primary or alias:
Page 88
Help Site
CrossRef Help
Resolving conflicts
H:email=ckoscher@crossref.org;op=<PRIMARY/ALIAS>
10.1016/0032-1028(80)90001-2
10.1016/0032-1028(80)90002-4
10.1016/0032-1028(80)90003-6
10.1016/0032-1028(80)90004-8
10.1016/0032-1028(80)90005-X
10.1016/0032-1028(80)90006-1
10.1016/0368-3281(63)90014-7
Use op=ALIAS when the primary DOIs are not known. If there are more than two DOIs involved in the conflict, the operation
is rejected because the system cannot determine which DOI to make primary.
3. Click the Submissions tab.
4. Click the Upload tab, if necessary.
5. Locate and select the metadata file.
6. Select Live.
7. Select Conflict Management.
8. Click Upload.
All the DOIs listed in the file will be assigned whichever status you specified in the op element. The CrossRef system will send you a
message like this one for an individual DOI:
<record_diagnostic doi="10.1088/0368-3281/5/6/313">
<conflict status="Success" ids="48983,49365,49783,50243,51067">
<msg>Marked as alias</msg>
<doi_list>
<doi>10.1016/0368-3281(63)90014-7</doi>
</doi_list>
</conflict>
or this one for multiple DOIs:
<?xml version="1.0" encoding="UTF-8"?>

<doi_batch_diagnostic>
<submission_id>1181263946</submission_id>
<record_diagnostic doi="10.5555/prime">
<conflict status="Success" ids="23135669,2311211">
<msg>Marked as alias</msg>
<doi_list>
<doi>10.5555/a1</doi>
<doi>10.5555/a2</doi>
</doi_list>
</conflict>
</doi_batch_diagnostic>
Confirm that conflicts were resolved

To double-check that any conflict associated with a DOI was eliminated:
Page 89
Help Site
CrossRef Help
Resolving conflicts

4. Enter the DOI ID, such as 10.1103/PhysRev.69.674.2, in the appropriate box.
5. Clear all the options.
6. Click Submit to see whether any conflict still exists.
Another way to verify the conflict was eliminated is to query for the DOI.
Page 90
Help Site
CrossRef Help
Resolving conflicts
Accepting a conflict as is
In some cases, you may want to leave conflicting or ambiguous records in the CrossRef metadata database. For example, you
might receive the following message that indicates that four DOIs are involved in seven related conflicts:
Created: 2005-07-28 00:48:53.0
ConfID: 118504
CauseID: 81049593
OtherID:
JT: Journal of the American Chemical Society
MD: null, 126 ,30,9465,2004,null
DOI: 10.1021/ja040932t (118502-null 118503-null
118627-null )
DOI: 10.1021/ja040944e (118502-null 118503-null
118627-null )
DOI: 10.1021/ja040943m (118503-null 118504-null
DOI: 10.1021/ja0409311 (118504-null 118624-null
118504-null 118624-null 118625-null 118626-null

118625-null 118626-null 118627-null )
By viewing the Conflict report, you know that all four DOIs point to the same page in the same issue and that none have an author
or article_title element.
When you look at each DOI involved in the conflict, you see that all four DOIs point to Book Reviews on the same page of the same
issue. You also determine that there simply is not enough metadata to distinguish the four DOIs from each other.
In this case, you should accept these conflicts as-is manually using the system interface or by uploading a .txt file. The CrossRef
system will then return results such as the following:
Page 91
Help Site
CrossRef Help
Resolving conflicts
In another case, you might upload partial metadata for several DOIs prior to publication, knowing that they will be in temporary
conflict until you can update them with page numbers. Again, you should accept the conflicts, which will disappear when you supply
the additional information.
If a conflict has been previously resolved using primary/alias or forced alias, attempting to 'resolve' the conflict using
these methods will undo any aliased pairings established in Handle.
Accepting a conflict as-is using the CrossRef System interface

To accept conflicts:
4. Enter either the submission ID, the conflict ID, or the DOI ID in the appropriate box.
5. Select Show Consolidated Conflicts, if available.
7. Click Mark All Conflicts as Resolved.
If you make a mistake, you can undo it by returning to this page and clicking 'Unresolve All Conflicts'.
Accepting a conflict as-is by uploading conflict management submissions to the CrossRef System
If you have a large number of DOIs to resolve, you can submit a text file to the CrossRef system.
1. Create a .txt file with op=resolve
H:email=youremailaddress;op=resolve
10.1016/0032-1028(80)90001-2
Page 92
Help Site
CrossRef Help
Resolving conflicts
10.1016/0032-1028(80)90002-4
10.1016/0032-1028(80)90003-6
10.1016/0032-1028(80)90004-8
10.1016/0032-1028(80)90005-X
10.1016/0032-1028(80)90006-1
10.1016/0368-3281(63)90014-7
6. Select Live.
8. Click Upload.
Double-checking that conflicts were resolved

4. Enter the DOI ID in the appropriate box.
Page 93
Help Site
CrossRef Help
Resolving conflicts
Updating metadata to resolve conflicts

To update metadata to resolve a conflict, you deposit the new information in the same way that you would deposit any other
metadata. To ensure that the CrossRef system updates the appropriate content item, be sure to supply the correct DOI in your
submission.
When making an update you must supply all the metadata for the article, not just the fields that need to be changed. During the
update process, the CrossRef system completely overwrites the existing metadata with the information you submit, including
inserting null values for any fields not supplied in the update.
If the new metadata resolves the conflict, the CrossRef system returns a message such as this one (which resulted from a redeposit
of the metadata for DOI 10.50505/200702271050-conflict):
<record_diagnostic status="Success">
<doi>10.50505/200702271050-conflict</doi>
<msg>Successfully updated</msg>
<resolved_conflict_ids>352052</resolved_conflict_ids>
Note that while submitting new metadata may resolve one or more conflicts, it might also spawn new ones. For example the
following XML results indicate that submitting data for 10.5555/DOI2 resolved two existing conflicts (17 and 21) but created a new
one (134).
<doi>10.5555/DOI2</doi>
<dois_in_conflict>
<doi>10.5555/DOI2_IN_CONFLICT</doi>
</dois_in_conflict>
<resolved_conflict_ids>17,21</resolved_conflict_ids>
Double-checking that conflicts were resolved

4. Enter the DOI ID, such as 10.1103/PhysRev.69.674.2, in the appropriate box.
Another way to verify the conflict was eliminated is to query for the DOI.
Page 94
Help Site
CrossRef Help
Resolving conflicts
Forcing prime/alias
Publishers can force a DOI to be an alias of another DOI if the DOIs are not in conflict. To force an alias between two DOIs, create a
text file as described below and upload to the CrossRef System:
1. Create the .txt file with tab-separated pairs of DOIs as follows:
H:email=youremail@address.com;op=force_alias;delim=tab
10.xxxx/primary1 10.xxxx/alias1
5. Select Live.
7. Click Upload.
Supplying op=unalias allows you to unalias previously forced aliases.

Extreme care MUST be taken when using this feature. Normally two DOIs are put into a prime/alias pair when their metadata is
the same and a conflict is created. In this case a metadata query will find both DOIs but because of the pairing will know to
return the prime DOI.
With FORCED prime/alias pairs metadata queries using either DOI's metadata will still work. So, if a pair has very different
metadata then two very different metadata queries will return the prime DOI (and its metadata). This will likely appear as a
false positive to the query caller.
Page 95
Help Site
CrossRef Help
Resolving conflicts
Sample conflict resolution files

Conflict resolution files are simple ASCII text files, typically with a '.txt' extension. They should be created with simple text editing
tools like Notepad.
DOIs in this file will be marked 'primary' in any conflicts:
H:email=youremail@address.com;op=primary
10.1016/0032-1028(80)90001-2
10.1016/0032-1028(80)90002-4
10.1016/0032-1028(80)90003-6
10.1016/0032-1028(80)90004-8
10.1016/0032-1028(80)90005-X
10.1016/0032-1028(80)90006-1
10.1016/0368-3281(63)90014-7
DOIs in this file will be marked 'alias' in any conflicts:
H:email=youremail@address.com;op=alias
10.1016/0032-1028(80)90001-2
10.1016/0032-1028(80)90002-4
10.1016/0032-1028(80)90003-6
10.1016/0032-1028(80)90004-8
10.1016/0032-1028(80)90005-X
10.1016/0032-1028(80)90006-1
10.1016/0368-3281(63)90014-7
Use op=ALIAS when the primary DOIs are not known. If there are more than two DOIs involved in the conflict, the
operation is rejected because the system cannot determine which DOI to make primary.
Any resolved conflicts involving DOIs in this list will be re-activated:
H:email=youremail@address.com;op=unalias
10.1016/0032-1028(80)90001-2
10.1016/0032-1028(80)90002-4
10.1016/0032-1028(80)90003-6
10.1016/0032-1028(80)90004-8
10.1016/0032-1028(80)90005-X
10.1016/0032-1028(80)90006-1
10.1016/0368-3281(63)90014-7
DOIs in the second column will be aliased to DOIs in the first column, regardless of conflict status:
H:email=youremail@address.com;op=force_alias;delim=tab
Page 96
Help Site
CrossRef Help
Reports
CrossRef reports
CrossRef provides a number of reports which can be used to maintain and assess deposited DOIs and metadata.
Members area reports

All web site reports are available in the CrossRef members area. Some reports may require a login. The members area login is
provided in your initial welcome email, or you can request the login from support@crossref.org
Depositor report: lists all DOIs by title for journals, books, and conference proceedings
Missing Metadata (Field) report: contains details regarding completeness of metadata
Crawler report: lists results of DOI resolution testing
Conflict report: lists conflicts by publisher and title, email alert sent out monthly (when needed)
Quarterly deposit report: quarterly list of number of back year, current year, and updated DOIs, by publisher and title
Title list: browsable list of journal, book, and conference proceedings titles deposited with CrossRef
XML journal list (mddb.xml): XML list of journal titles deposited with CrossRef
Status report: deposit and query volume
Go-live report: lists all CrossRef members, DOI prefixes, and date of last activity
Emailed reports
Some publisher-specific reports are sent out by email.
Resolution report: monthly statistics about member DOI resolutions

DOI Error Report: aggregated notification of DOI errors reported by end users, sent out nightly (when needed)
Schematron Report: post-deposit metadata quality report, sent out weekly as needed
Coming soon: new system reports
Page 97
Help Site
CrossRef Help
Reports
Viewing a Depositor report

The Depositor Reports list all DOIs for a title on a publisher-by-publisher basis. Reports are available for Journals, Books, and
Conference Proceedings.
To use these reports, click on a publisher name. A listing of that publisher's titles will expand below the name. Clicking on any
publication title will open a text file which list all DOIs for that title. + show/hide example
Select a journal, book, or conference proceeding title to retrieve a list of DOIs for the title (DOI), the owner prefix of the DOI
(OWNER), the timestamp value for the DOI (DEPOSIT-TIMESTAMP) and the date the DOI was last updated (LAST-UPDATED). +
show/hide example
The title detail report is access protected. The members area login is provided in your initial welcome email, or you can request the
login from support@crossref.org
Title-level depositor report data may also be retrieved using format=doilist as described here
The Missing Metadata / Field report and Crawler reports can be accessed from the main deposit report page.
Page 98
Help Site
CrossRef Help
Reports
Missing Metadata / Field Report

The Field (or Missing Metadata) report gives details on metadata completion and can be accessed by selecting the
listed next to
each publisher name in the Depositor Report. Fields checked are volume, issue, page, author, and article title. + show/hide
sample field report
Selecting a title will retrieve a list of DOIs for the title and flagged fields for each DOI. For example, the DOIs in this report lack page
and author information: + show/hide field report details
Although the CrossRef deposit schema specifies that some bibliographic metadata is optional for DOI registration purposes, we
strongly encourage members to register comprehensive metadata for each DOI deposited. Review Best Practices for depositing for
more information.
Page 99
Help Site
CrossRef Help
Reports
DOI Crawler Report

CrossRef tests a broad sample of DOIs to ensure resolution. For each journal crawled, a sample of DOIs that equals 5% of the total
DOIs for the journal up to a maximum of 50 DOIs is selected. The selected DOIs span prefixes and issues.
The results are recorded in Crawler reports, which are accessed from the Depositor Report expanded view. If a title has been
crawled, the last crawl date is shown in the appropriate column. Crawled DOIs that generate errors will appear as a bold link:
Select the 'Last Crawl Date' link to view a Crawler Status Report for a title. + show/hide status report
The Crawler Status Report lists the following:
Total DOIs: Total number of DOI names for the title in system on last crawl date
Checked: number of DOIs crawled
Confirmed: crawler found both DOI and article title on response page
Semi-confirmed: crawler found either DOI or article title on response page
Not Confirmed: crawler did not find DOI or article title on response page
Bad: page contains known phrases indicating article is not available (for example: article not found, no longer available)
Login Page: crawler is prompted to log in, no article title or DOI
Exception: indicates error in crawler code
httpCode: resolution attempt results in error (400, 403, 404, 500, etc.)
httpFailure: http server connection failed
Select each number to view details. Select 'Re-Crawl' and enter an email address to crawl again.
Page 100
Help Site
CrossRef Help
Reports
Examining the Conflict report

The Conflict report shows you the name and size of the file that contains your organization's conflict information, the total number
of publications your organization has registered, and the total number of conflicts that exist in the CrossRef system for your
organization. If you click your organization's name, you can also see the name of each publication, the total number of DOIs
registered for each publication, and the total size of the file storing the information about each journal deposited by the member.
To see details about all your organization's conflicts, click the name of the XML file, as shown here:
The XML file will list every conflict for the selected prefix. You may examine the conflicts for a particular publication by clicking on
the title. This will display a text file such as the following:
where:
ConfID is the unique ID number for the conflict.

CauseID is the deposit submission of the DOI causing the conflict.
OtherID is the deposit submission of the affected DOI.
JT is the publication's title.
MD is metadata for the DOIs.Metadata for DOIs in conflict will be the same.
DOI is the DOI involved in the conflict.
Parenthetical value following the DOI (in this case, 1686-null) lists all the conflicts in which the DOI is involved and the
resolution status of that conflict.
ALERT, if it appears, indicates that the DOIs have more than one conflict, which can occur if they were deposited repeatedly
with the same metadata. This field lists the other conflict IDs and their status:
null Not resolved
A Made an alias
P Made a prime
U Resolved by a metadata update
R Manually erased or resolved
You can also view detailed information about individual conflicts using the web interface.
Page 101
Help Site
CrossRef Help
Reports
Browsable Title List

The Browsable Title List provides an alphabetically indexed list of journals, books, and conference proceedings for which CrossRef
has article metadata. Browsing and searching may be limited by Genre (all, journals, books, or conference proceedings) or Search
type (title, ISSN/ISBN, subject, or publisher).
When searching for a specific title, enclose the title in quotes or search by ISSN
Search results will include the following (when available):
Title (Journal/Book/Conf Proc): Title name. Journal titles are grey, book titles are green, and conference proceedings titles are
purple.
Publisher: Publisher of the title as listed in the CrossRef database.
Print ISSN/ISBN: ISSN or ISBN (indicated by color) of the print version of the title.
Electronic ISSN/ISBN: ISSN or ISBN (indicated by color) of the electronic version of the title.
DOI: DOI assigned at the title level.
Review results:
Click
to view the year(s), volume(s), and issue(s) deposited in the CrossRef system for a title.
Click
to view alternate title information, abbreviated titles (if any), other ISSNs or ISBNs, subjects covered, and any coverage
notes for this content item. This information is obtained from a third party and may not match data deposited with CrossRef.
To request a missed-conflict report for a title, click
at the far right of the row.
Lists of libraries and affiliates (associations, organizations, agents, and linking solution partners) that use CrossRef are also
available.
A comma-separated journal coverage list is also available for download (~7 MB file)
Page 102
Help Site
CrossRef Help
Reports
Go-Live report
The Go-Live report displays information about CrossRef members and their activity on the CrossRef site. In particular, the Go-Live
report displays the following information:
Summary data: for the number of prefixes, members, and submissions over time
Name: Full name of the CrossRef member
Prefix: Member's CrossRef-assigned DOI prefix
Date Joined: Date the member joined CrossRef
Date of Last Deposit: Date of the member's most recent deposit
Date of Last Query: Date of the member's most recent query
Reference Links Live: indicates if member is linking references
Page 103
Help Site
CrossRef Help
Reports
Viewing a Status report

The Status report displays information about monthly activity in the CrossRef system. At the top of the report, summary statistics
are provided for:
Total number of records in the CrossRef system

Total number of DOIs registered
Total number of journals, books, and conference proceedings stored in the database
Total number of journal, book, and conference DOIs registered in the system.
In addition, the Status report displays the following information for deposits:
Month Year or month in the current year for which data is provided.
Total Records Added Total number of records added to the MDDB.XML database during that year or month.
Total Current Deposits Total number of deposits submitted to the database during that year or month for content item's
published during that previous year or the current year.
Total BackFile Deposits Total number of deposits submitted to the database during that year or month for content item's
published during a previous year.
Total Records Updated Total number of records updated in the database during that year or month.
The Status report also displays the following information for queries:
Month Year or month in the current year for which data is provided.
Total Metadata Queries Total number of metadata queries submitted to the CrossRef system during that year or month.
Total Matches Total number of metadata queries resolved by the CrossRef system during that year or month.
% Percentage of metadata queries resolved compared with the total number of metadata queries submitted during that year
or month.
% by Group (Lib, Pub, Aflt) Percentage of queries submitted by each type of CrossRef user compared with the total number
of metadata queries submitted during that year or month.
Total DOI Queries Total number of DOI queries submitted to the CrossRef system during that year or month.
Total Matches Total number of DOI queries resolved by the CrossRef system during that year or month.
% Percentage of DOI queries resolved compared with the total number of metadata queries submitted during that year or
month.
Page 104
Help Site
CrossRef Help
Reports
XML Journal List (MDDB.XML file)

The MDDB.xml file can be downloaded here (file is > 5MB). The file includes all Journal Titles, Title abbreviations, ISSNs, Year range,
Volumes, and the assigned DOI prefix.
<journal title="ISPRS Journal of Photogrammetry and Remote Sensing"abbr="ISPRS Journal

of Photogrammetry & Remote Sensing|ISPRS J Photogramm Remote Sens" issn="09242716|"
years="1989-2007" volumes="44-62" prefix="10.1016"/>
<journal title="Il Farmaco" abbr="Farmaco" issn="0014827X|" years="1998-2005"
volumes="53-60" prefix="10.1016"/>
Journal Title and coverage information is also available as a downloadable .csv (file is > 5MB)
Page 105
Help Site
CrossRef Help
Reports
Resolution Report
Resolution reports are sent out via email at the beginning of each month and includes statistics about DOI resolutions from the
previous month. A separate report is generated for each DOI prefix. The statistics are based on the number of DOI resolutions
through the DOI proxy server (http://dx.doi.org/) on a month-by-month basis and include:
resolution failure rate: the percentage of DOI resolution attempts that failed. The prefix failure rate and the overall failure
rate (for all CrossRef members) are included.
resolutions by month: total number of resolutions per month for the past 12 months, by prefix (Count) and overall (All
Members). + show/hide example
resolution stats: resolution counts for the report prefix. + show/hide example
Top ten DOIs:list of the ten DOIs with the highest number of successful resolutions for the month, and the number of times
each DOI was successfully resolved. + show/hide example
Failed DOIs: a list of DOI resolution attempts that failed (i.e. resolved to a Handle error page). This list is presented as a .csv
file attached to the report email and contains both the failed DOI and number of failures. + show/hide example
These statistics give an indication of the traffic generated by users clicking DOIs. The DOI links are largely from links in other
publishers' journal references to articles, but they are also from DOI links in secondary databases, links from libraries using DOIs,
and even DOIs in used in print versions.
When a researcher clicks on a DOI link for an article, that counts as one DOI resolution. For example, clicking on
http://dx.doi.org/10.1038/nature02426 counts as one resolution to Nature. No information is captured about who the user is or
where they are coming from. The information on DOI resolutions is captured by the web server logs on http://dx.doi.org/ which is
run by CNRI on behalf of the International DOI Foundation. These numbers are not a precise measure of traffic to a publisher's
website - cached articles, search engine crawlers not following re-direction, and traffic that is directed to a locally appropriate copy
through a library link resolver would be included in these numbers, but would not result in inbound traffic to a website.
Nevertheless, these numbers provide an important measure of the effectiveness of a member's participation in CrossRef.
We filter out known search engine crawlers. The overall number of filtered crawler resolutions for the month is included in the
report.
Resolution reports are sent to the business contact on file. To redirect the report or add additional contacts, contact
support@crossref.org.
See Working with your Resolution Report for additional details
Page 106
Help Site
CrossRef Help
Reports
Working with your Resolution Report

The resolution report, delivered monthly, gives publishers valuable insight into DOI usage. It also is a good resource for identifying
potential problems with either depositing practices or linking. The resolution failure rate is of particular interest as it allows a
publisher to compare their failure rate with that of other publisher members. The ideal failure rate is 0% but realistically 2-3% is the
normPublishers who are new to CrossRef or who have created a small number of DOIs may have a high failure percentage (for
example, a publisher with 1 failure and 9 successes will have a 10% failure rate).
A .csv file containing a list of all failed DOI resolution attempts for the month is attached to each report. This file should be reviewed
to identify problems with both linking and deposits. Any DOIs with a high number of failures should be examined closely. Significant
changes in your resolution failure rate should be taken seriously as well.
Not all DOIs included in the failed DOI .csv are legitimate DOIs ( DOIs that have been published). Possible reasons for DOI failure
include:
1. Undeposited DOI: a DOI has been distributed but not deposited - any DOIs that have been published should be deposited
immediately to prevent future resolution failures.
2. User error: a user can sometimes make mistakes when typing or cutting-and-pasting DOIs. These failures will appear on
your report and for the most part can be ignored - if your report frequently includes what you determine to be user errors,
review how your DOIs are displayed. See common user errors0 vs. 0, l vs. 1: Most DOI resolutions are generated by users
clicking on a link, but (particularly for those of you who publish DOIs in print) users do type them in. If your DOI failures often
contain DOIs with 0 being confused with O, or l with 1, consider changing your DOI suffix. Long strings of letters and numbers
can cause problems as well.
DOIs ending with .: One of the more common DOI failures is an otherwise viable DOI with a '.' appended. These usually are
linked from references that end with a '.' DOIs with special characters instead of -: this commonly happens when a user
cut-and-pastes a DOI from a PDF.
DOIs with special characters: end users often are not aware of problems caused by linking with special characters such as
<,>, #, and +. CrossRef does not currently accept deposits with special characters but did in the past.
3. DOI publication and deposit are out of sync: if you publish DOIs (print or online) prior to depositing them, any resolution
attempts will appear in the report. DOIs should be published and deposited as close to simultaneously as possible. It's often
not possible to do so, but the interval should be hours or a day, not days or weeks.
4. Linking issues: occasionally a DOI is the victim of a bad link - if the link is under your control, please change it. If not, alert
the link creator (if possible).
If you have a high number of failures for a DOI you have not published, Google the DOI to see if it is readily available online - it
is possible that the DOI is being linked incorrectly.
If an active DOI appears on your failed DOI list, review when the DOI was deposited. For example, if the DOI was deposited on
the 18th, any resolution attempts prior to the 18th will appear on your report. If the DOI was deposited prior to the first of the
report month, contact support@crossref.org
The Handle resolver supports URL-encoded DOIs.The resolution logs sometimes misrepresent the encoded characters. As a
result, some badly encoded DOIs will appear in your resolution log as correctly encoded DOIs. This typically happens when an
already-encoded DOI is mistakenly encoded again. For example, DOI 10.5555/example would be correctly encoded as
10.5555%2Fexample (the / is encoded as %2F). If the DOI is encoded again, the % in the DOI becomes %25, making the
DOI 10.5555%252Fexample. This DOI will not resolve but will appear in the failed DOI report as 10.5555%2Fexample (a
valid DOI).
CrossRef can run additional reports if necessary - contact support@crossref.org
Page 107
Help Site
CrossRef Help
Reports
Missed conflict report

Conflicts occur when two (or more) DOIs share the same bibliographic metadata. Conflicts are usually flagged upon deposit. In
some situations this doesn't happen, creating a missed conflict.
Reasons a missed conflict may occur:
Two DOIs are deposited for the same item, but the metadata is slightly different (DOI A deposited with an online publication
date of 2011, DOI B deposited with a print publication date of 1972)
DOIs were deposited with a unique item number (more info)
The missed conflict report compares article titles across data for a specified journal or journals.
Accessing the missed conflict report

To retrieve a missed conflict report for a title:
1. Locate the title in the browsable title list by searching or browsing
2. Select the
icon at the far right of the title + show/hide example
3. The missed conflict interface will pop up in a second window. Enter your email address in the appropriate field. Multiple title
IDs can be included in a single request if needed. + show/hide example
A report will be emailed to the address provided in step 3. This report lists all DOIs with identical article titles that have not been
flagged as conflicts. + show/hide example
Page 108
Help Site
CrossRef Help
Reports
Quarterly deposit report

The Quarterly deposit report is generated quarterly and lists back year, current year, and update DOI deposit counts within the
quarter. The report is organized by publisher and title, and is available in the CrossRef members area.
Page 109
Help Site
CrossRef Help
Reports
DOI Error report

The DOI Error report collects unresolving DOI errors reported by end users. When a user attempts to resolve a DOI that has not
been deposited, they are delivered to a web form which allows the user to submit information about the DOI they are trying to
resolve: + show/hide example
The data submitted is collected by CrossRef and redistributed nightly via an emailed report to the appropriate publishers. The
reported errors are captured in a .csv file and contain the following data:
DOI: the DOI being reported
URL: the referring URL (if supplied)
REPORTED-DATE: date the DOI was initially reported
USER-EMAIL: email of the reporter (if supplied)
COMMENTS: comments are optional
DOI errors are reported for a number of reasons:
a DOI has been published but not deposited

the published DOI does not match the deposited DOI
a DOI has been deposited but does not resolve to the correct item
the end user misinterpreted or mistyped a DOI (i.e. confusing 1 for l or 0 for O)
Any legitimate DOIs found in this report should be deposited immediately. When a DOI is deposited, any users who reported the
DOI as undeposited and supplied an email address will be notified via automated email that the DOI is now resolving.
The recipient for these reports is determined by the DOI prefix.

The total number of failed DOI resolution attempts by prefix is captured in the Resolution report.
CrossRef retains reported errors and can compile a report of all DOI errors submitted by prefix if needed.
Page 110
Help Site
CrossRef Help
Reports
Schematron report
CrossRef performs a post-deposited metadata quality check on all journal, book, and conference proceedings submissions. Any
identified errors may affect overall metadata quality and negatively affect queries for your content. Errors are aggregated and sent
out weekly via email as the 'Schematron report'. The report contains links (organized by title) to .xml files containing error details.
The XML files can be downloaded and processed programmatically, or viewed in a web browser: + show/hide example
Schematron is a pattern-based XML validation language, more information is available at http://www.schematron.com/.

Schematron validation is available for individual file uploads, or CrossRef's Schematron rules may be downloaded for batch
processing.
Page 111
Help Site
CrossRef Help
User Interfaces
CrossRef User Interfaces

Although most interactions with CrossRef's services follow a machine-to-machine transaction model, some user interfaces are
available. As CrossRef has grown, many smaller publishers, affiliates, and libraries have requested simpler and, in some cases,
manual ways to interact with the CrossRef system.
User interfaces include:
CrossRef system interface: web interface for the CrossRef system

Web Deposit form: enter metadata to create deposit XML
Simple Text query form: Cut-and-paste a reference list into the form, and retrieve results. This services requires a valid
email address, register for a CrossRef Query Services account here.
Reference deposit: deposit references using the Simple Text query form.
CrossRef Metadata Search: Most CrossRef query interfaces exist to return one correct DOI match, and will only return a DOI
if fairly strict requirements are met. This interface is the exception. Any results containing the entered search terms will be
returned. (more info from CrossRef Labs)
Turn a CrossRef DOI into a formatted reference: enter a DOI and retrieve a formatted reference. Reference quality is
determined by the metadata deposited for the DOI. (more info from CrossRef Labs)
Page 112
Help Site
CrossRef Help
System Interface
Accessing the CrossRef system

The CrossRef system's public interface can be accessed at http://doi.crossref.org. This interface can be used to:
upload deposit or query files

check the position of jobs in the submission queue
retrieve submission logs
review the deposit history of a DOI
The CrossRef system is undergoing redevelopment. As a result, query reports are not available.
Page 113
Help Site
CrossRef Help
System Interface
Submission Administration
The Submissions Administration interface displays information about a single submission or a set of submissions sent to the
CrossRef system. Reports can be sorted by date range, submission type, and by error or conflict status. + show/hide submission
administration screen
Retrieve submission logs:
Using a submission ID: + show/hide options

If you do not have a submission ID and/or would like to view a group of submissions: + show/hide options
Submission result output:

The submission adminstration results lists:
Submission ID: link to view the submission's details
icon: click to to view the submission's content (deposit file)

Filename: The name of the file which was uploaded
Depositor: user who made the submission
Area: area to which the submission was made (live or test)
Submission type:
XML Metadata: metadata deposit file
DOI References: resource deposit file (citations, as-crawled URLs, MR URLs)
Dates: Received, Started, and Finished dates on which the submission was received and completed processing.
+ show/hide submission result screen
for more information on using submission logs, view Interpreting System Logs. For information on conflicts and how
to eliminate them, see Resolving conflicts.
Page 114
Help Site
CrossRef Help
System Interface
Using the CrossRef System to track submissions

Immediately after your deposit has been submitted, the CrossRef system will return a 'Submission Accepted' message. This
message confirms that your file has been entered into the processing queue.
To view your deposit's position in the queue:
2. Click the Show My Submission Queue link on the opening page, or click the Submissions tab and then click the Show System
Queue tab.
3. Scroll until you see your deposit.
When your submission has been processed you will recieve an email containing the results of your submission.
Submission logs may also be retrieved by polling.

During times of very heavy loads, jobs may take several hours to reach the top of the queue.
Use the CrossRef system to check your submission progress in the queue.
Page 115
Help Site
CrossRef Help
System Interface
Submission queue
After a file has been uploaded, CrossRef immediately returns a confirmation that your file has been received and entered into the
submission queue.
The submission queue is available via the CrossRef system interface at http://doi.crossref.org. After logging in, select the Show My
Submission Queue link on the opening page (or click the Submissions tab then the Show System Queue tab).
The queue results are grouped by depositor ID. Select '+' under details to show filenames and queue position for each depositor.
Generally, it takes a few minutes to process a file. You then receive another email that indicates the processing results. During
times of very heavy loads, however, jobs may take several hours to reach the top of the queue.
Queue management
The processing queue is serviced by several submission processors (SPs), which are started by a system administrator. Typically
we run 8-10 submission processors. Each may be configured to only run jobs smaller than a certain size, jobs from specific users or
to exclude jobs from specific users. Usually SPs are assigned to run jobs under 25KBytes, under 100Kbytes, under 200KBytes and
then any size. This allows us to ensure that a group of extremely large files does not monopolize the active-queue.
If informed in advance, CrossRef will start SPs to exclusively run jobs from an individual user. We do this along with running SPs
that exclude that same user to allow a consistent level of minimum access to the active-queue. This is done when a user is going to
send in a large number of files perhaps depositing back files or making a bulk update of existing DOIs.
In the absence of advance notice, if we notice the presence of a large group of files we typically will adjust the queues in this
manner to prevent such users from monopolizing the active-queue.
Under certain circumstances, a CrossRef administrator can move jobs to the head of the queue for more immediate
processing. To request this service, contact CrossRef Support via email or by calling (781) 295-0072.
Page 116
Help Site
CrossRef Help
System Interface
Viewing the history of a DOI

The deposit history of individual DOIs may be retrieved using the CrossRef system interface. A DOI's history includes all deposit
files and submission logs.
Accessing DOI history

To view a DOI history report:
2. Click the Report tab.
3. Click the Misc. Reports tab.
4. Enter or paste a DOI in the box.
5. Click Show to view the report online.
Each submission that contained the DOI is listed and the details for that submission can be viewed by clicking on the submission
number. + show/hide example
Select a log under 'Detail to review the submission log. For further information on submission details, see Viewing submissions
details.
Page 117
Help Site
CrossRef Help
User Interfaces
Depositing using a web form

CrossRef provides an easy-to-use HTML form for registering DOIs. The form requires no knowledge of XML and is suitable for a small
number of deposits. You can use this web deposit form to register DOIs for journals and articles, books and chapters, conference
proceedings, and reports.
When depositing, enter all available metadata to ensure successful query matching
To use the web deposit form:
1. Navigate to the web deposit form. (on the CrossRef web site select "Web deposit form" under Technical Resources)
2. Select the type of content you want to deposit: Journal, Book, Conference Proceedings, Report, or NLM File
3. Enter the appropriate information for the type of content you selected.
Journals: register a journal-level DOI only or DOIs for each article within a given issue. Only one issue can be deposited at
a time. + show/hide details
Books: register both book- and chapter-level information. Select 'Submit Book DOI' to deposit a title-level DOI, or select
'Add Chapters' to enter metadata for chapters attached to the book being deposited. For series and sets, only one volume
can be deposited at a time. + show/hide details
For conference proceedings, enter event and conference paper information. Select 'Add Papers' to enter metadata for
conference papers. + show/hide details
For reports:Select 'Submit Report DOI' to deposit a single report DOI, or select 'Add Content Item' if the report contains
multiple chapters or papers. + show/hide details
NLM upload: To upload an XML file built according to the NLM DTD (publishing tag set) select NLM file, use the Browse
function to locate NLM XML file and enter login, contact, and DOI information. If the DOI and URL are not contained within
the XMLDOI and URL would be inserted as: <article-meta> <article-id pub-id-type='doi'>10.1234/abcdef</article-id> <selfuri>http://server.address.com/someplace.html</self-uri> </article-meta>. Enter them on the form and click Upload NLM
Data to submit.
4. Enter your username and password and email address and select Deposit.
After you have filled out and submitted the web deposit form, your upload will be processed by the CrossRef system. You will
receive two emails: a submission report and an XML file.
Review the submission report to verify your deposit was processed successfully.
The XML file is created from the information submitted through the web deposit form. If changes need to be made to your
deposit, you can edit and submit this XML using the CrossRef system.
Your CrossRef username (your login name) and password will be required at the end of this process to submit the data to the
system. Please ensure your browser allows JavaScript so the data validation will function properly.
We strongly encourage you to save the XML file sent to you post-deposit, as using it is the easiest way to perform updates of
the data entered using the form. Instead of reentering your metadata, you can edit the XML and resubmit using the system
interface.
Page 118
Help Site
CrossRef Help
User Interfaces
Using the Simple Text Query form to deposit references

CrossRefs cited-by linking service allows publishers to deposit the references for an article along with its DOI. This form allows you
to deposit references in a cut-and-paste interface.
To deposit references:
1. Enter your references into the Simple Text Query form and select Submit.
be sure the tick box for 'List all possible DOIs per reference' is not selected.
2. Select the Deposit button and complete the fields that appear:
email: your email address (a submission log will be emailed to you after your reference deposit has been processed)
Parent DOI: the DOI of the article (or chapter, report, etc.) for which you are submitting references
username / password: your CrossRef system account login
3. Again select Deposit.
If your details have been entered correctly you will see a "Success' message. This indicates that your deposit has been submitted to
the system queue. When the reference deposit has been processed you will receive submission log via email. You will also receive
an email containing the XML deposit generated by the form.
This deposit is processed as a complete set, which means that any previous deposit of citations for this article will be replaced
in full by any subsequent deposits. You may deposit an incomplete set -- just remember to include previous references each
time you make a deposit.
The reference deposit will include all references that were parsed by the XStyles engine and not just those that returned a DOI.
CrossRef will remember any non-DOI matched references and will attempt to find a match in the future.
The Simple Text Query form is not an appropriate tool for high volume operations and monthly usage limits of 1000 references
are in place.
Page 119
Help Site
CrossRef Help
Machine Interfaces / APIs
Using HTTP to POST Files (Upload)

Uploading files (for deposit or for bulk queries) are submitted using HTTP post with the encType: multipart/form-data. The URL for
all submissions is http:// doi.crossref.org/servlet/deposit. The following parameters are required:
Form Field
Description
Possible Values
Mandatory
Default
operation
Depends on submission type
doMDUpload: For metadata (XSD)

submissions
doDOICitUpload: For DOI citations or
resources submissions
doQueryUpload: For query submissions
doDOIQueryUpload: For DOI-to-metadata
query submissions
NO
doMDUpload
subType
subtype for metadata submissions
cm:For conflict management submissions
NO
N/A
login_id
CrossRef supplied login
N/A
YES
N/A
N/A
YES
N/A
YES
N/A
login_passwd CrossRef supplied password
Content parts
fname
Submission contents
N/A
Sample transactions
Example of a HTTP transaction: + show/hide example
For backward compatibility, the CrossRef system also accepts the login_id, login_passwd, operation, and area parameters in a
multi-part request. + show/hide example
Sample program (doUpload)

A sample Java program that performs file uploads to CrossRef can be downloaded from
www.crossref.org/08downloads/doUpload.zip. This program allows you to upload a single file, a list of files, or a whole directory of
files. Unzipping the archive will create a folder called doUpload. Open a Windows command window (Start->Run->cmd) and go to
this folder and type 'java -jar "doUpload.jar"'.
Usage: java -jar "doUpload.jar" -u username -p password -f file-name <-o upload-option>
This program uploads files to the CrossRef system.If the given file has a '.list' extension it is considered to be a file with a list of files
to upload. Any other extension is considered a single file upload. If the file is a directory then all files in the directory will be
uploaded.
The default upload option is DEPOSIT, alternatively it can be set to DEPOSIT_REFS, QUERY or DOIQUERY
Other optional args: -h host -hp port -ph proxy host -pp proxy port
-h defaults to doi.crossref.org
-hp defaults to port 80
-ph name of a proxy host if needed
-pp proxy port
File types
Users may upload a number of different file types depending on the task being addressed
XML Metadata upload

Bulk query using an XML query file
Bulk query using a pipe'd format file
Conflict resolution
Page 120
Help Site
CrossRef Help
Using HTTP to Query

The most common method of submitting queries to CrossRef is to have an automated service interact with the CrossRef system
using the HTTP interface. CrossRef strongly recommends that you group between 5 and 20 queries into a single request. This helps
reduce the network transaction load on CrossRef resources. These transactions use a simple HTTP GET request with the results
being returned immediately to the caller. Queries may also be processed off line in batch mode.
Synchronous HTTP queries

Synchronous queries are performed using a URL with encoded parameters as follows:
http://doi.crossref.org/servlet/query?usr=<USERNAME>&pwd=<PASSWORD>&format=unixref&qdata=<?xml
version="1.0"?><query_batch version="2.0"...
http://doi.crossref.org/servlet/query?pid=<USERNAME>:<PASSWORD>&id=10.1577/H02-043
http://doi.crossref.org/servlet/query?pid=<EMAIL>&id=10.1577/H02-043
where:

pid is your CrossRef-supplied login name and password or CrossRef Query Services email address.
format is the desired results format ( xsd_xml | unixref | unixsd)
qdata is the query data (XML is the recommended format)
id is a CrossRef DOI
DOI to metadata queries may also be performed using this syntax:

http://doi.crossref.org/search/doi?pid=<EMAIL or USERNAME:PASSWORD>&format=unixsd&doi=<DOI>
where doi is a CrossRef DOI.
To place multiple queries in one request, include them in the qdata parameter separated by %0A, as shown here:
http://doi.crossref.org/servlet/query?usr=<USERNAME>&pwd=<PASSWORD>&qdata=|%20Natl%20Acad.%20Sci.%20USA|Z
hou|94|24|13215|1997|||%0A|J.%20Mol.%20Biol.|Hagerman|260|||1996|||
Queries may be submitted in piped or XML format. XML is recommended. + show/hide example
Certain characters cannot be passed in a URL without causing problems. The following table lists those characters that must be
URL-encoded.
Character
Name
URL code
%3B
Slash, virgule, separatrix, or solidus %2F
Question mark
%3F
Colon
%3A
At sign
%40
Equals sign
%3D
&
Ampersand
%26
lf
line feed
%0A
For more information on URL encoding, see URL Encoding (or "What are those %20 codes in URLs?).
DOI-to-metadata queries retrieve primarily item metadata. See Retrieving DOI info-metadata to retrieve information about a
DOI such as timestamp prime/alias status.
Page 121
Help Site
CrossRef Help
HTTP Query Performance

There are several drawbacks to submitting synchronous HTTP queries:
A network connection is established every time an HTTP request is made. Even with HTTP keep-alive the web server
disconnects the client after a short period of inactivity. The establishment of a connection with every query request can be
expensive, especially for one-line queries.
User authentication on the CrossRef side occurs with every HTTP request. Because most clients do not maintain a session with
CrossRef, the cost in terms of CrossRef resources of establishing a session to enforce user access rights for every request is
substantial.
Users can overcome the first two drawbacks by submitting multiple queries within the same HTTP request where queries are
separated by CRLF. However, this technique presents a different problem: queries are evaluated sequentially within the same
thread, which means "hard-to-resolve" queries slow down other queries within the same batch. So even though users gain in
terms of network connection and CrossRef authentication time, they lose the concurrence provided by submitting one-line
queries.
Page 122
Help Site
CrossRef Help
Retrieve submission results via HTTP

After your submission has been processed, a submission report will be emailed to the address provided in the submission.
It is also possible to retrieve the results of submission processing or the contents of a submission at any time through this URL:
http://doi.crossref.org/servlet/submissionDownload?usr=<USERNAME>&pwd=<PASSWORD>&doi_batch_id=<DOI BATCH
ID>&file_name=<FILENAME>&type=<TYPE>
where:
usr is the CrossRef-supplied login name

pwd is the CrossRef-supplied password
doi_batch_id is the DOI batch ID you supplied in the XML deposit file
file_name is the name of the file that you submitted
type is the type of data requested (this field is mandatory)
Use result to retrieve submission results (deposit log)
Use content to retrieve the XML file
You can track a submission by its doi_batch_id or by its file_name. In either case, only the first match is returned. To use this
feature effectively, make sure each tracking ID (doi_batch_id or file_name) is unique.
Only the first match is returned. So, in order to use this feature effectively, it is the publisher's responsibility to make sure
that each tracking ID (doi_batch_id or file_name) is unique.
The main difference between using doi_batch_id and file_name is that doi_batch_id is inserted into the database after the
submission has been parsed. Using file_name is preferable because submissions in the queue or in process can be tracked
before deposit. Non-parse-able submissions can also be tracked using this method.
You may also use the system to retrieve and view submission reports.
Page 123
Help Site
CrossRef Help
Using the Open URL Query Interface

For basic information on OpenURL, see DOIs, OpenURL, and link resolvers.
OpenURL Accounts
Using a login to access CrossRef's OpenURL Query Interface is required. We request that users obtain and use a login to help
monitor usage and deal with problems should they arise. OpenURL users who are already CrossRef members may use their
CrossRef system account. Non members may obtain a free query services account.
Login credentials are provided in the 'pid' parameter of the OpenURL request.
For CrossRef members using username/password:

http://www.crossref.org/openurl?pid=username:password&aulast=Maas%20LRM&title=
JOURNAL%20OF%20PHYSICAL%20OCEANOGRAPHY&volume=32&issue=3&spage=870&date=2002
For CrossRef Query Services accounts:

http://www.crossref.org/openurl?pid=name@someplace.com&aulast=Maas%20LRM&title=
Metadata queries
CrossRef maintains an OpenURLQuery Interface that accepts metadata, searches to find a matching DOI, and redirects the user to
the target of the DOI.
For example, a user might submit the following query:
http://www.crossref.org/openurl?pid=username:password&aulast=Maas%20LRM&title=
The OpenURL Query Interface would find the appropriate DOIin this case, 10.1175/1520-0485(2002)032<0870:CT>2.0.CO;2and
redirect the user to the DOI response page at http://dx.doi.org/10.1175/1520-0485(2002)032<0870:CT>2.0.CO;2.
In most instances, only a single DOI will be returned. If more than one DOI is returned, the user will be directed to a list of all
available DOIs. For example, the query:
http://www.crossref.org/openurl?pid=username:password&title=Science&aulast=Fernndez&date=2009 will return multiple
results. + show/hide example
OpenURL query parameters

The OpenURL Query Interface can accept these parameters:
Citation metadata parameters:
issn ISSN
title - journal title
aulast - last name (preferably of first author)
volume
issue
spage - first page
date - publication year (YYYY)
stitle Short title, which may be supplied as an alternative to title
Other parameters:
pid or sid Your CrossRef-supplied login name and password; in older forms, sid was used instead of pid (which is preferred)
redirect Set to false to return the DOI in XML format instead of redirecting to the target URL (the default is true)
multihit Set to true to return DOIs for more than one content item if the CrossRef system does not find an exact match (the
default is false)
Page 124
Help Site
CrossRef Help
format - set to unixref to return metadata in UNIXREF format (a more complete set of metadata)
Results are returned in XML format.
Sample results:
Single match found: + show/hide example
Multiple matches found: + show/hide example
Sample queries:
redirect="false":
http://www.crossref.org/openurl?issn=03770273&aulast=Walker&volume=54&spage=117&date=1983&noredirect=&pid=u
sername:password
multihit="true/false/exact":
http://www.crossref.org/openurl?issn=03603016&volume=54&issue=2&spage=215&date=2002&multihit=true&pid=usern
ame:password
DOI queries
CrossRef supports DOI queries formatted as OpenURL version 0.1 requests. This metadata includes identifiers (title and/or ISSN),
first author, enumeration (volume issue page), and year, as shown here:
Open URL query:

http://www.crossref.org/openurl/?pid=username:password&id=doi:10.1103/PhysRev.47.777&noredirect=true
CrossRef query:
http://doi.crossref.org/servlet/query?pid=username:password&id=10.1006/jmbi.2000.4282
Like metadata queries, DOI query results are returned in XML format.
The default result format for OpenURL is xsd_xml. For more robust metadata, use the format parameter and
specify unixref:
http://www.crossref.org/openurl/?pid=username:password&format=unixref
&id=doi:10.1103/PhysRev.47.777&noredirect=true
NISO 0.1 or 1.0 URLs:

CrossRef also supports NISO 0.1 and 1.0 URLs as well as some common deviations. In general it supports the San Antonio Profile
#1, including in-line, by-value, and by-reference. In the presence of a url_ver= Z39.88-2004 parameter this service will operate
on a info:ofi/fmt:kev:mtx:ctx context format with referent formats info:ofi/fmt:kev:mtx:journal or info:ofi/fmt:kev:mtx:book.
Simple reverse lookup:

http://www.crossref.org/openurl?pid=username:password&url_ver=Z39.88-2004&rft_id=info:doi/10.1103/PhysRev.47.777
Retrieve a DOI's metadata:

http://www.crossref.org/openurl?pid=username:password&url_ver=Z39.88-2004&rft_id=info:doi/10.1361/15477020418786
&noredirect=true
A journal article lookup:

http://www.crossref.org/openurl?pid=username:password&url_ver=Z39.88-2004&rft_val_fmt=info:ofi/fmt:kev:mtx:journal&rf
Page 125
Help Site
CrossRef Help
t.atitle=Isolation of a common receptor for coxsackie

B&rft.jtitle=Science&rft.aulast=Bergelson&rft.auinit=J&rft.date=1997&rft.volume=275&rft.spage=1320&rft.epage=1323
Page 126
Help Site
CrossRef Help
Using OAI-PMH
CrossRef operates an OAI-PMH service for the distribution of metadata to subscribers. This system is based on the OCLC version 2
repository framework and implements the interface as documented at http://www.openarchives.org/OAI/openarchivesprotocol.html.
Access to CrossRefs service for retrieving DOI metadata is regulated by the IP address of a server which will be performing a
harvest. Our repository supports selective harvesting according to sets defined by the hierarchy of publisher and journal title.
Our service allows public access to two OAI verbs which allow for discovery of coverage information
1. http://oai.crossref.org/OAIHandler?verb=ListSets&set=[setspec]
2. http://oai.crossref.org/OAIHandler?verb=ListIdentifiers&metadataPrefix=cr_unixml&set=[setspec]&from=YYYY-MM-DD&until=
YYYY-MM-DD
Setspecs are formatted as follows:
content type:prefix:pubID (ex: J:10.1002:4, the publisher Wiley, journal Applied Organometallic Chemistry)
content type:prefix (ex: J:10.1002, journals owned by publisher Wiley)
The from and until dates are when the DOI record was deposited with CrossRef, not the published date of the item. Thus a
request for records from yesterday (until now) will return all records added or changed between then and now irrespecive of
the record's publication date.
Content type are: J for journals, B for book or conference proceeding titles, and S for series.
Due to the size of the repository it is highly discouraged to perform a ListRecords action for the entire collection. Use of the
ListRecords verb must include a SET specification.
With the ListSets request the set parameter is optional. Leaving off the set parameter will return a listing of all publishers, all their
journal titles and each year of publication for which we have DOIs.
With the ListIdentifers request the set, from, and until parameters are optional. The from and until parameters are used to specify
dates when the DOIs were registered with CrossRef and not the publication date.
http://oai.crossref.org/OAIHandler?verb=ListIdentifiers&metadataPrefix=cr_unixml&from=2010-08-11
The default set for both ListIdentifiers and ListRecords is J (journals). A set (B for books or conference proceedings, S for series)
must be specified to retrieve non-journal data.
Resumption Tokens
Many OAI requests are too big to be retrieved in a single transaction. If a given response contains a resumption token, the user
must make an additional request to retrieve the rest of the data. Resumption tokens remain viable for 24 hours.
http://oai.crossref.org/OAIHandler?verb=ListIdentifiers&resumptionToken=1235061857339!5000!cr_unixml
Metadata Services - What data is available

CrossRef's Metadata Service is available based on subscription. After an organization applies for subscription members of CrossRef
may decide if they wish for their metadata to be included in distributions to the subscribing organization (knows as an opportunity
to opt-out). This may result in the subscribing organization being able to retrieve less than the full set of metadata available at
CrossRef. Upon acceptance of an application the subscriber will supply CrossRef with two IP addresses from which they will be
allowed to retrieve metadata. Any request received from these IP addresses will be filtered so as to exclude non-participating
CrossRef member metadata. The two publicly available requests mentioned above are not subject to this limitation when the
requests come from an IP address not assigned to a known subscriber. These two requests when received from a subscriber's
registered IP addresses will only return data pertinent to that subscriber (e.g. a ListSets request will omit any publisher who has
chosen not to distribute to that subscriber).
CrossRef may also establish a subscriber using an opt-in model where each publisher must specifically request that their data be
enabled for transmission to such a recipient.
Page 127
Help Site
CrossRef Help
Opt-out and opt-in is established at the title level. Titles may have more than one depositor, but OAI delivery is
determined by the prefix identified as the owner in the CrossRef system.
Initial data loads

As mentioned above, the size of the CrossRef repository precludes using one OAI request to retrieve all the available data. Often a
subscriber first obtains a list of the available sets using the ListSets request and then repeatedly submit ListRecords requests for
each publisher. This approach can require a substantial amount of time. Upon request CrossRef staff can produce an archive of all
the data available to a given subscriber which can then be downloaded via FTP. Please submit requests to support@crossref.org.
A sample application for harvesting CrossRef OAI data is available at http://www.crossref.org/08downloads/oaipmhRequest.zip
Page 128
Help Site
CrossRef Help
Deposit Harvester
The Deposit Harvester allows members to retrieve metadata and DOIs deposited with CrossRef. The metadata retrieved is in
CrossRef's UNIXREF schema format, which delivers the exact metadata submitted in a deposit and includes any citations that
have been deposited. Members (or their designated third parties) may only retrieve their own metadata.
The service uses the Open Archives Initiative Protocol for Metadata Harvesting (OAI-PMH) to deliver the metadata. The verbs
Identify, ListMetadataFormats, ListSets, ListIdentifiers, ListRecords, and GetRecord are supported.
Ownership and retrieval restrictions

The Deposit Harvester will only retrieve metadata to the authorized owner. Metadata ownership is established by the DOI prefixes
associated with a user's system login. Most publishers have one prefix and one login, but some publishers may have multiple
prefixes assigned to a single login. For example, Publisher A has been assigned system account "abcd", which is associated with
prefixes 10.xxxx, 10.yyyy, and 10.zzzz. Publisher A can retrieve metadata owned by prefixes 10.xxxx, 10.yyyy, and 10.zzzz using
their 'abcd' login.
Ownership of DOIs and titles often moves from publisher to publisher, so a title owning prefix will not always match the prefix of the
DOIs attached to the title. Retrieval restrictions are established by current owner, not original depositor. For example, Publisher B
deposits a journal article DOI, 10.5555/jfo.33425. Ownership of the journal is transferred to Publisher A, who assigns it to prefix
10.xxxx.
Sets
The Deposit Harvester supports a hierarchy of sets. The hierarchy is in three parts: <work-type>:<prefix>:<publication-id>. For
example, the set "J:10.12345:6789" will return metadata for a journal (J), with prefix "10.12345", and publication id "6789". The set
"B" will return all book metadata. The set "S:10.12345" will return all the series metadata associated with the 10.12345 prefix.
The work-type designators are:
'J' for journals

'B' for books and book-like works (reports, conference proceedings, standards, dissertations)
'S' for non-journal series and series-like works.
If no set is specified, the set "J" is used.
Sample requests:
ListSets: retrieve list of titles owned by the prefixes assigned to your system login:
http://oai.crossref.org/DepositHarvester?verb=ListSets&usr=<username>&pwd=<password>
ListRecords
Retrieve data for a prefix:
http://oai.crossref.org/DepositHarvester?verb=ListRecords&metadataPrefix=cr_unixml&set=<work-type>:<prefix>&usr=<
username>&pwd=<password>
Retrieve data for a single title:
http://oai.crossref.org/DepositHarvester?verb=ListRecords&metadataPrefix=cr_unixml&set=<work-type>:<prefix>:<title
ID>&usr=<username>&pwd=<password>
GetRecord: retrieve data for a single DOI:
http://oai.crossref.org/DepositHarvester?verb=GetRecord&metadataPrefix=cr_unixml&identifier=info:doi/<DOI>&usr=<use
rname>&pwd=<password>
When using GetRecord, the <DOI> value should be URL encoded.
Page 129
Help Site
CrossRef Help
Identify: use to check the status of the Deposit Harvester (no login needed):
http://oai.crossref.org/DepositHarvester?verb=Identify
ListMetadataFormats: lists available metadata formats (currently UNIXREF)
http://oai.crossref.org/DepositHarvester?verb=ListMetadataFormats
Request parameters:
work-type: J for journals, B for book or conference proceeding titles, S for series
prefix: the owning prefix of the title being retrieved
title ID: the title identification number assigned by the CrossRef system. Title IDs are included in the ListSets response described
above.
username and password: system login for the prefix/title being retrieved
Results
Results conform to CrossRef's UNIXREF format and may contain the following root elements:
journal
book
conference
dissertation
report-paper
standard
sa_component
database
Resumption tokens
Some OAI-PMH requests are too big to be retrieved in a single transaction. If a given response contains a resumption token, the
user must make an additional request to retrieve the rest of the data. You must provide the account name and password with both
the initial request and subsequent resumption requests. A resumption without authentication details will fail.
Initial request:
http://oai.crossref.org/DepositHarvester?verb=ListRecords&metadataPrefix=cr_unixml&set=J:10.4102:83986&usr=<userna
me>&pwd=<password>
Request with resumption token:
http://oai.crossref.org/DepositHarvester?verb=ListRecords&metadataPrefix=cr_unixml&set=J:10.4102:83986&usr=<userna
me>&pwd=<password>&resumptionToken=01f7f30e-f692-4cc4-97b2-1eaf88b3f17f
See Using OAI-PMH for details.
Records will not be returned in a predictable sequence - changes to the Data Harvester may affect how results are
ordered.
Page 130
Help Site
CrossRef Help
DOI Registration Agency tool

This tool identifies which DOI Registration Agency is responsible for a DOI or set of DOIs. Not all DOIs are registered by CrossRef CrossRef is one of a number of DOI Registration Agencies.
To retrieve the registration agency of a DOI, prepend the DOI with http://doi.crossref.org/doiRA/ (REST
option: http://doi.crossref.org/ra/)
Single DOI:
Prepend the DOI with http://doi.crossref.org/doiRA or http://doi.crossref.org/ra/ (REST option):
http://doi.crossref.org/RA/10.5240/B1FA-0EEC-C316-3316-3A73-L
http://doi.crossref.org/doiRA/10.5240/B1FA-0EEC-C316-3316-3A73-L
Multiple DOIs:
Separate DOIs with commas to look up multiple DOIs:
http://doi.crossref.org/doiRA/10.1594/PANGAEA.57055,10.1037/0003-066X.59.1.29,10.5240/B1FA-0EEC-C316-3316-3A73-L
Results:
The results include the DOI and Registration Agency:
[
{
"DOI": "10.5240\/B1FA-0EEC-C316-3316-3A73-L",
"RA": "EIDR"
}]
Page 131
Help Site
CrossRef Help
Advanced topics
Content negotiation for DOIs

CrossRef and DataCite support content negotiated DOIs via http://data.crossref.org and http://data.datacite.org. See
http://crosscite.org/cn/ for details.
Examples using curl:

curl -D - -L -H "Accept: application/rdf+xml" "http://dx.doi.org/10.1126/science.1157784"
curl -D - -L -H "Accept: text/turtle" "http://dx.doi.org/10.1126/science.1157784"
curl -D - -L -H "Accept: application/atom+xml" "http://dx.doi.org/10.1126/science.1157784"
The CrossRef-specific 'unixref' format can be used as well:
curl -D - -L -H "Accept: application/unixref+xml" "http://dx.doi.org/10.1126/science.1157784"
Behind the scene details most people don't need to know.
Page 132
Help Site
CrossRef Help
CrossRef Metadata Services
CMS Basic
Crossref Metadata Services (CMS) is our program that provides for the bulk distribution of metadata to subscribers (affiliates and
metadata services). CMS Basic is a level of service where a recipient is allowed to retrieve the metadata for all CrossRef member
publishers (in the enhanced level of service member publishers can opt-out thus disallowing distribution of their metadata). With
CMS Basic a recipient will receive the basic bibliographic metadata for each DOI. Reference lists are excluded from CMS Basic data.
CMS Basic data is retrieved by a recipient using FTP from authorized IP addresses.
Organizations that choose to host data locally pull it from CrossRef in XML and can utilize all or a subset of the content delivered to
CrossRef. Local hosting is for those organizations that want to retrieve DOIs within their local system without using CrossRef's query
service to retrieve DOIs from CrossRef. Because the data is delivered in XML format, the organization must have an infrastructure
to receive and load the information into its own system and databases. The structure of the CMS basic service does not allow for
selective retrieval of data. All data must be transferred with filtering done after receipt.
Conditions for local hosting
Local hosting is available to all CrossRef members and affiliates.

Organizations that host locally are subject to the general membership terms and any specific terms for local hosting as
determined by the CrossRef Board of Directors.
Organizations that host locally are not allowed to resell the data or provide a lookup service for other members' DOIs. There is
no restriction on members providing a lookup service for their own DOIs.
The annual administrative fee for local hosting is charged in addition to any other membership or deposit fees that may
apply. For information about annual hosting fees, contact CrossRef.
Agents appointed by members are not eligible for local hosting.
There are no individual DOI lookup charges for local hosting.
Technical Information About Local Hosting

The distribution of CrossRef metadata is accomplished via FTP of XML files from the CrossRef servers. FTP access to the file area is
controlled by IP addresses and account authentication.
Two formats of XML are provided in CMS basic:
'lite-weight' XML (sample): includes basic citation metadata (journal title, ISSN, volume issue page first author) and DOIs.
Lite-weight XML does not follow a schema and is very flat (data is in attributes, not an XML hierarchy) which makes it easy
for some processors to handle.
Medium-weight XML (sample): basic citation metadata structured according to our output data schema
(schema | documentation).
Data update schedule and organization

CMS Basic data is updated on a daily, weekly and monthly rotation.
The top level FTP directory structure has several sub folders:
Folders compressed and crossref contain deprecated CMS data (this is no longer updated).
Folders mdByTitle and mdByTitle-lite are aliased and link to lite-weight XML.
Folder mdByTitle-medium contains medium-weight XML, the most robust form of CMS basic data.
Under folders mdByTitle and mdByTitle-medium are sub folders that contain the rotation of regularly updated data. Each day, week
and full folder contain the same substructure. Data is generated on a daily, weekly and monthly basis. Each day the prior days DOI
deposit activity (new or update) are written to one of the dayX folders. The process rotates through the 'dayX' folders during the
week. Each week (on Saturday) the prior weeks deposit activity is written to one of the weekX folders. This process rotates
through the folders during the month. Once each month (on the 3rd) the entire metadata set (all DOIs for all titles) are written to
the full folder. + show/hide directory hierarchy
Also in the lite-weight folder are six text files that serve as a road-map to what is in the dayX and weekX folders. These text files tell
where to find the most recent interval of data.
Page 133
Help Site
CrossRef Help
lastrundate_daily_books.txt
lastrundate_daily_confproc.txt
lastrundate_daily_journals.txt
lastrundate_weekly_books.txt
lastrundate_weekly_confproc.txt
lastrundate_weekly_journals.txt
The TXT files describe what run was most recently made and which folder contains the data. For example, lastrun_daily_journals.txt
may contain this single line which indicates that the data for Sept 11, 2007 is in the day0 folder.
11-SEP-2007:12-SEP-2007:0
If for some reason the daily process failed the date range may span more than one day. This example shows that the deposit data
for Sept 11 through Sept 13 are in day0.
11-SEP-2007:14-SEP-2007:0
The weekly files contain two lines of text. The first identifies the date the run was made and the second indicates which folder
contains the data. The full folder will be populated at the start of the month and one should use the file date/time to determine
currency.
Samples
1. CMS Basic daily update of journal data
2. CMS Basic weekly update of book date
3. CMS Basic weekly update of conference proceeding data
4. CMS Basic example of a FULL data file
CrossRef does not provide any specific tools or programs for processing these XML files but will provide technical assistance to
an organization that is incorporating local hosting services into their system.
For both models of XML the data is available as single XML files or as .zip archives for each day.
Local hosting a subset of the CrossRef repository can only be accommodated using the second data model.
Page 134
Help Site
CrossRef Help
CMS Enhanced (OAI-PMH)

CMS Enhanced allows a recipient to retrieve the basic metadata and in addition possibly receive the list of references for any
individual item. The major difference between CMS Basic and CMS Enhanced are the terms defining the allowed use of metadata
obtained with each service. Because of the term differences publishers may choose to opt-out in supplying their metadata to a
particular CMS Enhanced recipient. A publisher may also choose to supply basic metadata but to restrict distribution of the
reference lists.
CMS Enhanced services are delivered by an OAI-PMH server operated by CrossRef. Please see our help section on using this
interface.
OAI-PMH is a protocol for metadata harvesting and a full description is available at www.openarchives.org. To summarize, this
protocol defines a set of HTTP requests that allow a harvester to interact with a repository to pull selective metadata or all available
data. Normally, an OAI-PMH compatible repository provides free and open access to its data. CrossRef however has implemented
an access control mechanism based on recipients and their IP address. Each recipient must be registered with CrossRef. CrossRef
member publishers may choose to opt-out for a given recipient. The publishers may also choose to opt-out/opt-in on a title by title
basis, making a subset of their metadata available to the specific recipient.
Dublin Core (DC) is the standard format for metadata distribution by a PMH compliant repository. However, DC is not expressive
enough to represent the full metadata available in CrossRef. DC is not currently supported by CrossRef's PMH interface. Our PMH
currently generates data formatted using our Unified XML schema (schema | documentation).
Each record retrieved through the PMH interface will have the complete metadata as deposited by the publisher for that DOI.
CrossRef's repository supports a three level hierarchical set organization. At the top level are the publisher sets where the set
identifier is the DOI prefix for the publisher. The next level is the publication title level where the set identifier is an internal value
assigned by CrossRef for the publication. The third level is the year of publication.
All PMH identifiers are DOIs expressed using the IETF RFC 4452 "The 'info' URI Scheme for Information Assets with Identifiers in
Public Namespaces" (see the info-uri registry).
Samples
1. CMS Enhanced response to a ListSets request
2. CMS Enhanced response to a ListIdentifiers request
3. CMS Enhanced response to a ListRecords request
OAI-PMH query interface
Page 135
Help Site
CrossRef Help
Cited-by linking
Cited-by linking overview

In addition to using DOIs to link to references that appear in their content, CrossRef members
can retrieve the DOIs of other publications that cite their content. This optional service, called
cited-by linking (previously forward linking), enables CrossRef members to display cited-by
links in the primary content that they publish. Cited-by linking policies, examples, and a list
of participating publishers are available on the CrossRef website.
Cited-by linking process:

1. Publisher A registers DOI 10.1234/X for article X with the following metadata:Journal= "Good Science", author="John Smith",
volume="21", first page="100" year="2007"
2. Publisher B deposits metadata for article Y and assigns it DOI 10.5678/Y. The deposited references for article Y include the
following:
<citation_list>
<citation key="reference to article X">
<author>Smith</author>
<journal_title>Good Science</journal_title>
<cYear>2007</cYear>
<volume>21</volume>
</citation>
</citation_list>
3. The CrossRef system establishes a cited-by relationship between article X and Y
4. Publisher A later sends a query asking who 'cites' article X and is given the DOI for article Y and its metadata.
Currently only the publisher who owns an item may ask for the cited-by data. So in the above example publisher C could not inquire
about the cited-by relationship of article X or Y. Obviously the order of events may differ than this simple example shows, for
example step #2 could occur before step #1. The CrossRef system is setup to handle this by 'remembering' the citation in article Y
and will establish the relationship whenever article X is ultimately deposited.
Steps for cited-by linking participation:

1. Deposit references: References can be submitted as part of a metadata deposit or as a reference-only deposit. See
Depositing references for details.
2. Query for cited-by links:cited-by matches can be retrieved via XML and HTTP querying. See Retrieving cited-by links for
details.
3. Once retrieved, cited-by links should be included on DOI response pages. + show/hide example
To make use of cited-by linking, publishers must first register for the optional cited-by linking service.
Page 136
Help Site
CrossRef Help
Cited-by linking
Retrieving Cited-by Links

Publishers participating in Cited-by Linking are able to retrieve a list of items that cite a specific target article. Only the owner of the
target article will be able to retrieve cited-by matches. New cited-by links to a target item can be established at any time when
some other publisher deposits an article citing the target item. To ensure cited-by links are up to date, publishers should either
query regularly for cited-by links or (if performing XML queries) set the alert attribute to "true".
XML Queries
The primary method of retrieving cited-by links is to submit a cited-by linking query using the CrossRef query schema. The query
contains only the DOI of the cited article stored in the fl_query element.
Setting the alert attribute to "true" instructs the CrossRef system to remember this query and to send new cited-by link results to
the specified email address when they occur.
+ show/hide example
Cited-by linking XML queries can be submitted just like any other query. For details, review How querying works.
Alerts are not emailed immediately when a cited-by match is made, there is sometimes a delay of several weeks.
HTTP queries
An alternative to using the XML query format described above will be to send in simpler HTTP requests as shown below. Alerts
cannot be enabled via HTTP querying. The response to HTTP requests will also be formatted as XML.
DOI query: This format retrieves all cited-by matches for a single DOI within a specified date range.
http://doi.crossref.org/servlet/getForwardLinks?usr=<username>&pwd=<password>&doi=<doi>&startDate=<startDate>
&endDate=<endDate>
The doi parameter is required. Date range is optional, note that if a startDate is included, endDate must also be present.
By-date query: This format retrieves cited-by matches established on a single day for a DOI prefix. Only the prefix owner may
retrieve matches.
http://doi.crossref.org/servlet/getForwardLinks?usr=<username>&pwd=<password>&doi=<prefix>&date=YYYY-MM-DD
Date range (startDate and endDate) and doi parameters are required.
OAI-PMH request: This format retrieves cited-by matches established within a date range for a given title. Only the prefix owner
may retrieve matches. Note: date range is required.
http://oai.crossref.org/OAIHandler?verb=ListRecords&usr=<username>&pwd=<password>&set=J:<prefix>:<journalID>&fr
om=YYYY-MM-DD&until=YYYY-MM-DD&metadataPrefix=cr_citedby
where:
username and password: system login for the prefix/title being retrieved
prefix: the owning prefix of the title being retrieved
journalID: the journal identification number assigned by the CrossRef system.
OAI-PMH requests only return a list of citing DOIs. Metadata is currently not included. + show/hide example
Some OAI-PMH requests are too big to be retrieved in a single transaction. If a given response contains a resumption
token the user must make an additional request to retrieve the rest of the data.See OAI-PMH query interface for details.
Page 137
Help Site
CrossRef Help
Cited-by linking
Depositing References
Reference-only deposits are really nothing more than the list of references in an article's bibliography. Under CrossRef's normal
linking service, members deposit an article's metadata and then - in a separate process - query for the DOIs of the references. In
order to do that querying, the references must be parsed or extracted from the article to enable construction of a CrossRef query.
Reference-only deposits simply combine the identity of the article (the DOI in the metadata deposit) with its list of references (the
list of queries).
References can be deposited in two ways:
As part of a metadata deposit
Publishers currently supply their article metadata in an XML file formatted according to the CrossRef deposit schema.
+ show/hide example or right-click to download sample XML
As a resource-only deposit
Participating publishers who do not wish to modify their existing metadata deposit process may instead deposit the reference lists
in a separate reference-only deposit transaction. A special resource-only schema (doi_resources4.3.2.xsd | documentation) has
been developed which allows for the deposit of references for an article that already has a CrossRef-registered DOI. This schema
and the full metadata schema make use of same common 'include' file to describe the references for an article.
+ show/hide example or right-click to download sample XML
In both approaches, an article's references are described using the <citation_list> XML element. This element contains one or more
citation> elements (which is also common to both of the above methods). The <citation> element contains the same fields needed
in a normal CrossRef query.
Current elements for citation deposits

The current elements for citation tagging are :
<issn>: ISSN of a series (print or electronic)
<journal_title>
<author>: first author of an article or other publication
<volume>: volume number (journal or book set)
<issue>: journal issue
<first_page>
<cYear>: year of publication
<article_title>: journal article, conference paper, or book chapter title
<isbn>
<series_title>: title of a book or conference series
<volume_title>: book or conference proceeding title
<edition_number>
<component_number>: the chapter, section, part, etc. number for a content item in a book.
<unstructured_citation>: citations for which no structured data is available. CrossRef's ability to process unstructured
citations is limited (more info)
<doi>: include the DOI wherever possible
Review schema documentation for the <citation> element for more information.
The <citation> element is modeled after the <query> element found in the CrossRef XML query schema.
Reference by default are not distributed with query results, but can be distributed with publisher consent.
References may be submitted using the Simple Text Query form. Usage limits are in place.
Page 138
Help Site
CrossRef Help
FundRef
FundRef
The FundRef service collects funding source information for publications deposited with CrossRef. An overview of FundRef is
available on the CrossRef website. Implementation instructions are detailed below and include:
CrossRef schema changes

Instructions for deleting or updating FundRef metadata
Examples
New:
funder_name AND funder_identifier should both be included when the funding organization exists in the FundRef Registry.
deposits using funder_identifier will be rejected if the identifier is not found in the FundRef Registry
deposits with only funder_name (no funder_identifier) will be 'best matched' against the existing set of funder names (allowing
for minor text differences in the names)
a FundRef API is now available
funding_identifier has been changed to award_number
The FundRef Registry is now available
Depositing FundRef metadata

FundRef metadata must include the name of the funding organization AND the funder identifier, where the funding organization is
listed in the Registry, and may include an award/grant number assigned to the fund. Funder names should only be deposited
without the accompanying ID when the funder is not found in the Registry.
CrossMark participants should nest FundRef data within the <crossmark> element, for example:
<crossmark>
<crossmark_version>1</crossmark_version>
<crossmark_policy>10.5555/cm_1</crossmark_policy>
<crossmark_domains>
<crossmark_domain><domain>www.crossref.org</domain></crossmark_domain>
</crossmark_domains>
<crossmark_domain_exclusive>true</crossmark_domain_exclusive>
<updates>
<update type="correction" label="Correction" date="2011-0-10">10.5555/cm_test2.1</update>
</updates>
<custom_metadata>
<assertion name="received" label="Received" group_name="publication_history"
group_label="Publication History">2011-04-12</assertion>
<fr:program name="fundref">
<fr:assertion name="funder_name">IMA Funder
<fr:assertion
name="funder_identifier">http://dx.doi.org/10.13039/xxxxxxxxxx</fr:assertion>
</fr:assertion>
<fr:assertion name="award_number">HPC-227</fr:assertion
</fr:program>
</custom_metadata>
Page 139
Help Site
CrossRef Help
FundRef
</crossmark>
Members not participating in CrossMark may deposit FundRef metadata along with article metadata.
...
<year>2011</year>
</publication_date>
<pages>
</pages>
<fr:assertion name="funder_name">ABC Inc.
<fr:assertion
name="funder_identifier">http://dx.doi.org/10.13039/xxxxxxxxxx</fr:assertion>
</fr:assertion>
<fr:assertion name="award_number">BXDFSDS</fr:assertion>
</fr:program>
<doi_data>
<doi>10.5555/cm_test_1.1</doi>
<resource>http://www.crossref.org/crossmark/index.html</resource>
</doi_data>
</journal_article>
FundRef schema changes

An additional element (<fr:program>) has been added to the latest deposit schema (crossref4.3.1.xsd | documentation) to support
the import of the fundref.xsd schema (documentation). The fundref namespace (xmlns:fr=http://www.crossref.org/fundref.xsd)
must be included in the schema declaration, for example:
<doi_batch xmlns="http://www.crossref.org/schema/4.3.1"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:fr="http://www.crossref.org/fundref.xsd"
xsi:schemaLocation="http://www.crossref.org/schema/4.3.1
http://www.crossref.org/depositSchema/crossref4.3.1.xsd" version="4.3.1">
To accommodate integration with CrossMark, the fundref.xsd consists of a series of nested <fr:assertion> tags with enumerated
name attributes.
<fr:assertion name="funder_name">National Institute on Drug Abuse
<fr:assertion
name="funder_identifier">http://dx.doi.org/10.13039/R01ZDA</fr:assertion>
</fr:assertion>
<fr:assertion name="award_number">JQY0937263</fr:assertion>
</fr:program>
name attributes are:
fundgroup: used to group funding info for items with multiple funding sources. Required for items with multiple
funder_name or funder_identifier assertions.
funder_name: name of the funding agency as it appears in the FundRef Registry. Funder names that do not match those in
the registry will be accepted to cover instances where the funding organization is not listed.
funder_identifier: funding agency identifier in the form of a DOI, must be nested within the "funder_name" assertion. The
funder_identifier must be taken from the FundRef Registry and cannot be created by the publisher.
Page 140
Help Site
CrossRef Help
FundRef
award_number: grant number or other fund identifier

"funder_name" AND "funder_identifier" must be present in a deposit where the funding body is listed in the FundRef Registry.
Multiple "funder_name", "funder_identifier", and "award_number" assertions may be included.
A relationship between "funder_identifier" and "funder_name" is established by nesting "funder_identifier" within "funder_name".
For example, this deposit excerpt has the funder "National Science Foundation" with its correspondeing funder identifier in the
FundRef Registry of "http://dx.doi.org/10.13039.10000001":
<fr:assertion name="funder_name">National Science Foundation

<fr:assertion
name="funder_identifier">http://dx.doi.org/10.13039.10000001</fr:assertion>
</fr:assertion>
At minimum a FundRef deposit must contain a "funder_name" and "funder_identifier" assertion. Deposits with just an
"award_number" assertion are not allowed. A "funder_name", "funder_identifier", and "award_number" should be included in
FundRef deposits whenever possible. If the funder name cannot be matched in the Registry you may submit funder_name only and
the funding body will be reviewed and considered for addition to the official Registry. Until it is added to the Registry the deposit
will not appear in search results in FundRef Search.
Some rules will be enforced by the deposit logic, including:
Nesting of the <fr:assertion> elements: the schema allows infinite nesting of the assertion element to accommodate
nesting of an element within itself. Deposit code will only allow 3 levels of nesting (with attribute values of "fundgroup",
"funder_name", and "funder_identifier")
Values of different <fr:assertion> elements: "funder_name", "funder_identifier", and "award_number" may have deposit
rules imposed
Only valid funder identifiers will be accepted: the "funder_identifier" value will be compared against the FundRef Registry
file. If the funder_identifier is not found, the deposit will be rejected.
Deleting or updating FundRef metadata

If FundRef metadata is incorrect or out of date, it may be updated by redepositing the metadata. Be sure to redeposit all available
metadata for an item, not just the elements being updated.
FundRef metadata may be deleted by redepositing an item with an empty <fr:program name="fundref"> element:
Deleting non-CrossMark FundRef metadata: + show/hide example
Deleting CrossMark FundRef metadata: + show/hide example

Submitting an empty CrossMark tag (<crossmark />) will delete all FundRef data for the item.
Examples
1. Funding Organization information within a CrossMark deposit: The <fr:program> element captures FundRef data as
<custom_metadata> within the <crossmark> element.
<crossmark>
<crossmark_version>1</crossmark_version>
<crossmark_policy>10.5555/crossmark_policy</crossmark_policy>
<custom_metadata>
<fr:assertion
name="funder_identifier">http://dx.doi.org/10.13039/100000001</fr:assertion>
</fr:assertion>
<fr:assertion name="award_number">psychoceramics-1152342</fr:assertion>
</fr:program>
Page 141
Help Site
CrossRef Help
FundRef
</custom_metadata>
</crossmark>
2. Funding Organization information outside of CrossMark: The <fr:program> element captures FundRef data, it should be placed
before the <doi_data> element. This deposit contains minimal FundRef data - one "funder_name" or one "funder_identifier" must
be present; both are recommended.
<fr:assertion
</fr:assertion>
</fr:program>
3. One funding organization, two grant numbers: This example contains one funder_name and one funder_identifier. Note that the
funder_identifier is nested within the funder_name assertion, establishing "http://dx.doi.org/10.13039.100000001" as the FundRef
identifier for funder name "National Science Foundation." Two award numbers are present.
<fr:assertion
</fr:assertion>
<fr:assertion name="award_number">CBET-106</fr:assertion>
</fr:program>
4. Multiple Funding Organizations and grant numbers: This example contains two funder_name/identifiers and two award_numbers
for each funder. Each funding organization is within its own "fundgroup".
<fr:assertion name="fundgroup">
<fr:assertion
</fr:assertion>
</fr:assertion>
<fr:assertion name="fundgroup">
<fr:assertion name="funder_name">Basic Energy Sciences, Office of Science, U.S.
Department of Energy
<fr:assertion
</fr:assertion>
<fr:assertion name="award_number">1245-ABDS</fr:assertion>
<fr:assertion name="award_number">98562-POIUB</fr:assertion>
</fr:assertion>
</fr:program>
Page 142
Help Site
CrossRef Help
FundRef
Page 143
Help Site
CrossRef Help
FundRef
FundRef XML Deposits

FundRef metadata can be deposited with CrossRef in two ways.
1) As part of the full set of metadata for an article.
2) In a stand-alone deposit where just the FundRef metadata is provided.
Please also read the detailed rules regarding FundRef metadata.
Stand-alone deposits:
Stand alone deposits are intended as a convience for depositing FundRef data to existing DOIs without having to repeat the existing
metadata. The deposit XML file contains just the DOI of the article and the specific FundRef data.
If the DOI currently has any FundRef data it will be replaced by the stand-alone deposited data.
If the DOI currently has any CrossMark data, the stand-alone deposited FundRef data will be inserted within the existing (previously
deposited) CrossMark data.
When uploading stand-alone deposits to CrossRef using the HTTP POST API the operation must be doDOICitUpload.
When uploading using the system interface the file type must be DOI References/Resources
Full Metadata deposits:

Fundref data may be deposited as part of a normal 'full' metadata XML deposit for a DOI.
Page 144
Help Site
CrossRef Help
FundRef
Page 145
Help Site
CrossRef Help
FundRef
FundRef API
The FundRef API supports retrieval of FundRef information using a funder name, funder identifier, and/or fund identifier. Results are
returned in UNIXSD format. A login is required. Members may use their CrossRef system login. Non members may obtain a free
query services account.
A demostration interface is available at doi.crossref.org/fundrefSearch.
Query syntax
A query using the FundRef API will retrieve DOIs as matches (when available). The query syntax is:
http://doi.crossref.org/search/fundref?usr=<username>&pwd=<password>&funder-name=<name of funder>&funderidentifier=<identifier for funder>&award-number=<award number>
http://doi.crossref.org/search/fundref?pid=<email address>&funder-name=<name of funder>&funder-identifier=<identifier
for funder>&award-number=<award number>
where:

or:
pid is your CrossRef-supplied login name and password (separated by :, as in username:password) or CrossRef Query
Services email address (free).
Three funding data parameters are available:
funder-name: name of funding agency

funder-identifier: funding agency identifier
award-number: grant number or other fund identifier
Funding data fields are optional but at least one funding data parameter must be supplied.
For best results, values with spaces should be URL-encoded.
Retrieving a list of funder names.

The FundRef Registry contains the official list of currated Funder names. To achieve the highest quality FundRef metadata
publishers are asked to perform reconciliation efforts that yield deposits to CrossRef using these names. However we recognize that
not all funding body names will be in the FundRef Registry which is why we allow deposits to occur using names that are not in the
registry. For a list of funding body names that includes entries not yet in the Registry use click here.
Examples
Retrieves UNIXSD XML for all DOIs deposited with 'U.S. Department of Energy' as funder-name:
http://doi.crossref.org/search/fundref?pid=<email>&funder-name=U.S. Department of Energy
Retrieves UNIXSD XML for all DOIs deposited where funder-identifier is 100000001:
http://doi.crossref.org/search/fundref?pid=<email>&funder-identifier=100000001
Retrieves UNXISD XML for all DOIs deposited with 'U.S. Department of Energy' as funder-name and award-number of DE-FG0-07ER46417:
http://doi.crossref.org/search/fundref?pid=<email>&funder-name=U.S. Department of Energy&award-number=DE-FG0-07ER46417&operator=and
Retrieves UNXISD XML for all DOIs deposited with 'U.S. Department of Energy' as funder-name or award-number of DE-FG0-07ER46417:
Page 146
Help Site
CrossRef Help
FundRef
http://doi.crossref.org/search/fundref?pid=<email>&funder-name=U.S. Department of Energy&award-number=DE-FG0-07ER46417&operator=or
The FundRef API will accept the funder-identifier as a DOI (10.13039/501100000289), a URI
(http://dx.doi.org/10.13039/501100000289) or an identifier number (501100000289)
Page 147
Help Site
CrossRef Help
FundRef
FundRef Registry
The FundRef Registry provides a common taxonomy of over 4000 international funding organization names together with unique
IDs for each. FundRef participants should use the Registry to normalize collection of funding bodies from authors at the time of
submission, and to deposit Funding agency names (funder_name) and IDs (funder_identifier) with CrossRef. For more information
on depositing FundRef data see the main FundRef help page.
The list is available to download as an RDF file, and is freely available under a CC0 license waiver.
DOWNLOAD 4.2 MB (RDF)
To the extent possible under law, CrossRef has waived all copyright and related or neighboring rights to the FundRef Registry.
Additional Options
Download a CSV file of the funder names and identifiers in the FundRef Registry.
Download a list of funders in JSON format.
FundRef Registry Updates

How can I tell when the FundRef Registry was last updated?
The FundRef Registry download links provided by CrossRef allow HEAD requests; HTTP requests that will only return HTTP headers,
rather than the whole registry file. HEAD requests can be used to retrieve a "last modified" date for the registry files. Below is an
example of making a HEAD request to the FundRef Registry DOI. First a request is made to get the redirect location of the DOI, and
then a second HEAD request is made to determine the last modified time of the registry file:
* curl -i -X HEAD http://dx.doi.org/10.13039/fundref_registry
*
* HTTP/1.1 303 See Other Server: Apache-Coyote/1.1
* Vary: Accept
* Location: http://www.crossref.org/docs/fundref/fundref_registry.rdf
* Expires: Wed, 03 Jul 2013 17:40:13 GMT
* Content-Type: text/html;charset=utf-8
* Content-Length: 200
* Date: Wed, 03 Jul 2013 08:45:50 GMT
Now follow the location redirect and make another HEAD request to find the last modified date of the registry:
* curl -i -X HEAD http://www.crossref.org/docs/fundref/fundref_registry.rdf
*
* HTTP/1.1 200 OK Server: Apache-Coyote/1.1
* Accept-Ranges: bytes
* ETag: W/"4252782-1372700920000"
* Last-Modified: Mon, 01 Jul 2013 17:48:40 GMT
* Content-Type: application/rdf+xml
Page 148
Help Site
CrossRef Help
FundRef
* Content-Length: 4252782
* Date: Wed, 03 Jul 2013 08:45:59 GMT
* Connection: close
Here we can see that the registry was "Last-Modified" on 1st July 2013. This can be checked against a timestamp we may have
previously recorded when downloading the registry. If the timestamp is more recent than the one we have recorded, or this is the
first time we are downloading the registry, we would go ahead and make a normal GET request to download the registry file:
* curl -i -X GET http://www.crossref.org/docs/fundref/fundref_registry.rdf
* An alternative - using HTTP ETags

FundRef Registry files also support ETags, which provide an alternative update check mechanism (also HTTP based.) See
http://en.wikipedia.org/wiki/HTTP_ETag for more information.
How often should I check for updates?

We expect the FundRef Registry to be updated once a month, but you may wish to make HEAD requests to check for updates more
frequently to ensure timely updates. Making a HEAD request once a day would be reasonable.
Do I need to retrieve the FundRef Registry using its DOI?

We recommend that anyone wishing to download the FundRef Registry does so using its DOI. CrossRef may change the underlying
location of the registry download but the registry DOI, like any other DOI, will always redirect to the correct location.
This is particularly important for packaged software products where it would be difficult to change the registry download URL.
Page 149
Help Site
CrossRef Help
CrossRef Schema
CrossRef Deposit Schema (v. 4.3)

Depositing metadata with CrossRef involves creating an XML file formatted according to our XSD schema. Versions 4.3.0 through
4.3.3 are currently being accepted for deposits. Initial DOI deposits must be made using the deposit schema. Select metadata may
be added to an existing deposit using the DOI resources schema.
Metadata deposits:
Coming soon: crossref4.3.4.xsd (crossref4.3.4.xsd | documentation)

this schema has not been implemented and is not available for deposits
New: crossref4.3.3.xsd (crossref4.3.3.xsd | documentation)
adds support for deposit of JATS abstracts
crossref4.3.2.xsd (crossref4.3.2.xsd | documentation)
added support for MathML in titles
deposit of Access Indicators
non-CrossRef DOIs in deposits
reference and metadata distribution flags
revised deposit metadata for standards
crossref4.3.1.xsd (crossref4.3.1.xsd | documentation) has been released to support FundRef and deposit of ORCIDs.
The associated common file is http://www.crossref.org/schemas/common4.3.1.xsd.
Version 4.3.0 is still available: (crossref4.3.0.xsd | documentation)
The associated common file is at http://www.crossref.org/schemas/common4.3.0.xsd.

Sample 4.3.0 files are available at http://www.crossref.org/schema/info/samples/4.3.0_samples/
Required and recommended elements
Resource or citation-only deposits:

The DOI resources schema alleviates the need to include base metadata when adding supplemental metadata such as citations,
CrossMark, and FundRef.
doi_resources4.3.2.xsd (doi_resources4.3.2.xsd | documentation) adds support for:

depositing FundRef-only metadata
depositing Access Indicators (not implemented)
doi_resources4.3.0.xsd (doi_resources4.3.0.xsd | documentation) supports:
deposit of citation-only metadata
Supports depositing additional resources for existing DOIs (as-crawled URLs, multiple resolution URLs)
CrossMark-only deposits
All schema versions prior to 4.3.0 have been discontinued. With the exception of series deposits for books,
conference proceedings, and reports, schema versions are backwards-compatible. With the exception of standards
deposits, migrating to version 4.3.3 should require changing the schema declaration only.
Page 150
Help Site
CrossRef Help
CrossRef Schema
CrossRef Schema
Type
Version
Location
Documentation
Deposit Schema
Item metadata deposits: Use
for all deposits including
standalone components for a
parent DOI.
Coming xmlns: http://www.crossref.org/schema/4.3.4

soon:
http://www.crossref.org/schemas/crossref4.3.4.xsd
4.3.4
for review only, not yet implemented
available
New:
4.3.3
xmlns: http://www.crossref.org/schema/4.3.3
available
4.3.2
available
4.3.1
available
4.3.0
available
FundRef: contains FundRef

deposit specifications, used with
version 4.3.1 and later
http://www.crossref.org/schemas/fundref.xsd
AccessIndicators: contains
Access Indicators deposit
specifications, used with version
4.3.2 and later
http://www.crossref.org/schemas/AccessIndicators.xsd
Citation or resource
New:
metadata: Used for depositing 4.3.2
additional data related to a
DOI without having to supply the
main metadata for the DOI.
xmlns:http://www.crossref.org/doi_resources_schema/4.3.2
4.3.0
xmlns:http://www.crossref.org/doi_resources_schema/4.3.0
http://www.crossref.org/schemas/doi_resources4.3.0.xsd
available
Common element: File that

4.3.2
contains common elements used
by other schema
http://www.crossref.org/schemas/common4.3.2.xsd
available
4.3.1
available
4.3.0
available
XML Query schema: Used to

input XML queries to the system
2.0
xmlns: http://www.crossref.org/qschema/2.0
http://www.crossref.org/schemas/crossref_query_input2.0.xsd
available
XML Query results

schema: Returns query results
in the XSD_XML format
2.0
xmlns: http://www.crossref.org/qrschema/2.0
http://www.crossref.org/schemas/crossref_query_output2.0.xsd
available
UNIXSD XML schema: Returns 3.0

query results in
the UNIXSD format
xmlns: http://www.crossref.org/qrschema/3.0
http://www.crossref.org/schemas/crossref_query_output3.0.xsd
available
Unified XML schema: Returns

query results in
the UNIXML format, also used to
support the data delivered by
our OAI-PMH service.
xmlns: http://www.crossref.org/xschema/1.1
http://www.crossref.org/schemas/unixref1.1.xsd
available
http://www.crossref.org/schemas/doi_resources4.3.2.xsd
Query schema
1.1
Page 151
Help Site
CrossRef Help
Type
CrossRef Schema
Version
Location
Documentation
Note: The majority of UNIXML

1.0
results use the unixref1.1.xsd
schema. Some results involving
book or conference proceeding
data deposited prior to a deposit
schema change use
unixref1.0.xsd.
xmlns: http://www.crossref.org/xschema/1.0
http://www.crossref.org/schemas/unixref1.0.xsd
available
CrossRef output
schema: Used to support data
files generated for local hosting
and other bulk data distribution.
3.0.1
xmlns=http://www.crossref.org/output/3.0
http://www.crossref.org/schemas/crossref_output3.0.1.xsd
available
CrossRef's OAI-PMH server

generates data that is not
consistent with the published
open-archives OAI 2.0 schema
(see
http://www.openarchives.org/)
because DOIs allow characters
that are not allowed by
xsd:anyURI.
2.0
xmlns:oai=http://www.openarchives.org/OAI/2.0/
http://www.crossref.org/schemas/OAI-PMH.cr.xsd
available
Published OAI 2.0

schema:<simpleType
name="identifierType">
<restriction base="anyURI"/>
</simpleType>
CrossRef OAI 2.0
schema:<simpleType
name="identifierType">
<restriction base="string"/>
</simpleType>
Page 152
Help Site
CrossRef Help
CrossRef Schema
Required, Recommended, and Optional Elements

Content types:
Journal
Book
Conference Proceedings
Dissertation
Report-paper
Standard
Database
Content type: Journal (documentation)

Required Elements
Journal: full_title, ISSN

Issue issue, publication_date (year)
Article: titles, publication_date (year), doi_data
Issue elements are only required if a DOI is being deposited at the issue level. Article elements are likewise only required
for article DOI deposits.
Recommended Elements
Journal: abbrev_title, doi_data, coden, journal_issue

Issue: publication_date (month, day), journal_volume, contributors, issue, doi_data
Article: contributors, publication_date (day, month), pages (first_page, last_page), citation_list
Optional Elements
publisher_item
special_numbering
component_list
^top
Content type: Book (documentation)

Required Elements
Series: titles, ISSN, volume, ISBN, publication_date (year), publisher (publisher_name)

Set: titles, ISBN, volume
Book: titles, publication_date (year), ISBNif no ISBN is available, use <noisbn> element, publisher
Chapter:doi_data
Series: doi_data,edition_number,contributors, coden, series_number, citation_list

Set: contributors, doi_data, edition_number, contributors, citation_list, doi_data
Book: contributors, edition_number, doi_data, citation_list
Chapter: contributors, titles, pages, publication_date, citation_list
Optional Elements
publisher_item
part_number
component_number
component_list
Page 153
Help Site
CrossRef Help
CrossRef Schema
^top
Content type: Conference Proceedings (documentation)

Required Elements
Series: titles, ISSN, ISBN*required if volume title and volume number are present
Proceeding level: ISBN, proceedings_title, publisher, publication_date (year)
Conference paper: contributors, titles, doi_data
Series level: doi_data, contributors, coden, series_number

Conference level: volume, contributors, event_metadata (conference_date, conference_location, conference_acronym,
conference_theme, conference_sponsor, conference_number), proceedings_subject
Conference paper: publication_date, pages, citation_list
Optional Elements
publisher_item
component_list
^top
Content type: Dissertation (documentation)
Required Elements
person_name
titles
approval_date
institution
doi_data
ISBN
degree
Optional Elements
citation_list
component_list
^top
Report-paper (documentation)
Required Elements
Series level: titles, ISSN

Report level: title, publication_date (year)
Series level: contributors, coden, series_number, volume, doi_data, edition_number, approval_date, publisher, institution,
doi_data, citation_list
Report level: contributors, edition_number, approval_date, ISBN, publisher, institution, citation_list
Optional Elements
publisher_item
contract_number
Page 154
Help Site
CrossRef Help
CrossRef Schema
^top
Standard (documentation)
Required Elements
Series level: titles, ISSN, publication_date (year), approval_date

Standard level: title, publication_date (year), approval_date
Item level: contributors, titles, component_number, publication_date (year), pages, publisher_item, doi_data
Series level: contributors, coden, series_number, edition_number, publisher, institution, citation_list, doi_data
Standard level: contributors, edition_number, ISBN, institution, citation_list
Item level: citation_list
Optional Elements
publisher_item
content_item
component_list
^top
Database (documentation)
Required Elements
Database level: titles

Dataset level: doi_data
Database level: contributors, description, database_date, publisher, institution, doi_data

Dataset level: contributors, titles, database_date, description, format, citation_list, component_list
Optional Elements
publisher_item
component_list
Page 155
Help Site
CrossRef Help
CrossRef Schema
Face markup
The CrossRef schema supports minimal face markup in order to avoid ambiguity in certain disciplines (e.g. Genetics, where the
same text may be a gene (when italicized) or a protein (when not italicized).
Face markup that appears in the title, subtitle, original_language_title, and unstructured_citation elements should be retained when
depositing metadata. Face markup in other elements (e.g. small caps in author names) must be dropped. Face markup support
includes bold (b), italic (i), underline (u), over-line (ovl), superscript (sup), subscript (sub), small caps (scp), and typewriter text (tt).
Examples where inclusion of face markup is especially important include:
1. Italic in titles for terms such as species names or genes
2. Super and subscript in titles as part of chemical names (e.g. H20)
3. Super and subscript in simple inline mathematics (e.g. x2 + y2 = z2)
The schema supports nested face markup (e.g. "This text is bold and italic"), which would be tagged as:
This text is <b><i>bold and italic</i></b>
Correspondingly, super and subscript may be nested for correct representation of xyz. This expression should be tagged as:
x<sup>y<sup>z</sup></sup>
As of schema version 4.3.2, CrossRef supports MathML markup in the title elements.
Page 156
Help Site
CrossRef Help
CrossRef Schema
Including MathML in deposits

Beginning with schema version 4.3.2, MathML may be included in the title, subtitle, and original_language_title elements.
The MathML namespace (mml) must be defined in the schema declaration, for example:
<doi_batch version="4.3.2"
xmlns="http://www.crossref.org/schema/4.3.2" xmlns:xsi=
"http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation=
"http://www.crossref.org/schema/4.3.2 http://www.crossref.org/schemas/crossref4.3.2.xsd"
xmlns:jats="http://www.ncbi.nlm.nih.gov/JATS1" xmlns:mml=
"http://www.w3.org/1998/Math/MathML">
and all MathML markup must include a mml namespace prefix:
<journal_article publication_type="full_text">
<titles>
<title>Selectron production at an
<mml:math><mml:msup><mml:mi>e</mml:mi><mml:mo>−</mml:mo></mml:msup>
<mml:msup><mml:mi>e</mml:mi><mml:mo>−</mml:mo></mml:msup></mml:math> linear
collider with transversely polarized beams</title>
</titles>
Page 157
Help Site
CrossRef Help
CrossRef Schema
Deprecated deposit schema

Deposit schema prior to v. 4.3.0 are no longer supported.
The documentation for the 4.1.0 version of the schema is provided in

http://www.crossref.org/schema/info/CrossRefSchemaDocumentation4.1.0.pdf
A zip file containing the PDF documentation, sample XML files and the XSD file for v. 4.1.0 is also available:
CrossRefSchema4.1.0.zip
The documentation for the 2.0.X versions is still available at CrossRef Schema Documentation. The full development package
for the 2.0.X version that contains the PDF documentation , sample XML files and the XSD file by clicking on the following link:
CrossRef Schema Package.
Page 158
Help Site
CrossRef Help
Guidelines, Policies, and FAQs
FAQ: DOI display guidelines

Frequently asked questions about CrossRef's DOI Display Guidelines:
Should the new format be used on CrossRef DOI response pages? Doing so results in a self-referencing link back to the page the
reader is already on. Should we just display the DOI URL without making it a link?
The goal of the CrossRef guidelines is to have the DOI used as the permanent link to the article. The CrossRef DOI should always
be displayed as part of the bibliographic information for the articlethe permanent link to the articleso having it on response
page as part of the bibliographical metadata is logical. Whenever the DOI is displayed it should be a link if possible. Selfreferencing links often appear on the web. For example, clicking the logo or company name on a web site often reloads a home
page. Blogs frequently include links to the page that a user is on. While it may be confusing at first for some users, the
advantages, which include being able to use browser tools like the right-click to bookmark or copy a URL, and the ability for
machines to read the DOI as a link, outweigh the drawbacks. When most scholarly publishers adapt this convention, users will
quickly learn what the behavior of the link is.
Our Tables of Contents include multiple links to different versions of the content (PDF, HTML, and Abstract). Some publishers
display the DOI on Tables of Contents, and some just hide the links under descriptive text. What should we do?
The guidelines recommend that Tables of Contents include a link to the response page in the URL format. Publishers may also
choose to include other links directly to parts of the article.
Will adopting the new display guidelines have negative impact on a publishers citations in Thomsons Web of Science?
No, the new format will have no effect on citation rankings.
Should we use the URL format in print and PDF as well as on HTML pages?
Yes, it would be preferable to display the DOI as a link whenever feasible. Doing so will help users to understand what to do with
the DOI (click on the link or copy it), will help machines properly render and process the link (for example on a mobile reading
device), and will provide a consistent experience for users. Publishers will need to weigh these advantages against the costs (for
example, in using additional space for DOIs, or in possibly re-rendering older PDFs). For these reasons, the guidelines are
recommendations, not requirements.
Should we continue to put the DOI behind linking text in our references, or should we display reference links using the new
guidelines?
The guidelines include recommended options for reference linking, which include using the URL format, using a text link, or using
a new CrossRef linking graphic.
Page 159
Help Site
CrossRef Help
Guidelines, Procedures, and Resources

CrossRef Guidelines
CrossRef DOI Guidelines - This document provides basic information about DOI syntax and use.
Guidelines for Standard Citations in Author Postings (pdf) 32KB - These guidelines outline best practices for linking from an
author posting of a postprint or preprint work within a repository to the related definitive publication. CrossRef recommends
that publishers communicate these guidelines to their authors and to Institutional Repositories.
CrossRef Glossary - This glossary defines standard terms used in the description of published works, unpublished works, posted
works, and versions. Comments and feedback on the Glossary are welcome - please email irc@crossref.org.
DOIs in Citation Export Services Guidelines (pdf) 21KB - This document guides publishers on how to integrate DOIs into their
"Download Citation"/"Export References" services.
Metadata Guidelines - These guidelines outline best practices in publisher submission of metadata to CrossRef, in order to
enhance the quality of CrossRef's metadata and our ability to provide various services.
Best Practices
Best practices for depositing

Best practices for querying
Best practices for journal titles
Depositing journal title-level DOIs
Best practices for maintaining DOIs and metadata
Best practices for books (website)
CrossMark Best Practices for Publishers (website)
Policies and Procedures
Title and DOI name Ownership/ Control Policy and Transfer Procedures (pdf) 83KB
DOI Conflicts - definition, management, and penalty fee policy
Groups and mailing lists
Support forum: announcements regarding system status or changes are posted in the Announcements forum (public). TWG
Discussion(requires support login) replaces the TWG mailing list. Intended topics include technical matters related to Crossref's
services, DOI issues and Crossref system operation.
The Technical Working Group has been dissolved but the mailing list archives are still available.
Page 160
Help Site
CrossRef Help
DOI Conflicts: definition, management and penalty fee policy

Definition
It is CrossRef policy that only one DOI be created for a given work. However, it is very difficult to prevent the assignment of multiple
DOIs to the same work owing to the reliability and consistency of the metadata provided in a deposit and to accepted publisher
practices.
A conflict exists when two or more DOIs have been assigned to the same logical work as represented by identical metadata or when
subtle metadata differences may exist (e.g. a slight variation in the publication title or style differences in the item title).
Management
System identified conflicts
The CrossRef system attempts to automatically identify a conflict upon deposit of the second (or later) DOI name. This function
looks for exact duplication in the deposited metadata (journal | author | volume | issue | page | year | article-title) with that of a preexisting DOI name. Omitted metadata is not included in the comparison thus two DOI names for the same article where one omits
page number will not produce a system identified conflict.
After making a deposit you will receive an XML log showing the results of the deposit process. System identified conflicts will be
indicated as follows:
<doi>10.1007/s10530-007-9098-9</doi>
<dois_in_conflict>
<doi>10.1007/s10530-006-9073-x</doi>
</dois_in_conflict>
Once a week an on-line report is generated that list all known unresolved system conflicts
(http://www.crossref.org/06members/59conflict.html). In addition emails are periodically sent out to publisher technical contacts.
Repair of system identified conflicts
System identified conflicts where all DOIs are owned by the same publisher may be repaired by the publisher themselves. This is
done either by using the user interface on doi.crossref.org (Metadata Admin -> Conflicts) or by uploading batch files to the system
(ref. http://help.crossref.org/#resolving-conflicts). Conflicts which involve DOI names owned by more than one publisher require the
intervention of CrossRef staff
Non-system identified conflicts
Since not all conflicts can be identified automatically by the system during deposit we have developed a secondary tool called the
Missed Conflict Checker. This tool is available from the Browsable Title List (http://www.crossref.org/titleList) where you can lookup
which titles are held by CrossRef. Once a journal title is found you may select the
icon to run a missed conflict report. This report
may be run on multiple journal titles at the same time. The tool uses a less strict comparison and produces a report needing careful
manual investigation.
Repair of non-system identified conflicts
Since by definition there is no system conflict to resolve the only repair solution is to use the forced prime/alias feature that is
available using the batch upload process described above.
Preventative Measures
CrossRef strives to prevent conflicts from being created. One major resource to employ in this endeavor is the systems title
ownership (aka. title lock-down) feature. This feature limits DOI name deposits to one publisher (the publication owner). Currently
any new publication created is assigned ownership to the publisher creating the first DOI name. This helps to prevent accidental
Page 161
Help Site
CrossRef Help
creation of duplicative DOI names.
Penalty fee
In July of 2007 the CrossRef board approved a penalty fee (set at $2/conflict) to be levied against the creator of conflicts under
certain conditions. The following situations, with the exception conditions listed below, will result in the penalty fee being assessed.
In cases of title ownership transfer it is the responsibility of the acquiring publisher to determine if DOI names already exist for
items and to re-use them.
1. After having acquired ownership of a publication a publisher deposits new DOI names for items (e.g. articles) that were
already assigned DOI names by the former owner.
2. Upon moving to a new hosting platform, if the new platform automatically assigns new DOI names to items which were
already assigned DOI names by the former hosting platform.
3. If a publication is co-hosted on multiple platforms or by multiple publishers and both parties using separate prefixes deposit
DOI names for the same items
4. If the conflict is a non-system identified conflict which is brought to the attention of CrossRef staff by a third party or
discovered by CrossRef staff.
Exception conditions:
If a conflict is created where all DOI names involved are of the same prefix and /or owner and the depositing member resolves the
conflicts without involvement from CrossRef staff.
Appeals
If a member feels a levied fee is inappropriate review escalation will be 1) Director of Technology, 2) Executive Director, 3)
Metadata Quality Committee and 4) the CrossRef board of Directors.
What are conflicts?, Resolving conflicts
Page 162
Help Site
CrossRef Help
Useful Tools
VBClient is a handy application for accessing the CrossRef system. This software is a sample for functionality, is distributed "as
is," and is not supported by CrossRef.
doUpload: sample Java program for uploading files to CrossRef (details)
XML Tools: validate XML against CrossRef schema and perform Schematron-based metadata quality checks.
Xerces XML parser is a minimal installation of the Xerces parser. Set your CLASSPATH to the directory to which you unzip the
file and to the three JAR files. To run the parser, type java XercesChecker <file.xml>.
HttpSniffer is a Perl program that acts as a simple HTTP proxy. Use this program to intercept and display the messages being
sent to CrossRef to help debug interface problems.
Page 163

CrossRef Help Site

Transféré par

Informations du document

Description originale:

Copyright

Formats disponibles

Partager ce document

Partager ou intégrer le document

Options de partage

Avez-vous trouvé ce document utile ?

Ce contenu est-il inapproprié ?

Droits d'auteur :

Formats disponibles

CrossRef Help Site

Transféré par

Droits d'auteur :

Formats disponibles

CrossRef Help

copyright CrossRef. All rights reserved.

Ancillary metadata ................................................................................................................................................................ 44

Missing Metadata / Field Report ...................................................................................................................................... 99

MathML ............................................................................................................................................................................... 157

About CrossRef DOIs

Copyright 2012 CrossRef

About CrossRef DOIs

How do CrossRef DOIs work?

Copyright 2012 CrossRef

About CrossRef DOIs

Who uses CrossRef DOIs and why?

Publisher + show benefits

CrossRef publishers and titles

Copyright 2012 CrossRef

About CrossRef DOIs

Examples of CrossRef DOIs in use

Copyright 2012 CrossRef

How CrossRef works

The references being cited within the item

How it fits together

Copyright 2012 CrossRef

Qualifications for membership

Copyright 2012 CrossRef

CrossRef publishers and titles

View a list of the publishers that use CrossRef DOIs

Copyright 2012 CrossRef

Copyright 2012 CrossRef

Obtaining a DOI prefix

Copyright 2012 CrossRef

Establishing a DOI suffix pattern

Sample suffix patterns

Copyright 2012 CrossRef

Creating response pages

Sample response page: + show/hide

Copyright 2012 CrossRef

How depositing works

Copyright 2012 CrossRef

How querying works

Copyright 2012 CrossRef

Creating outbound links

Copyright 2012 CrossRef

CrossRef for libraries

Copyright 2012 CrossRef

DOIs, OpenURL, and link resolvers

Why libraries need local link resolvers

How the DOI System and OpenURL work together

Copyright 2012 CrossRef

Setting up your system for localized linking

Copyright 2012 CrossRef

Copyright 2012 CrossRef

Depositing DOIs and metadata

Reviewing submission logs

Copyright 2012 CrossRef

Depositing DOIs and metadata

Deposit content types: what can be deposited?

Copyright 2012 CrossRef

Depositing DOIs and metadata

DOI resource deposits

Copyright 2012 CrossRef

Depositing DOIs and metadata

Journal title-level DOIs

Depositing title-level DOIs