The Crossref Curriculum

Submission queue and log

To see the submission queue, log in to the admin tool, and click Show My Submission Queue on the opening page (or click Submissions, then Show System Queue). At the top of the page, you will see at the submissions that are being actively processed at the moment. They are listed individually by submission ID number, along with file name, file type, percent completed, and timestamps.

The submissions that queueing to be processed are displayed at the bottom of the page. They are grouped by depositor ID (admin tool username). Click + under Details (on the left, next to your depositor ID) to expand a list of your deposits waiting to be processed. You will also see the submission ID, filename, and position in the queue.

It typically takes only a few minutes for a submission to be picked up for processing and then for the processing to be completed. Processing may take longer depending on overall system traffic, and submission size and complexity. If you’re concerned about your submission processing time, or are planning a large update and would like to coordinate with us about timing, please contact us.

All files uploaded to our system are initially placed in a submission queue. When your deposit or query file has been processed, we’ll generate a submission log containing the final status of your submission. You should review these logs to make sure your content was registered or updated successfully. Logs are delivered through these channels:

  • Email - we send you an XML-formatted log for every file uploaded to our system. The log is sent to the email address you provided when using the web deposit form or Simple Text Query, or included in the <email_address> field in your deposit XML.
  • Polling - see using HTTPS to retrieve logs
  • View past deposits using the admin tool
  • Notification callback service

If you’re using Metadata Manager, we immediately process the deposit and display the results for accepted and rejected deposits.

Read on to learn more about:

View past deposits

If you didn’t receive a submission log email, you can use the admin tool to search for past deposits:

  1. Log in to the admin tool with your Crossref username and password
  2. Click the Submissions tab, then the Administration sub-tab
  3. Click Search at the bottom of the screen, and you’ll see a list of all past deposits for your account, from newest to oldest.
  4. Click on the Submission ID number to the left of any deposit to access the Submission details, including the submission log for that deposit, or click on the file icon to view the file that was submitted.

After step 3 above, you can also narrow your search by entering parameters into any of the following fields on the Submissions administration sub-tab page:

  • Select a date range using the Last Day, Last Three Days, or Last Week buttons, or enter a custom date range to search for older deposits
  • If your account submits metadata deposits for multiple prefixes, you can use the Registrant field to narrow your search to just the deposits for a single prefix.
    • Click Find next to Registrant
    • In the pop-up window, enter the member name associated with the prefix and click Submit
    • Select the appropriate member name/prefix and the pop-up window will close. You’ll see a code for that prefix entered in the Registrant field
  • Select a deposit type from the Type drop-down menu to limit your search to just one type of deposit.
    • Metadata will limit results to full metadata deposits. This is the most common type.
    • DOI references will limit results to resource deposits, including references, Similarity Check full-text URLs, funding metadata, and license metadata
    • Conflict Undo will limit results to text files that were deposited to resolve conflicts
  • Check the Has Error box to only search for deposits with errors.
  • Check the Has Conflict box to only search for deposits with conflicts.

View the history of a DOI

Find the deposit history of an individual DOI using the admin tool, including all deposit files and submission logs.

To view a DOI history report:

  1. Log in to the admin tool using your Crossref username and password
  2. Click the Report tab
  3. Type or paste a DOI into the box
  4. Click Show to view its report.

The report lists every successful deposit or update of the DOI being searched. View the submission details (including log and submitted XML) by clicking on the submission number:

View the history of a DOI

Use HTTPS to retrieve logs

In addition to the submission report you receive by email, you can also retrieve the results of submission processing or the contents of a submission at any time through this URL:

https://0-doi-crossref-org.lib.rivier.edu/servlet/submissionDownload?usr=_username_&pwd=_password_&doi_batch_id=_doi batch id_&file_name=filename&type=_submission type_

where:

  • usr is the Crossref-supplied username
  • pwd is the Crossref-supplied password
  • doi_batch_id is the DOI batch ID you supplied in the XML deposit file (not recommended)
  • file_name is the name of the file that you submitted (recommended)
  • type is the type of data requested (this field is mandatory)
    • Use result to retrieve submission results (deposit log)
    • Use contents to retrieve the XML file

