Project

General

Profile

« Previous | Next » 

Revision 7651

mappings/VegCore.htm: Regenerated from wiki. Moved Forming IDs section to separate Global IDs wiki page (https://projects.nceas.ucsb.edu/nceas/projects/bien/wiki/Global_IDs).

View differences:

VegCore.htm
6 6
<meta name="description" content="Redmine" />
7 7
<meta name="keywords" content="issue,bug,tracker" />
8 8
<meta content="authenticity_token" name="csrf-param" />
9
<meta content="8RUHRxp5v2obnErV3y/z3vGsVRlcu0xdpSoHTvI/RYE=" name="csrf-token" />
9
<meta content="TLGnUovTlDwQIJ9TUpizkRmk20LO5IGnlURZMAUqjpA=" name="csrf-token" />
10 10
<link rel='shortcut icon' href='/nceas/favicon.ico?1347421715' />
11 11
<link href="/nceas/stylesheets/jquery/jquery-ui-1.8.21.css?1357775071" media="all" rel="stylesheet" type="text/css" />
12 12
<link href="/nceas/stylesheets/application.css?1357775071" media="all" rel="stylesheet" type="text/css" />
......
88 88

  
89 89
<div class="wiki wiki-page">
90 90
  <ul class="toc right"><li><a href="#VegCore-data-dictionary">VegCore data dictionary</a><ul><li><a href="#Examples">Examples</a><ul><li><a href="#Example-specimen-data">Example specimen data</a></li></ul>
91
</li><li><a href="#Data-dictionary-notes">Data dictionary notes</a></li><li><a href="#VegCore-format-notes">VegCore format notes</a><ul><li><a href="#Forming-IDs">Forming IDs</a></li><li><a href="#Forming-preferred-IDs">Forming preferred IDs</a></li></ul>
92
</li><li><a href="#Downloads">Downloads</a></li></ul>
91
</li><li><a href="#Data-dictionary-notes">Data dictionary notes</a></li><li><a href="#VegCore-format-notes">VegCore format notes</a></li><li><a href="#Downloads">Downloads</a></li></ul>
93 92
</li><li><a href="#Tables">Tables</a></li><li><a href="#Source">Source</a><ul><li><ul><li><a href="#Datasource">Datasource</a></li><li><a href="#DataProvider">DataProvider</a></li><li><a href="#Reference">Reference</a></li></ul>
94 93
</li><li><a href="#sourceType">sourceType</a><ul><li><a href="#referenceType">referenceType</a></li><li><a href="#aggregatorOrPrimary">aggregatorOrPrimary</a></li></ul>
95 94
</li><li><a href="#isHerbarium">isHerbarium</a></li><li><a href="#source">source</a><ul><li><a href="#proximateDataProvider">proximateDataProvider</a></li><li><a href="#dataProvider">dataProvider</a></li><li><a href="#dataSource">dataSource</a></li><li><a href="#dataSourceName">dataSourceName</a></li></ul>
......
367 366

  
368 367
	<ul>
369 368
	<li>In the data dictionary, terms are placed in the table they are <em>most</em> applicable to.<br />In a VegCore export, they can also be placed in <em>any other table they apply to</em>, according to how the data is normalized.</li>
369
		<li>IDs labeled <em>globally unique</em> should be formed as described under <a href="/nceas/projects/bien/wiki/Global_IDs" class="wiki-page">Global IDs</a></li>
370 370
	</ul>
371 371

  
372 372

  
373
	<a name="Forming-IDs"></a>
374
<h3  style="padding-left:1em;">Forming IDs<a href="#Forming-IDs" class="wiki-anchor">&para;</a></h3>
375

  
376

  
377
	<ul>
378
	<li>An ID should always be <em>globally</em> unique to allow appending data from arbitrary datasets.<br />A local ID can be made global by prepending the institution's ID.</li>
379
		<li>An ID must <em>permanently</em> and <em>unambiguously</em> identify the record
380
	<ul>
381
	<li>Domain identifiers are usually permanent, while autogenerated primary keys often aren't.<br />However, domain identifiers are sometimes duplicated, in which case another ID, such as a primary key, must be used to distinguish them.</li>
382
	</ul>
383
	</li>
384
		<li>When multiple IDs are available, include all of them (in separate columns) to allow looking up the record by any of them</li>
385
	</ul>
386

  
387

  
388
	<ul>
389
	<li>Examples:
390
	<ol>
391
	<li>date + author e-mail + author-assigned name or ID<br />The date is first so that the ID column is sorted by date</li>
392
		<li>institution ID + institution-assigned name or ID</li>
393
		<li>web interface permalink</li>
394
		<li>database host + database name + <em>permanent</em> primary key</li>
395
	</ol></li>
396
	</ul>
397

  
398

  
399
	<p style="padding-left:2em;"><em>Note that these globally unique IDs are not the same as <a href="http://en.wikipedia.org/wiki/Globally_unique_identifier" class="external">UUIDs</a>, which are randomly generated</em></p>
400

  
401

  
402
	<a name="Forming-preferred-IDs"></a>
403
<h3  style="padding-left:1em;">Forming preferred IDs<a href="#Forming-preferred-IDs" class="wiki-anchor">&para;</a></h3>
404

  
405

  
406
	<ul>
407
	<li>From multiple IDs, the <em>preferred ID</em> becomes the database primary key</li>
408
		<li>Use the ID which is most directly associated with the identified object</li>
409
		<li>The preferred ID should be <em>human-readable</em> whenever possible. A name or date should always be used in preference to a number.</li>
410
		<li>Choose the <em>shortest</em> string which satisfies the above criteria</li>
411
	</ul>
412

  
413

  
414 373
	<a name="Downloads"></a>
415 374
<h2 >Downloads<a href="#Downloads" class="wiki-anchor">&para;</a></h2>
416 375

  
......
4263 4222

  
4264 4223
	<p><ul class="pages-hierarchy">
4265 4224
<li><a href="/nceas/projects/bien/wiki/Combining_VegCore_and_VegBIEN">Combining VegCore and VegBIEN</a></li>
4225
<li><a href="/nceas/projects/bien/wiki/Global_IDs">Global IDs</a></li>
4266 4226
<li><a href="/nceas/projects/bien/wiki/VegCore_refactoring">VegCore refactoring</a></li>
4267 4227
</ul>
4268 4228
</p>

Also available in: Unified diff