Difference between revisions of "GGBN Stable Identifiers"

From GGBN Wiki
Jump to: navigation, search
 
(17 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
GGBN’s stable identifiers (ggbnIds) are automatically created and assigned after harvesting for each [[Definition_of_GGBN_Terms#Material_entity | material entity]], e.g. DNA sample, tissue sample, specimen etc. An identifier can change its status, but will remain a reliable resource both for GGBN itself and other infrastructures.
+
GGBN’s stable identifiers (ggbnIds) are automatically created and assigned after harvesting for each [[Definition_of_GGBN_Terms#Material_entity | material entity]], e.g. DNA sample, tissue sample, specimen etc. An identifier can change its status, but will remain a reliably stable source both for GGBN itself and other infrastructures.
−
Each identifier is available as html or rdf. The html landing pages include a complete relationship graph, e.g. https://id.ggbn.org/2ZBRRK
+
Depending on the user agent, each call is redirected to an rdf or http representation of the relevant object. The html landing pages include a complete relationship graph, e.g. the following one for https://id.ggbn.org/2ZBRRK
  
−
[[File:Example identifier.png|center]]
+
[[File:Example identifier.png|800px|center|frame|mockup identifier relationship graph]]
  
 
* Identifiers are assigned based on the occurrenceID/UnitGUID (if provided) or the triplet (UnitID, SourceID, SourceInstitutionID).
 
* Identifiers are assigned based on the occurrenceID/UnitGUID (if provided) or the triplet (UnitID, SourceID, SourceInstitutionID).
−
* Changes in the occurrenceID/UnitGUID will lead to new identifiers. Any entity that is no longer provided by the member institution will be flagged as “DEPRECATED” and tombstone data will be published instead.
+
* Changes in the occurrenceID/UnitGUID will lead to new identifiers, redirects from old to new identifiers are possible and performed manually by the GGBN team in close collaboration with the member institution.
−
* Changes in the triplet with same occurrenceID will lead to a warning, but the existing identifier is recognised.
+
* GGBN follows [https://istc.cetaf.org/Best_practices_for_stable_URIs#Recommended_patterns_for_stable_URIs CETAF's approach] so that scheme and domain part of local guids (e.g. http://subdomain.yourdomain.org/) are allowed to be case-insensitive. All other parts (part, identifier) are required to be case sensitive.
−
* Changes in the occurrenceID will lead to the creation of new identifiers, redirects from old to new identifiers are possible and performed manually by the GGBN team in close collaboration with the member institution.
+
* Changes in the scheme (http vs. https) will lead to a warning and the existing GGBN identifier is kept.
−
* Identifiers assigned to entities that were published accidentally will be flagged as “FAILED” and no data will be published at all.
+
* The identifier status of any material entity that is no longer provided by the member institution will be changed to "DEPRECATED" and tombstone data will be published instead.
−
* As encoding algorhythm Crockford base32 is used.
+
* The identifier status of any material entity that is marked as "gone" or "used up" will be changed to "ARCHIVED". '''Data of consumed material entities should still be provided to GGBN!'''
 +
* Changes in the triplet with same occurrenceID will lead to a warning, but the existing GGBN identifier is kept.
 +
* The status of identifiers assigned to entities that were published accidentally will be changed to "FAILED" and no data will be published at all. If needed a relation to an "ACTIVE" GGBN identifier is in place
 +
* As encoding algorithm Crockford base32 is used.
 
* An overview about the different GGBN terms, including distinction between record and material entity can be found here: [[Definition_of_GGBN_Terms | Definition of GGBN Terms]]
 
* An overview about the different GGBN terms, including distinction between record and material entity can be found here: [[Definition_of_GGBN_Terms | Definition of GGBN Terms]]
 +
  
 
GGBN uses the identifier status suggested by DiSSCo (Addink, W. et al., 2023. https://doi.org/10.3897/arphapreprints.e107168) with small adjustments:
 
GGBN uses the identifier status suggested by DiSSCo (Addink, W. et al., 2023. https://doi.org/10.3897/arphapreprints.e107168) with small adjustments:
Line 18: Line 22:
 
! Status !! Remarks !! Example
 
! Status !! Remarks !! Example
 
|-
 
|-
−
| ACTIVE || material entity data available in portal, physical resource still there|| https://id.ggbn.org/2ZBR81  
+
| style="width: 10%" | ACTIVE  
 +
| style="width: 65%"| Material entity data available in portal, physical resource still exists || https://id.ggbn.org/2ZBR81  
 
|-
 
|-
−
| ARCHIVED || material entity data available in portal, physical resource gone (disposition=consumed), record kept for historical reasons || https://id.ggbn.org/35WXZ2  
+
| ARCHIVED || Material entity data available in portal, physical resource gone (disposition=consumed), record kept for historical reasons || https://id.ggbn.org/35WXZ2  
 
|-
 
|-
−
| DEPRECATED || material entity data removed by provider, GGBN shows tombstone data || https://id.ggbn.org/35YPPV  
+
| DEPRECATED || Material entity data removed by provider, GGBN shows tombstone data || https://id.ggbn.org/35YPPV  
 
|-
 
|-
−
| FAILED || data accidentally published and later removed by provider; GGBN shows only message and no data ||  
+
| FAILED || Data accidentally published and later removed by provider; GGBN shows only message and no data ||  
 
|-
 
|-
−
| INACTIVE || material entity data excluded from portal, entity from non GGBN member or non core GGBN member, that has been associated to a GGBN record previously, but is no longer related to any GGBN record || https://id.ggbn.org/30X3PY  
+
| INACTIVE || Material entity data excluded from portal, entity from non GGBN member or non core GGBN member, that has been associated to a GGBN record previously, but is no longer related to any GGBN record || https://id.ggbn.org/30X3PY  
 
|-
 
|-
−
| DRAFT || stable identifier assigned, material entity data not fully processed yet ||  
+
| DRAFT || Stable identifier assigned, material entity data not fully processed yet ||  
 
|}
 
|}
  
−
[[Category:Terms documentations]], [[Category:Data]]
+
[[Category:Terms documentations]] [[Category:Data]]

Latest revision as of 11:18, 7 August 2025

GGBN’s stable identifiers (ggbnIds) are automatically created and assigned after harvesting for each material entity, e.g. DNA sample, tissue sample, specimen etc. An identifier can change its status, but will remain a reliably stable source both for GGBN itself and other infrastructures. Depending on the user agent, each call is redirected to an rdf or http representation of the relevant object. The html landing pages include a complete relationship graph, e.g. the following one for https://id.ggbn.org/2ZBRRK

mockup identifier relationship graph
  • Identifiers are assigned based on the occurrenceID/UnitGUID (if provided) or the triplet (UnitID, SourceID, SourceInstitutionID).
  • Changes in the occurrenceID/UnitGUID will lead to new identifiers, redirects from old to new identifiers are possible and performed manually by the GGBN team in close collaboration with the member institution.
  • GGBN follows CETAF's approach so that scheme and domain part of local guids (e.g. http://subdomain.yourdomain.org/) are allowed to be case-insensitive. All other parts (part, identifier) are required to be case sensitive.
  • Changes in the scheme (http vs. https) will lead to a warning and the existing GGBN identifier is kept.
  • The identifier status of any material entity that is no longer provided by the member institution will be changed to "DEPRECATED" and tombstone data will be published instead.
  • The identifier status of any material entity that is marked as "gone" or "used up" will be changed to "ARCHIVED". Data of consumed material entities should still be provided to GGBN!
  • Changes in the triplet with same occurrenceID will lead to a warning, but the existing GGBN identifier is kept.
  • The status of identifiers assigned to entities that were published accidentally will be changed to "FAILED" and no data will be published at all. If needed a relation to an "ACTIVE" GGBN identifier is in place
  • As encoding algorithm Crockford base32 is used.
  • An overview about the different GGBN terms, including distinction between record and material entity can be found here: Definition of GGBN Terms


GGBN uses the identifier status suggested by DiSSCo (Addink, W. et al., 2023. https://doi.org/10.3897/arphapreprints.e107168) with small adjustments:

Status Remarks Example
ACTIVE Material entity data available in portal, physical resource still exists https://id.ggbn.org/2ZBR81
ARCHIVED Material entity data available in portal, physical resource gone (disposition=consumed), record kept for historical reasons https://id.ggbn.org/35WXZ2
DEPRECATED Material entity data removed by provider, GGBN shows tombstone data https://id.ggbn.org/35YPPV
FAILED Data accidentally published and later removed by provider; GGBN shows only message and no data
INACTIVE Material entity data excluded from portal, entity from non GGBN member or non core GGBN member, that has been associated to a GGBN record previously, but is no longer related to any GGBN record https://id.ggbn.org/30X3PY
DRAFT Stable identifier assigned, material entity data not fully processed yet
Retrieved from "http://wiki.ggbn.org/ggbnwiki/index.php?title=GGBN_Stable_Identifiers&oldid=5121"