You can track a submission by its doi_batch_id or by its file_name, but file_name is recommended. To use this feature effectively, make sure each tracking ID (doi_batch_id or file_name) is unique as only the first match is returned.

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.

Interpret submission logs

Submission logs contain important information about the DOIs and metadata you have submitted to our system. They let you know if your content is registered successfully, and if not, what issues need to be addressed.

Your logs are by default emailed to the address provided in your registration XML or entered in our web form. You may also use the admin tool to search for past deposits or retrieve them by polling.

Examples of a log:

Example of a log for a successful deposit

Note that the <failure_count> = 0 and that the <record_count> = <success_count>.

<?xml version="1.0" encoding="UTF-8"?>
 <doi_batch_diagnostic>
  <submission_id>9349810</submission_id>
  <batch_id>FINAL_001</batch_id>
  <record_diagnostic status="Success">
   <doi>10.5555/second_conflict_003</doi>
   <msg>Successfully added</msg>
  </record_diagnostic>
  <batch_data>
   <record_count>1</record_count>
   <success_count>1</success_count>
   <warning_count>0</warning_count>
   <failure_count>0</failure_count>
  </batch_data>
 </doi_batch_diagnostic>

Example of a log with deposit errors

This is an example of a deposit containing errors. In the example, note that the <success_count> and <record_count> do not match. A status of “Failure” indicates the record was rejected and the DOI was not registered or updated. The <record_diagnostic> for each registration failure contains an error message. Each error within a deposit should be corrected and the deposit resubmitted. Learn more about error and warning messages.

<?xml version="1.0" encoding="UTF-8"?>
 <doi_batch_diagnostic status="completed" sp="cr5.crossref.org">
  <submission_id>394260418</submission_id>
  <batch_id>314668373.xml</batch_id>
  <record_diagnostic status="Failure">
   <doi>10.5555/11111</doi>
   <msg>Record not processed because submitted version: 20070904093839 is less or equal to	previously submitted version (DOI match)</msg>
  </record_diagnostic>
  <record_diagnostic status="Failure" msg_id="4">
   <doi>10.5555/44444</doi>
   <msg>Record not processed because submitted version: 20070904093839 is less or equal to	previously submitted version (DOI match)</msg>
  </record_diagnostic>
  <record_diagnostic status="Success">
   <doi>10.5555/55555</doi>
   <msg>Successfully added</msg>
  </record_diagnostic>
  <batch_data>
   <record_count>3</record_count>
   <success_count>1</success_count>
   <warning_count>0</warning_count>
   <failure_count>2</failure_count>
  </batch_data>
</doi_batch_diagnostic>

Example of a log with XML validation error

This is an example of a submission log for a deposit with an error that prevented all DOIs from being processed. This happens when there are XML formatting issues, or if the uploaded item is not XML. Note that <record_count> and <failure_count> both equal 1. This will be true no matter how many DOIs were actually included in the submission.

<?xml version="1.0" encoding="UTF-8"?>
 <doi_batch_diagnostic status="completed" sp="ds3.crossref.org">
  <submission_id>394260418</submission_id>
  <batch_id>314668373.xml</batch_id>
  <record_diagnostic status="Failure" msg_id="29">
   <doi />
   <msg>Deposited XML is not well-formed or does not validate: Error on line 1: Content is not allowed in prolog.</msg>
  </record_diagnostic>
  <batch_data>
   <record_count>1</record_count>
   <success_count>0</success_count>
   <warning_count>0</warning_count>
   <failure_count>1</failure_count>
  </batch_data>
 </doi_batch_diagnostic>

Example of a log with warnings

This is an example of a submission log with warnings. Warnings almost always indicate that DOIs have been successfully deposited and were flagged as a conflict with a previously deposited DOI.

