CDI Document Attributes

Introduction

CDI document attributes provide specific information about the type of record. They do not replace but add value to the existing resource types. Their purpose is to display additional information about the record/item in the brief and full display, and to allow filter/search on these attributes as part of the resource type facet. The document attributes may be one of the following types:

Regular – These attributes display as text with a grey foreground color.
Warning – These attributes display as text with a red foreground color and appear first when multiple attributes appear for the record. They are used to warn users of a potential issue with a document in their search.

The following example shows a retracted publication:

CDI_RetractedPublication_DocumentationAttributeExample.png

Retracted Publication Warning Example

While in some cases the document attributes can be taken directly from a field in the source data, but in other cases we use words or phrases from the title or other metadata fields to identify them. Not all items in CDI can be associated with their attributes, but since we continuously update our content, newly flagged items will appear over time.

The following table lists the currently supported document attributes in CDI:

Document Attribute Name	Type	Definition
Review Article	Regular	An article that provides analysis, review or interpretation of a body of primary research on a specific topic. Presents a current state of the research on a particular topic or research area.
Primary Source	Regular	The primary sources provide first-hand testimony or direct evidence concerning a topic under investigation. They contain the actual textual material that is the subject of research. The Library of Congress refers to them as the "raw materials of history — original documents and objects which were created at the time under study."
Preprint	Regular	A preprint is a preliminary version of a scientific manuscripts that researchers share by posting to online platforms known as preprint servers before peer-review and publication in an academic journal. Preprints are typically published in Preprint servers, publicly available online archives that host preprints and their associated data.
Retracted Publication	Warning	A retraction is the action by which a published paper in an academic journal is removed from the journal because the publication contains such seriously flawed or erroneous data that its findings and conclusions cannot be relied upon. Unreliable data may result from honest error or from research misconduct. Datasets can also be retracted. The original article may and in most cases have a different date from the retraction notice.
Retraction Notice	Warning	A retraction notice typically accompanies the retraction of a scientific publication. It is a short article written by the editors or authors explaining the reason for a retraction.
Publication with Addendum	Warning	A publication that contains an addendum, a notification of an addition of information to an article.
Publication with Corrigendum	Warning	A publication with a correction notice or corrigendum, a change to the article that the author wishes to publish at any time after the article acceptance or publication, usually to correct an error.

CDI Attributes and Local Data

Currently, CDI document attributes cannot be used for local data. This is because CDI document types are not ‘regular’ resource types – they are returned in a separate PNX field (display/attribute) for display purposes, but are returned in the resource type facet as a regular resource type value.
They can also not be configured in Primo VE as secondary resource types.

The following example shows a CDI record with a CDI document attribute:

<display>
<type>text_resource</type>
<attribute>primary_source</attribute>
</display>
<facets>
<rsrctype>text_resource</rsrctype>
<rsrctype>primary_source</rsrctype>
</facets>

However, it is possible to use a CDI document attribute code as a local resource type for local data, but the display for local and CDI records is different:

For local records, the local resource type is displayed like any regular resource type.
For CDI records, the resource type is displayed as a document attribute (with grey or red text in the full/brief display, depending on the type).

For the resource type facet, the behavior is the same for local/CDI:

For blended searches, both local and CDI records are included in the same facet count and both are returned when the user selects the CDI attribute facet value.
For local, in case the same code is defined as a local resource type, the PNX will look similar to the following:

<display>
<type> primary_source</type>
</display>
<facets>
<rsrctype> primary_source</rsrctype>
</facets>

Configuration Options

To enable this functionality in Primo/VE, configuration is necessary per view to display CDI document attributes with a text indication in the brief and full display for CDI records. For information regarding your specific environment, see:

CDI Document Attribute Sources

The following table lists the current sources for each document attribute.

Document Attribute Name	Sources
Review Article	All records where XML field in the source data indicates the record is a review article. Sources: ACM, BMJ, CABI, Elsevier, Proquest, Pubmed, Springer
Primary Source	All records from the following collections: ProQuest History Vault Visual History Archive
Preprint	All records from ArXiv source where there is no DOI, or the DOI present in the record has the ArXiv prefix (10.48550/ ). If there is a DOI that does not equal the Arxiv prefix (10.48550/ ) in the ArXiv data – this means it has been published elsewhere and a published version is now available. In this case we will no longer assign the attribute Preprint.
Retracted Publication / Retraction Notice	All records where XML field in the source data indicates the record is a review article. Sources: CrossRef, Pubmed All records where no retraction information is available in the merged record from CrossRef or Pubmed, but where the title of the record includes an indication that the article is retracted, or that the article itself is a retraction notice. Sources: BMJ, Elsevier, Proquest, Scopus, Springer
Publication with Addendum	All records where XML field in the source data indicates the record is a publication with addendum. Sources: BMJ, Elsevier
Publication with Corrigendum	All records where XML field in the source data indicates the record is a publication with corrigendum. Sources: BMJ, Elsevier