XX[OLD] Document Types not updated for WOS

Document Types

ScienceWire document types are listed in:

• http://images.webofknowledge.com/WOKRS59B4/help/WOS/hs_document_type.html
• (The information in the doc above needs to be verified; March, 2016)

CAP UI document types

New document types and their UI fields:

• https://github.com/sul-dlss/sul_pub/files/155389/Manually_Entered_Records_revised_17Feb2016_TN_v2.xlsx
• In summary: some new document types in the CAP UI will be:
  • Working Paper
  • Case Study
  • Technical Report
  • Other

Here is a word document Grace Baysinger created that shows the kind of ways people create "working papers", "tech reports", "research papers", etc. You will see that Grace bounced all over the place capturing examples of what fields folks use for these kinds of papers. It is a bit of an overwhelming doc! I put this here so you can see the kinds of papers folks will be adding in. Also, folks asked for these examples in order to look at what the label should be for "placeOfPublication". As you can see, it's a "catchall field" and not the same as institution.

• Report_citation_format_revised_6Jan2016.docx

sul_pub code

Relevant code searches related to document types:

• https://github.com/sul-dlss/sul_pub/blob/master/config/application.yml
• https://github.com/sul-dlss/sul_pub/search?utf8=%E2%9C%93&q=sw_doc_types_to_skip
• https://github.com/sul-dlss/sul_pub/search?utf8=%E2%9C%93&q=sw_doc_type_mappings
• https://github.com/sul-dlss/sul-pub/search?utf8=%E2%9C%93&q=sul_doc_types

db/schema.rb

Reviewing the db/schema.rb:

• Publication has a publication_type field.
  • The Publication model has a before_save method that extracts a publication_type field from an optional pub_hash[:type] field in the submitted source data.
• There are no doc types in:
  • BatchUploadedSourceRecords
  • Contributions
  • PublicationIdentifiers
  • PubmedSourceRecords
  • SciencewireSourceRecords
  • UserSubmittedSourceRecords

pub_hash[:type]

So long as a document type is provided or assigned in pub_hash[:type], it will be assigned to Publication.publication_type (a String field supporting 255 chars). This field is not yet indexed (see https://github.com/sul-dlss/sul_pub/blob/master/db/schema.rb#L117-L123, as of Mar, 2016).

The pub_hash[:type] field is also used in the PubHash citation code, e.g.

• https://github.com/sul-dlss/sul_pub/blob/master/app/models/pub_hash.rb#L101
• https://github.com/sul-dlss/sul_pub/blob/master/app/models/pub_hash.rb#L118
• https://github.com/sul-dlss/sul_pub/blob/master/app/models/pub_hash.rb#L129
• https://github.com/sul-dlss/sul_pub/blob/master/app/models/pub_hash.rb#L160

ScienceWireSourceRecord

Additional doc-type code is in the ScienceWireSourceRecord at Note that the SciencewireSourceRecord model contains some logic for handling different document types in

• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L169-L171
• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L201-L228
• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L241-L251
• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L253-L259

It can map everything from SW to an article unless it has doc-type 'Conference Proceedings Document' (Mar, 2016); so most SW harvested items will have pub_hash[:type] == 'article'. See

• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L169-L171
• https://github.com/sul-dlss/sul-pub/blob/master/app/models/sciencewire_source_record.rb#L253-L259
• It seems possible that this method could use the Settings.sw_doc_type_mappings (or a modified version of it) at https://github.com/sul-dlss/sul-pub/blob/master/config/application.yml#L4
• A related commit is in https://github.com/sul-dlss/sul-pub/commit/b5209922221cb6cd150a5f8982be9f741fd57830

The SciencewireSourceRecord.lookup_sw_doc_type is not used anywhere according to this github search:

• https://github.com/sul-dlss/sul-pub/search?utf8=%E2%9C%93&q=lookup_sw_doc_type

PubmedSourceRecord

All of the PubMed records are assigned the article doc-type by

• https://github.com/sul-dlss/sul_pub/blob/master/app/models/pubmed_source_record.rb#L124

UserSubmittedSourceRecord

There is no doc-type logic in the UserSubmittedSourceRecord.

/authorship API can bypass doc-type filtering

The /authorship API enables an author to associate their profile with a publication that must be retrieved by using a PubMedID or WOS ID, see

• https://github.com/sul-dlss/sul-pub/blob/master/app/api/sul_bib/authorship_api.rb#L176-L200
• Publication#find_or_create_by_sciencewire_id
  • See also the possible call stack for the following methods (listed by successive calls):
  • SciencewireSourceRecord.get_pub_by_sciencewire_id
  • SciencewireSourceRecord.get_sciencewire_hash_for_sw_id
  • SciencewireSourceRecord.get_sciencewire_source_record_for_sw_id
  • SciencewireSourceRecord.get_sciencewire_source_record_from_sciencewire_by_sw_id
  • SciencewireSourceRecord.get_and_store_sw_source_record_for_sw_id
  • ScienceWireClient#get_sw_xml_source_for_sw_id
  • ScienceWireClient#get_full_sciencewire_pubs_for_sciencewire_ids

This application code path allows a CAP author to create a contribution for a publication with any doc-type (e.g. 'Book Review') and the application will get the publication from a ScienceWire and/or PubMed service. The resulting Publication will have a provenance corresponding to the retrieved service. In this application path, all the filters to exclude some doc-types are NOT engaged. So, in this manner, a CAP author can "demand" a specific document retrieval based only on it's PubMed ID or WOS ID and there is no filtering of any doc-types.