Skip to content

Commit

Permalink
Update GUID.markdown
Browse files Browse the repository at this point in the history
  • Loading branch information
dustymc authored Sep 24, 2024
1 parent 8144c90 commit f945d4b
Showing 1 changed file with 7 additions and 23 deletions.
30 changes: 7 additions & 23 deletions _best_practices/GUID.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ layout: default_toc

# Best Practice - Creating a Meaningful GUID Prefix

What is a GUID Prefix? Before you make any decisions about one, you should know what it is. Start by reading the [GUID Prefix Documentation ](https://handbook.arctosdb.org/documentation/catalog.html#guid-prefix).
What is a GUID Prefix? Before you make any decisions about one, you should know what it is. Start by reading the [GUID Prefix Documentation](https://handbook.arctosdb.org/documentation/catalog.html#guid-prefix).

![](https://raw.githubusercontent.com/ArctosDB/documentation-wiki/gh-pages/tutorial_images/Bear%20Pro.jpg) **Pro Tip**

Expand All @@ -27,40 +27,24 @@ Think of the GUID Prefix as something you will need to live with forever. Make s

### Before the Colon - Institution

We recommend that the characters before the colon match an existing institution acronym if one has already been in use, especially if it is recorded in a directory such as <a href="http://sweetgum.nybg.org/science/ih/" class="external">Index Herbariorum</a>, <a href="https://www.gbif.org/grscicoll">Global Biodiversity Information Facility Registry of Scientific Collections</a> or has been cited in publications. This makes finding legacy collection use and publication citations easier and also helps those who have worked with your collection in the past find your newly published records in Arctos. In general we recommend that this be the same as the <a href="https://handbook.arctosdb.org/documentation/catalog.html#institution-acronym" class="external">Institution Acronym</a>, but it is not required to be so.
In the "DWC Triple," the characters before the colon are also the institution acronym. This is not a requirement in Arctos; GUID Prefix has no dependencies. If synchronizing the GUID Prefix (which cannot be changed) and the institution acronym (which can be changed) in this way is deemed useful for some purpose, then such usage is encouraged. If this limitation would somehow be inconvenient, then you may freely ignore institution acronym when considering GUID Prefix.

One reason to deviate from the Instution Acronym for Institution is when collections have traditionally used something different from what the institution currently uses. For example, the Arkansas Center for Biodiversity Collections (Arctos Instiution Acronym ACBC) includes the STAR Herbarium, which is registered with the <a href="http://sweetgum.nybg.org/science/ih/herbarium-details/?irn=123984" class="external">Index Herbariorum</a> and multiple other collections previously published as "ASUMZ". In this case, the Arkansas Center for Biodiversity Collections has decided to use the registered "STAR" and legacy "ASUMZ" acronyms as the institution information in the collections' GUID prefixes in order to maintain stability.

Collection | Collection Type | Institution Acronym | GUID Prefix
-- | -- | -- | --
Herbarium | Herb | ACBC | STAR:Herb
Birds | Bird | ACBC | ASUMZ:Bird


### After the Colon - Collection

We recommend that the characters after the colon provide a brief description of the collection. In general we recommend that this be the same as the <a href="https://arctos.database.museum/info/ctDocumentation.cfm?table=ctcollection_cde" class="external">Collection Type</a>. There are many examples of this in Arctos.

- MSB:Mamm
- MVZ:Herp
- UAM:Art

However, use of the Collection Type is not a requirement. One reason to deviate from the collection types for Collection is when an institution holds more than one collection for which they would use a single collection type. For example, the New Mexico Museum of Natural History and Science has two Earth Science or "<a href="https://arctos.database.museum/info/ctDocumentation.cfm?table=ctcollection_cde#es" class="external">ES</a>" collections - Fossils and Minerals. These are set up as follows:

Collection | Collection Type | GUID Prefix
-- | -- | --
Fossils | ES | NMMNH:Paleo
Minerals | ES | NMMNH:Geol
In the "DWC Triple," the characters after the colon are also the collection code. This is not a requirement in Arctos; GUID Prefix has no dependencies. If synchronizing the GUID Prefix (which cannot be changed) and the collection code (which can be changed) in this way is deemed useful for some purpose, then such usage is encouraged. If this limitation would somehow be inconvenient, then you may freely ignore collection code when considering GUID Prefix.


## Summary

- Arctos GUIDs are expected to be permanent, so choose carefully.
- The GUID Prefix can be, but doesn't need to be dependent upon Institution Acronym and/or Collection Type.
- Arctos GUIDs are expected to be permanent and stable, so choose carefully.
- The GUID Prefix may, but is not required to, reflect Institution Acronym and/or Collection Code.
- The GUID Prefix must be no longer than 20 characters and include a colon that is neither the first nor the last character.
- The GUID Prefix should consist of upper and/or lower-case ASCII letters (A-Z,a-z) other than the requisite colon.
- A review of <a href="https://arctos.database.museum/home.cfm" class="external">GUID Prefixes currently in use</a> may be helpful!
- Check <a href="https://www.gbif.org/grscicoll">Global Biodiversity Information Facility Registry of Scientific Collections</a> and the <a href="http://sweetgum.nybg.org/science/ih/herbarium-details/?irn=123984" class="external">Index Herbariorum</a> to see if your collections have legacy Institutional Acronyms.
- A review of [GUID Prefixes currently in use](https://arctos.database.museum/home.cfm) may be helpful!
- The [Global Biodiversity Information Facility Registry of Scientific Collections](https://www.gbif.org/grscicoll) and the [Index Herbariorum](http://sweetgum.nybg.org/science/ih/herbarium-details/?irn=123984) may be useful in locating legacy identifiers and information. You are not required to maintain or follow such data.

## Edit this Documentation

Expand Down

0 comments on commit f945d4b

Please sign in to comment.