Source System Quick Reference Guide (In Progress)

On this page

Overview (In Progress)

Requirements

The tables below provides a summary of the required classes and terms. Term requirements are subject to the use of the parent class where a term that belongs to an optional class are required if and only if, their parent class is in use.

Required Classes
Class Label Required
ods:SourceSystem Source System True
Required Terms
Term Label Class Required
ods:ID Id SourceSystem True
ods:type Type SourceSystem True
schema:version Version SourceSystem True
schema:dateCreated Date Created SourceSystem True
ods:creator Creator SourceSystem True
ods:translatorType Translator Type SourceSystem True

Open Digital Specimen

SourceSystem

ods:SourceSystem ods:ID ods:type schema:version schema:name schema:description schema:dateCreated ods:dateTombstoned ods:creator schema:url ltc:collectionManagementSystem ods:translatorType ods:dataMappingID
ods:SourceSystem Class
Qualified Term ods:SourceSystem
Label Source System
Definition Source System Model, used to describe data providing systems
ods:ID Property
Qualified Term ods:ID
Label Id
Definition Handle of the Source System
Examples
  • ['https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX']
ods:type Property
Qualified Term ods:type
Label Type
Definition The DOI to the FDO type of the object
Examples
  • ['https://doi.org/10.15468/1a2b3c']
schema:version Property
Qualified Term schema:version
Label Version
Definition Version of the Source System, https://schema.org/version
schema:name Property
Qualified Term schema:name
Label Name
Definition Name of the Source System as provided by the user, https://schema.org/name
Examples
  • ['Herbarium of University of Coimbra (COI)']
schema:description Property
Qualified Term schema:description
Label Description
Definition Description of the Source System as provided by the user, https://schema.org/description
Examples
  • ['The herbarium collection of the University of Coimbra is one of the oldest in Portugal, with specimens dating back to the 18th century.']
schema:dateCreated Property
Qualified Term schema:dateCreated
Label Date Created
Definition Timestamp of creation. Internally generated, https://schema.org/dateCreated
Examples
  • ['2021-06-01T12:00:000Z']
ods:dateTombstoned Property
Qualified Term ods:dateTombstoned
Label Date Tombstoned
Definition Timestamp SourceSystem was tombstoned and no longer active. Generated on request of the user
Examples
  • ['2021-06-01T12:00:000Z']
ods:creator Property
Qualified Term ods:creator
Label Creator
Definition The internal user ID of the creator of the Source System
Examples
  • ['e2befba6-9324-4bb4-9f41-d7dfae4a44b0']
schema:url Property
Qualified Term schema:url
Label Url
Definition Endpoint from which data may be retrieved
Examples
  • ['http://ipt.gbif.pt/ipt/archive.do?r=coi']
ltc:collectionManagementSystem Property
Qualified Term ltc:collectionManagementSystem
Label Collection Management System
Definition The collection management system that the source system is using, https://rs.tdwg.org/ltc/terms/collectionManagementSystem
Examples
  • ['Specify 7']
ods:translatorType Property
Qualified Term ods:translatorType
Label Translator Type
Definition The serialisation of the data the endpoint provides indicating what type of Translator is required
ods:dataMappingID Property
Qualified Term ods:dataMappingID
Label Data Mapping Id
Definition The Handle of the Mapping Object needed for this Source System
Examples
  • ['https://hdl.handle.net/20.5000.1025/XXX-XXX-XXX']