README.md

doi_crossref_workflow

Workflow for establishing new NYU CrossRef DOIs and transforming required metatdata

Steps in automation workflow for journal content type (example)

1. Client fills in preliminary Google spreadsheet (copied from our template, but remaining in our owned Drive folder) with journal title and publication info, then at least title and author info for each article in that issue. At this point, these are placeholders so we know how many DOIs to mint and how umbrella objects (e.g. a journal issue) relate to sub-objects (e.g. an article).
2. Service provide runs script to read from template GSheet, then does a second call to the master DOI registry pull in list of previously registered DOIs from master GSheet (to prevent collision).
3. In same step, script generates the correct number of unregistered draft DOIs and adds them to the template for each article.
4. Client uses these DOIs to place them on electronic assets, e.g. the journal issue and article.
5. Client fills out the remainder of the template with full metadata if not completed already.
6. Second script reads the template again and transforms the full metadata to a valid XML record for upload to CrossRef. Script uses pre-established XML templates and fills it in with metadata gleaned from template GSheet
7. XML is validated using CrossRef validator (https://www.crossref.org/02publishers/parser.html)
8. XML is sent to CrossRef to register and activate DOIs
9. Master registry sheet is updated by hand to reflect newly registered DOIs

File Components

doi_crossref_workflow
│───README.md
│───LICENSE    
│
│───xml_templates/
│   │  
│   │───serials_template.xml
|   │───report_template.xml
│   └───website_template.xml
│   
│   
│───utils/
│   │
│   │───__init__.py   
│   │───doi_mets.py
│   │───sheets_creds_builder.py
│   |───xml_builder.py   
|   └───gsheets_manager.py
│
└───doi_manager.py

1. Two utilities to handle separate aspects of the workflows:

• doi_mets.py : classes and functions to handle instantiating a doi production session (including "minting" proposed DOIs and generating resulting XML). These might include:

class MetsHandler()

A list-of-dictionaries object representing the set of all objects receiving Dois in a single session, each object in turn represented by a dictionary with the keys as metadata fields (i.e. column headers from gsheet template) and values the user-entered values. Has methods that 1. produce proposed non-colliding DOI suffixes for each object, 2. produces alternative formats for re-updating the gsheet (e.g. a list-of-lists version of itself).

• gsheets_manager.py: classes and functions to handle the read/write of metadata to and from template gsheets we provide to users as well as reading from our current registry of CrossRef NYU DOIs to handle collisions. These might include:

def retrieve_doi_mets(sheet_id)

A function to access the metadata in a gsheet template (identified using sheet_num) using previous oauth access object.

2. /xml_templates/serials_template.xml, website_template.xml, etc.: set of XML formatted templates meeting CrossRef upload standards and Django template-like approach to passing variables in the content of tags.

3. doi_manager.py: main script to run workflow. Should take as sysargv input the gsheet being used as the template and a setting as to whether this is a preliminary doi creation or an xml creation job.

4. /utils/sheets_creds_builder.py, a one-time use utility to generate GSheets access

Usage

Our sample GSheet template is at: https://docs.google.com/spreadsheets/d/1tT8Dr0yfm2mkiCOjbrt2XbPus_mhFfSPP-1eIlpzkFo

Dependencies

Google's Sheets API modules

pip install --upgrade google-api-python-client google-auth-httplib2 google-auth-oauthlib

Pulling Journal, Issue, and Article Metadata from GSheet and generating XML

1. git clone https://github.com/NYU-DataServices/doi_crossref_workflow.git

2. cd doi_crossref_workflow

3. Copy

   credentials.json

   and

   doi_workflow_token.json

   and

   global_settings.py

   files to this directory

4. After patron fills out basic information (journal and issue info; titles of articles), we can generate proposed DOIs for them:

python doi_manager.py build-doi serials GSHEET-ID

e.g.

python doi_manager.py build-doi serials 1lRSZcW-5me13p823kK7q_ow6cdZq1pw9-ohKENJ8N1k

5. This allows patron to then add the proposed DOIs to the e-copy and make the deposit in FDA, enabling Handle creation, record URL, etc. Patron then needs to finish filling out rest of GSheet so that we can make XML:

python doi_manager.py build-xml serials GSHEET-ID

OPTION: A default filename for the XML output based on the serial title will be created

If a custom file name is required, place one as the parameter after the GSHEET, omitting the .xml extension part of the name, e.g.

python doi_manager.py build-xml serials GSHEET-ID myJournal_vol10_issue1

6. If successful resulting XML will be produced in a 'crossref_xml_output.xml' or a filename using the custom filename entered as a parameter.

7. For cases where we just want to mint proposed DOIs to fill in gaps in legacy data, this option generates non-colliding DOIs based on our registry sheet and prints them out to terminal. The last parameter is the number of DOIs needed:

python doi_manager.py generate-pseudo-doi 5

To-Dos

Quality Assurance/Error checking:

• Error exception handling for Sheets/Validation step for GSheet for each of the two functions
• Create a function that analyzes info received from GSheet and looks for missing columns/identifies whether this is a case with abstracts, page numbers, etc. Sends warning to users about missing info so that scripts can be halted rather than failing
• Ability to include certain fields (like an abstract, page numbers) or not (would require "template" metadata object with a dictionary structure that reflects the fields wanted, plus XML templates that work for that type)
• Automate the XML validation against CrossRef schema (rather than rely on manual checking using CR interface)

Enhance capabilities:

• Adjust doi_manage.py for new FDA API call option to retrieve Handles. Possible steps are:

  1. Add steps in doi_manager.py to kick off API calls, matches, and write to GSheet
  2. Create new set of utils, dspace_manager.py, to make calls to FDA and match GSheet info to FDA info, return Handles to write to GSheet
  3. Enhance write_doi_mets() function to accommodate writing Handles

• Expand content types beyond serials to include reports, plus make whole system more extensible for future content types. Possible steps:

1. Review CrossRef XML formatting for report types
2. Build GSheet template to collect information needed for a report content type
3. Complete

   xml_templates/report_template.xml

   so that it is ready to use as report template

• Allow script to write registered DOIs to NYU's master sheet. Steps might include:

1. Compose

   doi_registration

   method to

   DoiMinter

   class so that minted DOIs can be written back to master NYU DOI sheet