Documentation created on 2. Nov. 2001; last update: 2005-03-30, email address revised 2010-08-05.
By G. Hagedorn, 2001
This document contains a complete list of all entities and attributes used in the information model of this application module. It is primarily intended as a technical reference. It can also be helpful, however, in understanding the scope and usage of certain attributes. When you have a question like 'where does this information fit in', reading the attribute description of related attributes may help you.
Besides the human readable documentation provided below, three more technical documents are provided:
See also the separate alphabetical index to attribute names.
Definition of common properties (esp. the start of the URI) for a set of related external resources of various quality levels.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceCollectionID | Autonum | Resource collection ID, unique system generated value (primary key). Default value: GenUniqueID() |
R | I (P) |
| Title | Text | Unique user readable title, identifying the resource collection. Example: 'Ascochyta images from Melnik (1977)'. | R | I (U) |
| Description | Memo | Short description of a collection of information resources, about one paragraph long. Basic xhtml formatting tags are permitted. | R | - |
| Authors | Text | A list of authors displayed on the title page for the entire collection. Authors or editors need not be identical with resource managers. | - | - |
| Editors | Text | A list of editors displayed on the title page for the entire collection. Authors or editors need not be identical with resource managers. | - | - |
| SourceDescription | Memo | Description of the source or origin of resources in the current collection, esp. if URI point to files. Compare SourceReferenceID if source is a publication. | - | - |
| SourceReferenceID | Text | For resources that are present in published sources: the reference ID as defined in a bibliographic reference manager like DiversityReferences (RefID, foreign key). Examples: ''AUTH92Q974' for figures from a book recorded under this ID. | - | I |
| SourceRefDescriptionCache | Text | A readable description (author, year, etc.) corresponding to SourceReferenceID, automatically updated from the reference management subsystem. | - | - |
| AcknowledgementID | Long | Refers to an acknowledgement definition that documents source and intellectual property rights, and provides a formatted acknowledgements (foreign key). | - | I |
| CopyrightDocumentation | Memo | If not already covered by acknowledgment: documentation of copyright or usage agreements, including dates and the name of the responsible person or institution with which an agreement was reached. | - | - |
| InternalNotes | Memo | Internal notes and remarks. | - | - |
| URI_Part1 | Text | If available via http/ftp: The first part of the URI, before the variable part defined in the individual resource. Should include protocol, server, and beginning of path. Example: 'http: www.example.net/images'. |
- | - |
| LAN_Part1 | Text | If available on a local fileserver/in a local area network: The start of the path. This can be used as an alternative to internet access while in the local area network. Example: '\\server\images\'. Mapped network drives ('Z:\images') should be avoided! | - | - |
| BackupLocation | Text | Description of location (local LAN path, label of CDs, etc. ) where a backup of the resource collection (including all resource instance files) is kept. | - | - |
| ReleaseDate | Date/Time | A date which may be up to 2 years in the future to prevent public access to the resource collection prior to this date (set by the managers of the collection). Default value: Now(); Validation rule: <(Now()+735), validation message: The release date may only be up to 2 years in the future. |
R | - |
| ReleaseNotes | Text | Required whenever ReleaseDate postpones the public release: Documentation of the motives for the postponement, and name of responsible user (esp. if multiple collection managers exist). | - | - |
| xx_ManagedContent | Boolean | Does the collection contain links to content for which the organization hosting the web site itself is responsible? | - | - |
| EditorialControl | Boolean | True if editorial control is required; necessary for managed content. Can be changed only by responsible managers of the internet site, not by resource collection managers. If set to false, EditorialReleaseBy/When are updated to document responsibility. Default value: True |
R | - |
| EditorialReleaseBy | Text | Name of a responsible manager of the internet site; can NOT be set by resource collection managers. The editorial review mechanism guarantees that no unwanted information is presented on the website, esp. for images uploaded by external users. | - | - |
| EditorialReleaseWhen | Date/Time | Date up to which the resources have been reviewed. Instances added at a later date are automatically prevented from being available in the internet. Validation rule: Is Null Or <Now()+14 |
- | - |
| IsTemplate | Boolean | True if collection has been introduced as a template for new collections. Default value: 0 |
R | - |
| xx_DefaultKeywords | Text | Keywords that are automatically inserted into all new resource items / can be changed only for new items! | - | - |
| xx_CollectionKeywords | Text | Keywords that apply to the collection / can be changed at any time! | - | - |
| xx_DefaultTaxa | Text | Names AND/OR IDs? | - | - |
| LogCreatedBy | Long | The user who created this record. | R | - |
| LogCreatedWhen | Date/Time | The date and time when this record was created. Also serves as publication date of the collection (use of ReleaseDate is not indicated, may later be changed to temporarily lock the collection). Default value: Now() |
R | - |
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - |
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - |
| Table validation rule: | ([ReleaseDate]<Now() Or Not [ReleaseNotes] Is Null) | |||
| Index name: | Attributes & index properties | |||
| AcknowledgementID: | AcknowledgementID (Duplicates OK) | |||
| PrimaryKey: | ResourceCollectionID (Primary key; Unique values) | |||
| ReferenceID: | SourceReferenceID (Duplicates OK) | |||
| Title: | Title (Unique values) | |||
| Relation type: | Fields involved | |||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceAbstractItem.ResourceCollectionID | |||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceManager.ResourceCollectionID | |||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID | |||
Person that manages a ResourceCollection. Multiple managers can share the management.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceCollectionID | Long | ID of the resource collection (foreign key). | R | I(PM) |
| ManagingUserID | Long | ID of user who may manage the resource information in the resource collection (foreign key, referring to DiversityUsers.UserID). | R | I(PM) |
| Index name: | Attributes & index properties | |||
| PrimaryKey: | ResourceCollectionID; ManagingUserID (Primary key; Unique values) | |||
| Relation type: | Fields involved | |||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceManager.ResourceCollectionID | |||
Quality classes for all instances of each abstract resource item are defined (separately for each resource collection). Examples for quality classes are preview or thumbnail versions, compressed versions, or high quality versions.
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ResourceCollectionID | Long | Refers to a resource collection (foreign key). | R | I(PM) | |||||||||||||||
| QualityLevel | Long | A quality level for this class of resources as defined in SysRsc_QualityLevel (foreign key). | R | I(PM) | |||||||||||||||
| List of values: |
|
||||||||||||||||||
| URI_Part2 | Text | Optional string, inserted between URL_Part1 (see ResourceCollection) and the individual resource name URL_Part3 (see ResourceAbstractItem). | - | - | |||||||||||||||
| URI_Part4 | Text | Optional string, appended to the individual resource name (URL_Part3). This may be part of the filename + quality-level typical extension, e.g. '_thumbn.gif. | - | - | |||||||||||||||
| RecommendedPresentation | Text | Recommended presentation mode (Link, Download, Embed); the web interface may either follow the recommendation or implement its own rules. Default value: "L"; Validation rule: "L" Or "N" Or "E" Or "D" |
R | - | |||||||||||||||
| List of values: |
|
||||||||||||||||||
| QualityAvailability | Byte+ | Availability scope (managers, login, intranet, internet) of resource instances of this quality class (also restricted by ItemAvailability!). Default value: 3 |
R | - | |||||||||||||||
| List of values: |
|
||||||||||||||||||
| QualityAvailableOnline | Boolean | Access immediacy: True = directly online available; False = only meta information (keywords), but no access information (URI) is provided, available only on explicit request by electronic or postal means. (Also restricted by ItemAvailableOnline!). Default value: True |
R | - | |||||||||||||||
| List of values: |
|
||||||||||||||||||
| AutoGenerateFrom | Long | A quality level from which resource instances for the current quality level can be generated (e.g. an image robot generating thumbnails) for each resource item. Leave empty if the instances are created manually. | R | - | |||||||||||||||
| List of values: |
|
||||||||||||||||||
| AutoGenerationCommand | Text | A command calling the auto-generation robot with specific parameters (e.g. indicating the size of the desired preview image). | - | - | |||||||||||||||
| InternalNotes | Text | Internal notes regarding this quality version of the resource (history, steps taken to generate this version, compression rate, etc.). | - | - | |||||||||||||||
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - | |||||||||||||||
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - | |||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||
| PrimaryKey: | ResourceCollectionID; QualityLevel (Primary key; Unique values) | ||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID | ||||||||||||||||||
| Simple relation (no integrity) | ResourceQualityClass.QualityLevel « ResourceInstance.QualityLevel | ||||||||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceQualityClass.QualityLevel | ||||||||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceQualityClass.AutoGenerateFrom | ||||||||||||||||||
System wide definitions of quality levels, used in ResourceQualityClass.
| Name | Type | Description / Default value & validation | Rqrd./Index | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| QualityLevel | Long | Unique ID for the quality level (primary key). | R | I (P) | ||||||||||
| QualityLevelDescription | Text | User readable, unique description of quality level, e.g. "original version" or "modified"; for images: "full resolution", "default compressed", or "thumbnail image". | R | I (U) | ||||||||||
| Mirror | Byte+ | Primary location (= 0) or first and second mirror location. Mirror quality classes should not normally be offered as quality levels in the user interface. Default value: 0; Validation rule: 0 Or 1 Or 2 |
R | - | ||||||||||
| PresentationDefault | Text | Default for recommended presentation mode (Link, Download, Embed) of new quality classes. Default value: "L"; Validation rule: "L" Or "N" Or "E" Or "D" |
R | - | ||||||||||
| List of values: |
|
|||||||||||||
| SingleClass | Boolean | Only a single quality class is used (however, multiple classes may be present due to mirror classes). Most QualityClass attributes in editing form are unavailable (except always RecommendedPresentation and if Mirror is > 0 also URI_Path2 ). Default value: 0 |
R | - | ||||||||||
| Abridged | Boolean | Information in this quality level is abridged, e.g. thumbnail preview, or short preview sequences from a video. Default value: 0 |
R | - | ||||||||||
| Internal | Boolean | Information of this quality level is normally not intended for public use, esp. original scans, internal backup copies, etc. Default value: 0 |
R | - | ||||||||||
| Index name: | Attributes & index properties | |||||||||||||
| PrimaryKey: | QualityLevel (Primary key; Unique values) | |||||||||||||
| QualityLevelDescription: | QualityLevelDescription (Unique values) | |||||||||||||
| Relation type: | Fields involved | |||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceQualityClass.QualityLevel | |||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceInstance.QualityLevel | |||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceQualityClass.AutoGenerateFrom | |||||||||||||
| Updates & deletions cascade | AppRsc_QualityLevel.QualityLevel « AppRsc_MediaTypeIcon.QualityLevel | |||||||||||||
Abstract resource item: general information that applies to all duplicates or quality versions of a resource .
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ResourceID | Autonum | Unique ID for external information resource (primary key). | R | I (P) | |||||||||||||||||||||
| ResourceCollectionID | Long | The specific information stored here is supplemented with the attributes defined in this resource collection entity (foreign key). | R | - | |||||||||||||||||||||
| URI_Part3 | Text | The part of the URI that is specific to the abstract resource item (applicable to all quality instances of the item). Inserted between the optional QualityClass attributes URI_Part2 and Part4. Example: 'figure13'. | - | I | |||||||||||||||||||||
| ItemAvailability | Byte+ | Availability scope (managers, login, intranet, internet) of resource instances of this abstract item (also restricted by QualityAvailability!). Default value: 3 |
R | - | |||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||
| ItemAvailableOnline | Boolean | Access immediacy: True = directly online available; False = only meta information (keywords), but no access information (URI) is provided, available only on explicit request by electronic or postal means. (Also restricted by QualityAvailableOnline!). Default value: True |
R | - | |||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||
| xx_NumberingCategory | Byte+ | If resource is embedded in another document: Defines a numbering sequence category (fig., tab., etc.) to be used. Default value: 0 |
R | - | |||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||
| LinkAssociatedIcon | Text | Optional for hyperlinks: Complete URI of an icon that shall be displayed in addition to the text link (e.g. icon of a online journal, computer application, etc.). | - | - | |||||||||||||||||||||
| UpdateStatus | Byte+ | Optional: the update status (normal, new, updated) of a resource can be defined; this can be used to automatically add appropriate icons to alert users to changes. Default value: 0; Validation rule: 0 Or 1 Or 2 |
R | - | |||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||
| SourceReferenceID | Text | For resources that are present in published sources: the reference ID as defined in a bibliographic reference manager like DiversityReferences (RefID, foreign key). Compare also ResourceCollection.ReferenceID! | - | - | |||||||||||||||||||||
| SourceRefDescriptionCache | Text | A readable description (author, year, etc.) corresponding to SourceReferenceID, automatically updated from the reference management subsystem. | - | - | |||||||||||||||||||||
| SourceReferenceDetail | Text | Detail, especially page or figure number in a reference. Available if either the entire collection, or the current item is derived from a published source. | - | - | |||||||||||||||||||||
| SourceCaption | Memo | The full, unchanged text of the original caption for the resource, esp. in the case of images (if resource has parts, the captions of all parts are entered here). | - | - | |||||||||||||||||||||
| ParentResourceID | Long | Optional: if the current resource is a modified version derived from another resource available in the system, this points to the original resource (ResourceID foreign key) [** not implemented, prepared for future versions**] | - | I | |||||||||||||||||||||
| LogCreatedBy | Long | The user who created this record. | R | - | |||||||||||||||||||||
| LogCreatedWhen | Date/Time | The date and time when this record was created. Default value: Now() |
R | - | |||||||||||||||||||||
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - | |||||||||||||||||||||
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - | |||||||||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||||||||
| ParentResourceID: | ParentResourceID (Duplicates OK) | ||||||||||||||||||||||||
| ResourceID: | ResourceID (Primary key; Unique values) | ||||||||||||||||||||||||
| URI_Part3: | URI_Part3 (Duplicates OK) | ||||||||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||||||||
| Updates & deletions cascade | ResourceCollection.ResourceCollectionID « ResourceAbstractItem.ResourceCollectionID | ||||||||||||||||||||||||
| Updates & deletions cascade | ResourceAbstractItem.ResourceID « ResourceInstance.ResourceID | ||||||||||||||||||||||||
| Updates & deletions cascade | ResourceAbstractItem.ResourceID « ResourceDescription.ResourceID | ||||||||||||||||||||||||
Description of an entire resource or an optionally defined resource part. The entity combines the description and the resource part definition, which could also be modeled in a 1:1 relationship.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceID | Long | ID of external resource to which this description applies (foreign key). | R | I(PM) |
| PartID | Long | A number that is unique within a resource ID, identifying the resource part. '0' for entire resource. PartID is used by external modules to identify a resource part and should therefore not be changed at a later time. Default value: 0, validation message: You must use a positive number to identify a resource part. |
R | I/I(PM) |
| PartLabel | Text | For parts of resources: label identifying resource parts or components (e.g. a-, b-, c-labeled figures in images, tracks on audio resources, etc.). Use description like 'top', 'left side', etc. for unlabeled parts! Default value: "-" |
R | - |
| PartStart | Text | Optional: Definition in technical units of the start of this part of a multipart resource. Empty for entire resource! Use percent of height/width for images (not pixel, they are quality dependent!), seconds for audio/video, bookmark for text, etc. | - | - |
| PartEnd | Text | Optional: Definition in technical units of the end of this part of a multipart resource. Empty for entire resource! Compare PartStart for examples of technical units. | - | - |
| Creators | Text | Optional: Author(s), photographer, director, etc. Person(s) or institution(s) responsible for the creation of the abstract resource item (not creators of the instance, e.g. a scan of an image!). | - | - |
| CreationMetadata | Memo | Optional: information regarding the creation process, e.g. image capture date/time, location, lens, scale, exposure time, etc. | - | - |
| CopyrightInformation | Memo | Optional: information regarding copyright of resource, esp. name of person or institution holding the copyright to this resource. Leave empty if unknown or if all content in the resource collection has the same copyright owner. | - | - |
| InternalNotes | Memo | Internal notes, applying to the entire resource or parts of the resource. Visible only to managers of the resource collection. | - | - |
| LogCreatedBy | Long | The user who created this record. | R | - |
| LogCreatedWhen | Date/Time | The date and time when this record was created. Default value: Now() |
R | - |
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - |
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - |
| Table validation rule: | ([PartLabel]<>'-' Or [PartStart] Is Null And [PartEnd] Is Null) | |||
| Index name: | Attributes & index properties | |||
| PartID: | PartID (Duplicates OK) | |||
| PrimaryKey: | ResourceID; PartID (Primary key; Unique values) | |||
| Relation type: | Fields involved | |||
| Referential integrity | ResourceDescription.ResourceID « ResourceDisplayElement.ResourceID; ResourceDescription.PartID « ResourceDisplayElement.PartID | |||
| Updates & deletions cascade | ResourceDescription.ResourceID « ResourceKeyword.ResourceID; ResourceDescription.PartID « ResourceKeyword.PartID | |||
| Updates & deletions cascade | ResourceDescription.ResourceID « ResourceTaxon.ResourceID; ResourceDescription.PartID « ResourceTaxon.PartID | |||
| Updates & deletions cascade | ResourceAbstractItem.ResourceID « ResourceDescription.ResourceID | |||
All elements defining language specific output in presentations. The web interface can support all languages for which display elements have been defined.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceID | Long | ID of external resource to which this description applies (foreign key). | R | I(PM) |
| PartID | Long | ID of part ('0' for entire resource) to which the display element applies (foreign key). | R | I(PM) |
| Language | Text | 2 letter iso code of language. Default value: "en" |
R | I(PM) |
| Title | Text | A title for the resource item, esp. used as link text if hyperlink to resource is created. | R | - |
| Description | Memo | Short description of the entire resource, especially displayed as additional information after a hyperlink. Basic xhtml character formatting tags are allowed. In the absence of SpecialCaption the description is also used as caption for embedded resources. | - | - |
| SpecialCaption | Memo | Optional: If description is not suitable as caption of an embedded resource, a special caption may be defined here. Basic xhtml formatting tags may be used. For images information about measurement scale (example: 'bar=10 µm') should be included. | - | - |
| DisplayOrderText | Text | If filled, used for sorting in a presentation. Example: 'The Area of New York' shall be sorted under 'New York', or at position '34'. Text sorting, use '09', '10', or '10' < '9'! Normally the attribute is empty and resources are sorted by title. | - | - |
| DisplayOrderCache | Text | Calculated field, set to DisplayOrderText if present, otherwise to Title. Introduced to allow indexing and fast sorting. | - | I |
| Index name: | Attributes & index properties | |||
| PrimaryKey: | ResourceID; PartID; Language (Primary key; Unique values) | |||
| xx_DisplayOrderCache: | DisplayOrderCache (Duplicates OK) | |||
| Relation type: | Fields involved | |||
| Referential integrity | ResourceDescription.ResourceID « ResourceDisplayElement.ResourceID; ResourceDescription.PartID « ResourceDisplayElement.PartID | |||
Resource management subsystem: Keywords (general keywords applicable to the entire resource, not taxon-specific).
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceID | Long | ID of external resource to which keyword applies (foreign key). | R | I/I(PM) |
| PartID | Long | ID of part ('0' for entire resource) to which keyword applies (foreign key). | R | I(PM) |
| Keyword | Text | A keyword, esp. subject headings or private markers. A keyword may consist of multiple words (phrases, e.g. 'red herring'), which can then only be searched as a whole. | R | I(PM) |
| Responsible | Long | Person responsible for entering the keyword. | R | - |
| Index name: | Attributes & index properties | |||
| PrimaryKey: | ResourceID; PartID; Keyword (Primary key; Unique values) | |||
| ResourceID: | ResourceID (Duplicates OK) | |||
| Relation type: | Fields involved | |||
| Updates & deletions cascade | ResourceDescription.ResourceID « ResourceKeyword.ResourceID; ResourceDescription.PartID « ResourceKeyword.PartID | |||
Resource management subsystem: Organism names, features or characteristics of the organism, and topics (nomenclature, description, distribution, etc.) covered.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| ResourceID | Long | ID of external resource to which keyword applies (foreign key). | R | I |
| PartID | Long | ID of part ('0' for entire resource) to which keyword applies (foreign key). | R | - |
| TaxonomicName | Text | Scientific name of taxon (if possible include authors). Any name can be entered, regardless of whether it is present in taxonomy or not. | - | - |
| VernacularName | Text | Non-scientific name of organism (e.g. 'white fir') or non-taxonomic name ('conifer', 'hardwood'). | - | - |
| NomID | Long | Unique ID code of the taxon. Refers to the NomID code of TaxonomyName (= foreign key) in the database DiversityTaxonomy. Default value: 0 |
- | I |
| IdentificationQualifier | Text | Qualification of the identification e.g. 'cf.', 'aff.', 'sp. nov.'. | - | - |
| IdentificationResponsible | Text | 'ORIGINAL' = according to original description (e.g. publication), else name of person responsible for a later identification. Default value: "ORIGINAL" |
- | - |
| FeatureList | Memo | Semicolon-separated list of features of the taxon, e.g. 'ascomata; asci; ascospores; germination'. | - | - |
| TopicNomenclature | Long | 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource. Default value: 0 |
- | - |
| TopicDescription | Long | 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource. Default value: 0 |
- | - |
| TopicGeography | Long | Default value: 0 | - | - |
| TopicPhylogeny | Long | Default value: 0 | - | - |
| IDQuality | Text | - | I | |
| IDQualityResponsible | Text | - | I | |
| Index name: | Attributes & index properties | |||
| IDQuality: | IDQuality (Duplicates OK) | |||
| IDQualityResponsible: | IDQualityResponsible (Duplicates OK) | |||
| NomID: | NomID (Duplicates OK) | |||
| ResourceID: | ResourceID (Duplicates OK) | |||
| Relation type: | Fields involved | |||
| Updates & deletions cascade | ResourceDescription.ResourceID « ResourceTaxon.ResourceID; ResourceDescription.PartID « ResourceTaxon.PartID | |||
Resource instance: Attributes that apply to a specific quality instance of an information resouce. Inherits information from collection, abstract item, and quality class.
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ResourceID | Long | ID of external resource to which this association applies (foreign key). | R | I(PM) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QualityLevel | Long | A quality level for this instance of the resource as defined in SysRsc_QualityLevel (foreign key). | R | I(PM) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| URI_ManualOverride | Text | If this attribute is filled with a complete URI, it is directly used, ignoring the settings. | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| URI_Cache | Text | The complete URI address. If URI_ManualOverride is empty, it is generated from URI_Part1 to URI Part4 (for digital resources that are available online). | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InstanceAvailabilityCache | Byte+ | (calculated value; = Min(QualityAvailability, ItemAvailability) AND current date > Collection.ReleaseDate AND (Collection.EditorialReleaseWhen (date) > Instance creation date OR Not EditorialControl)). Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| InstanceAvailableOnlineCache | Boolean | (calculated value; = ItemAvailableOnline AND QualityAvailableOnline). Default value: False |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_LastTestWhen | Date/Time | The date and time the availability was last tested (set by a link checking program). The normal testing cycle should retest every 3 days. | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_LastResult | Boolean | The result of the last availability test (set by a link checking program). | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_LastSuccessWhen | Date/Time | The last date and time when the availability test result was positive (set by a link checking program). | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_Deactivated | Boolean | Automatic deactivation of link if the LastResult is negative and LastSuccessWhen more than 14 days ago (set by a link checking program). Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_DeactivatedWhen | Date/Time | Date and time when the resource instance was automatically deactivated. | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_Attempts | Long | The total number of availability tests since the last ResetWhen (set by a link checking program). Default value: 0 |
- | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_Failures | Long | The total number of failed availability tests since the last ResetWhen (set by a link checking program). Default value: 0 |
- | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| CheckAvailability_ResetWhen | Date/Time | Date and time when the attributes Attempts and Failures were last reset to 0 (automatically set by the reset routine of the link checking program). | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MediaTypeID | Long | Media type according to MIME, refers to SysRsc_MediaType (foreign key). Normally the type is automatically set based on file extension in URI, see SysMediaType for definitions. | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ResourceSize | Long | Size of resource in bytes (file size, or length of download stream); this may be used to add size indications after links to help users in making appropriate choices. The value is 0 if the size is unknown. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| FileDate | Date/Time | The file date of those resource of which the file system date can be read. Used to identify updated instances and update those all other attributes that can be automatically obtained (e.g. size, pixel, etc.) are updated as well. | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImgPixelHeight | Long | Optional for images: The height/width in pixel; esp. used for internet presentations; pages can be displayed better if height is known before the image is fully loaded. The value is 0 if the height is not available. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImgPixelWidth | Long | Optional for images: The height/width in pixel; esp. used for internet presentations; pages can be displayed better if height is known before the image is fully loaded. The value is 0 if the width is not available. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ImgColorDepth | Long | Optional for images: The color depth in bits/pixel. The value is 0 if the color depth is not available. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogCreatedWhen | Date/Time | The date and time when this record was created. Default value: Now() |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PrimaryKey: | ResourceID; QualityLevel (Primary key; Unique values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Updates & deletions cascade | ResourceAbstractItem.ResourceID « ResourceInstance.ResourceID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Referential integrity | AppRsc_MediaType.MediaTypeID « ResourceInstance.MediaTypeID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Simple relation (no integrity) | ResourceQualityClass.QualityLevel « ResourceInstance.QualityLevel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Updates cascade | AppRsc_QualityLevel.QualityLevel « ResourceInstance.QualityLevel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System wide definition of resource media types, according to MIME (rfc 2046; e.g. file format image/gif).
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||
|---|---|---|---|---|---|---|---|---|---|
| MediaTypeID | Long | Internal ID number for media type. | R | I (P) | |||||
| MediaType | Text | Media type according to MIME (rfc 2046; e.g. file format image/gif). | R | I | |||||
| Examples for values (any value may be added): |
|
||||||||
| Description | Text | Description of the media type, displayed in user interface. | R | - | |||||
| WebCompatible | Boolean | The quality level is compatible with current internet browsers. Default value: 0 |
R | - | |||||
| HtmlEmbeddableImage | Boolean | Resources of this format can be embedded in html files using the html image tag. Default value: 0 |
R | - | |||||
| HtmlEmbeddableText | Boolean | Resources of this format can be embedded in html files directly (header/body less html resources designed to be included elsewhere). Default value: 0 |
R | - | |||||
| Index name: | Attributes & index properties | ||||||||
| MediaType: | MediaType (Duplicates OK) | ||||||||
| PrimaryKey: | MediaTypeID (Primary key; Unique values) | ||||||||
| Relation type: | Fields involved | ||||||||
| Referential integrity | AppRsc_MediaType.MediaTypeID « ResourceInstance.MediaTypeID | ||||||||
| Updates & deletions cascade | AppRsc_MediaType.MediaTypeID « AppRsc_MediaTypeExtension.MediaTypeID | ||||||||
| Updates & deletions cascade | AppRsc_MediaType.MediaTypeID « AppRsc_MediaTypeIcon.MediaTypeID | ||||||||
System wide definition of file extensions to be recognized as a media type (e.g. '.gif' for image/gif).
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| RecognizedFileExtension | Text | File extension recognized for a media type. | R | I (P) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| MediaTypeID | Long | ID number of media type (foreign key). | - | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PrimaryKey: | RecognizedFileExtension (Primary key; Unique values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Updates & deletions cascade | AppRsc_MediaType.MediaTypeID « AppRsc_MediaTypeExtension.MediaTypeID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
System wide definition of generic icon images for resource media types (file formats), optionally quality dependent.
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| MediaTypeID | Long | ID number of media type (foreign key + 1st part of primary key). | R | I(PM) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QualityLevel | Long | A quality level as defined in SysRsc_QualityLevel (foreign key + 2nd part of primary key). | R | I/I(PM) | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SmallIconURI | Text | Complete URI of icon image used to symbolize all resource instances of this quality level. Different quality levels may have the same or different icons. | R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SmallIconWidth | Byte+ | Width of small icon image in pixel. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| SmallIconHeight | Byte+ | Height of small icon image in pixel. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LargeIconURI | Text | Like SmallIconURI, but for a larger icon size. | R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LargeIconWidth | Byte+ | Width of large icon image in pixel. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| LargeIconHeight | Byte+ | Height of large icon image in pixel. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| PrimaryKey: | MediaTypeID; QualityLevel (Primary key; Unique values) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| QualityLevel: | QualityLevel (Duplicates OK) | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Updates & deletions cascade | AppRsc_MediaType.MediaTypeID « AppRsc_MediaTypeIcon.MediaTypeID | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Updates & deletions cascade | AppRsc_QualityLevel.QualityLevel « AppRsc_MediaTypeIcon.QualityLevel | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
A resource presentation is similar to a resource collection, but it may combine several collections.
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| PresentationID | Autonum | Presentation ID, unique system generated value (primary key). Default value: GenUniqueID() |
R | I (P) |
| Title | Text | Unique user readable title, identifying the resource presentation. Example: 'Collected Ascochyta images'. | R | I (U) |
| Description | Memo | Short description of a presentation of information resources, about one paragraph long. Basic xhtml formatting tags are permitted. | R | - |
| Authors | Text | A list of authors displayed on the title page for the resource presentation. | - | - |
| Editors | Text | A list of editors displayed on the title page for the resource presentation. | - | - |
| AcknowledgementID | Long | Refers to an acknowledgement definition that documents source and intellectual property rights, and provides a formatted acknowledgements (foreign key). | - | I |
| InternalNotes | Memo | Internal notes and remarks. | - | - |
| CreateTitlePage | Boolean | Automatically generate a separate title page for the presentation. Default value: True |
- | - |
| CreateTableOfContents | Boolean | Automatically generate a hyperlinked table of contents page from the heading elements defined. Default value: True |
- | - |
| PageFooterText | Memo | Footer to be displayed on each page of the presentation. | - | - |
| PageBreakMaxElements | Long | If long presentations are not structured by headings, a new presentation page is started after this number of elements. Default value: 500 |
R | - |
| PageBreakAtHeading | Long | Heading level at which a new a new presentation page is started (all presentation pages are linked as consecutive pages). Default value: 0 |
R | - |
| StylesheetScreenURI | Text | URI to the stylesheet to be used for screen display (a default stylesheet will be used if empty). | - | - |
| StylesheetPrintURI | Text | URI to the stylesheet to be used for printing (a default stylesheet will be used if empty). | - | - |
| ResourceQualityLevelStart | Long | For resources with multiple quality classes: Quality level of a resource initially displayed in a presentation (e.g. a preview like thumbnail image), possibly hyperlinking to higher quality levels, see ResourceQualityLevelEnd. Default value: 0 |
- | - |
| ResourceQualityLevelEnd | Long | For resources with multiple quality classes: Last quality level of a resource displayed in a presentation, higher quality levels are not hyperlinked. Default value: 0 |
- | - |
| ResourceShowUpdateStatus | Boolean | For resources: display update status of resource using icons for 'new' or 'updated'. Default value: True |
R | - |
| LogCreatedBy | Long | The user who created this record. | R | - |
| LogCreatedWhen | Date/Time | The date and time when this record was created. Also serves as publication date of the presentation. Default value: Now() |
R | - |
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - |
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - |
| Index name: | Attributes & index properties | |||
| AcknowledgementID: | AcknowledgementID (Duplicates OK) | |||
| PrimaryKey: | PresentationID (Primary key; Unique values) | |||
| Title: | Title (Unique values) | |||
| Relation type: | Fields involved | |||
| Updates & deletions cascade | Presentation.PresentationID « PresentationElement.PresentationID | |||
Items contained in a presentation. A resource presentation may combine several collections.
| Name | Type | Description / Default value & validation | Rqrd./Index | ||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| PresentationID | Long | Presentation ID (foreign key). | R | I(PM) | |||||||||||||||||||||||||||||||||||||||
| DisplayOrder | Long | The order in which the presentation elements are displayed. Default value: CLng((Now()-37188)*250000) |
R | I/I(PM) | |||||||||||||||||||||||||||||||||||||||
| ElementType | Long | Different presentation elements (heading, paragraph, list element, hyperlink, reference, etc.) are formatted differently. Default value: 0 |
R | - | |||||||||||||||||||||||||||||||||||||||
| List of values: |
|
||||||||||||||||||||||||||||||||||||||||||
| DisplayText | Memo | If element type is html, heading, paragraph, or list element: Contains the text for output. If element type is resource: overrules the default caption or link title. Leave empty to use the default title. | - | - | |||||||||||||||||||||||||||||||||||||||
| ResourcePresentation | Text | For resource elements: Presentation mode (Link, Download, Embed, etc.) to be used. Default: use the recommended presentation mode defined in the quality class of the resource. Default value: "-"; Validation rule: "L" Or "N" Or "E" Or "D" Or "-" |
R | - | |||||||||||||||||||||||||||||||||||||||
| ResourceDirectID | Long | For resource elements: Directly defines a single resource item to be used (foreign key). | - | I | |||||||||||||||||||||||||||||||||||||||
| ResourceLookupKeyword | Text | For resource elements: Retrieve all resources containing this keyword, optionally further restricted by resource collection. | - | - | |||||||||||||||||||||||||||||||||||||||
| ResourceLookupCollectionID | Long | For resource elements: Retrieve all resources from this resource collection (foreign key), optionally further restricted by keyword. | - | - | |||||||||||||||||||||||||||||||||||||||
| ReferenceID | Text | For reference elements: An optional reference as defined in a bibliographic reference manager like DiversityReferences (RefID, foreign key). | - | I | |||||||||||||||||||||||||||||||||||||||
| ReferenceDescriptionCache | Text | For reference elements: A readable description (author, year, etc.) corresponding to ReferenceID, automatically updated from the reference management subsystem. | - | - | |||||||||||||||||||||||||||||||||||||||
| KeyID_Notimplemented | Long | NOT YET IMPLEMENTED: Applicable only if element type is identification key: Defines the identification key to be inserted here. | - | - | |||||||||||||||||||||||||||||||||||||||
| LogCreatedBy | Long | The user who created this record. | R | - | |||||||||||||||||||||||||||||||||||||||
| LogCreatedWhen | Date/Time | The date and time when this record was created. Default value: Now() |
R | - | |||||||||||||||||||||||||||||||||||||||
| LogUpdatedBy | Long | The user who updated this record the last time. | - | - | |||||||||||||||||||||||||||||||||||||||
| LogUpdatedWhen | Date/Time | The date and time when this record was last updated. Default value: Now() |
- | - | |||||||||||||||||||||||||||||||||||||||
| SourceReferenceDetail | Text | If presentation has a published source: the page or figure number corresponding to the current presentation element in the published source. | - | - | |||||||||||||||||||||||||||||||||||||||
| Index name: | Attributes & index properties | ||||||||||||||||||||||||||||||||||||||||||
| DisplayOrder: | DisplayOrder (Duplicates OK) | ||||||||||||||||||||||||||||||||||||||||||
| PrimaryKey: | PresentationID; DisplayOrder (Primary key; Unique values) | ||||||||||||||||||||||||||||||||||||||||||
| ReferenceID: | ReferenceID (Duplicates OK) | ||||||||||||||||||||||||||||||||||||||||||
| ResourceID: | ResourceDirectID (Duplicates OK) | ||||||||||||||||||||||||||||||||||||||||||
| Relation type: | Fields involved | ||||||||||||||||||||||||||||||||||||||||||
| Updates & deletions cascade | Presentation.PresentationID « PresentationElement.PresentationID | ||||||||||||||||||||||||||||||||||||||||||
DISCUSS: URI translation service. When URI is changed, the old URI is copied into a permanent translation table and can be replaced from there. Difficult to interact with the web server!
| Name | Type | Description / Default value & validation | Rqrd./Index | |
|---|---|---|---|---|
| OldInstanceURI | Text | - | - | |
| NewInstanceURI | Text | - | - | |
Footnotes: The following abbreviations have been used in the tables: R: It is required to enter data in this field. I: The field is indexed to enable faster searching. Different types of indices are denoted by additional letters in parentheses: P = attribute is part of the primary key (values in the index must be unique), U = values in the index must be unique, N = Null values are ignored in the index, M = the index contains more than one attribute, + = the attribute is involved in more than one multiple-field index. The names of attributes that are part of the primary key are underlined in the first column.
Data types: 'Text (255)' indicates a text of varying length for which no specific design restrictions have been formulated. 255 characters should be read as a proposed technical maximum limit, that can be changed if required by the database management system. In contrast, 'Memo' is explicitly defined as text of unlimited length. Numeric types: BigInt = 8 byte integer, Long = 4 byte integer, Integer or Int = 2 byte integer, Byte = 1 byte integer. A + (e.g. Byte+) indicates that the integer is unsigned and only positive values are allowed.
We are interested in your opinion. If you see any problems with the model that you would like to bring to our attention, please contact us by sending an email to name@gmail.com, please replace name with g.m.hagedorn!
Documentation created on 2. Nov. 2001; last update: 2005-03-30, email address revised 2010-08-05.