<?xml version="1.0" encoding="UTF-8"?>
 <doi_batch_diagnostic status="completed" sp="ds4.crossref.org">
  <submission_id>394260418</submission_id>
  <batch_id>314668373.xml</batch_id>
  <record_diagnostic status="Success">
   <doi>10.5555/11112</doi>
   <msg>Successfully added</msg>
  </record_diagnostic>
  <record_diagnostic status="Warning">
   <doi>10.5555/11113</doi>
   <msg>Added with conflict</msg>
   <conflict_id>5166446</conflict_id>
	<dois_in_conflict>
 	<doi>10.5555/22223</doi>
	</dois_in_conflict>
  </record_diagnostic>
  <record_diagnostic status="Success">
   <doi>10.5555/11114</doi>
   <msg>Successfully added</msg>
  </record_diagnostic>
  <record_diagnostic status="Warning">
   <doi>10.5555/11115</doi>
   <msg>Added with conflict</msg>
   <conflict_id>5166447</conflict_id>
	<dois_in_conflict>
 	<doi>10.5555/22225</doi>
	</dois_in_conflict>
  </record_diagnostic>
  <batch_data>
   <record_count>4</record_count>
   <success_count>2</success_count>
   <warning_count>2</warning_count>
   <failure_count>0</failure_count>
  </batch_data>
</doi_batch_diagnostic>

Example of a log containing references

This is an example of a submission log from a deposit containing references. Each reference in the deposit will be included in the log, identified by the citation key included in the deposit.

<?xml version="1.0" encoding="UTF-8"?>
 <doi_batch_diagnostic status="completed" sp="ds5.crossref.org">
  <submission_id>03480197</submission_id>
  <batch_id>XYZ00000000</batch_id>
  <record_diagnostic status="Success">
   <doi>10.5555/example</doi>
   <msg>Successfully updated</msg>
   <citations_diagnostic>
 	<citation key="10.5555/example_bb0030" status="error">Either ISSN or Journal title or Proceedings title must be supplied.</citation>
 	<citation key="10.5555/example_bb0005" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0010" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0015" status="resolved_reference">10.1590/S0006-87051960000100077</citation>
 	<citation key="10.5555/example_bb0045" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0050" status="resolved_reference">10.1007/BF01916741</citation>
 	<citation key="10.5555/example_bb0075" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0080" status="resolved_reference">10.1093/jxb/4.3.403</citation>
 	<citation key="10.5555/example_bb0085" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0090" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0095" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0100" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0105" status="resolved_reference">10.1038/181424b0</citation>
 	<citation key="10.5555/example_bb0110" status="resolved_reference">10.1038/1831600a0</citation>
 	<citation key="10.5555/example_bb0115" status="resolved_reference">10.1007/BF01912405</citation>
 	<citation key="10.5555/example_bb0120" status="resolved_reference">10.1038/185699a0</citation>
 	<citation key="10.5555/example_bb0125" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0150" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0155" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0160" status="resolved_reference">10.1038/1781359a0</citation>
 	<citation key="10.5555/example_bb0165" status="resolved_reference">10.1093/jxb/13.1.75</citation>
 	<citation key="10.5555/example_bb0170" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0175" status="resolved_reference">10.2134/agronj1960.00021962005200080014x</citation>
 	<citation key="10.5555/example_bb0180" status="resolved_reference">10.2134/agronj1960.00021962005200080015x</citation>
 	<citation key="10.5555/example_bb0185" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0190" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0195" status="resolved_reference">10.1007/BF00622243</citation>
 	<citation key="10.5555/example_bb0200" status="resolved_reference">10.4141/cjps58-055</citation>
 	<citation key="10.5555/example_bb0205" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0210" status="stored_query"></citation>
 	<citation key="10.5555/example_bb0215" status="resolved_reference">10.1038/178601a0</citation>
 	<citation key="10.5555/example_bb0220" status="stored_query"></citation>
 	</citations_diagnostic>
   </record_diagnostic>
  <batch_data>
 	<record_count>1</record_count>
 	<success_count>1</success_count>
 	<warning_count>0</warning_count>
 	<failure_count>0</failure_count>
  </batch_data>
</doi_batch_diagnostic>

Last Updated: 2020 April 8 by Laura J. Wilkinson