DiversityResources (version 1.1):
Documentation of the information model

By G. Hagedorn, 2003

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 may help you.

Besides the human readable documentation provided below, three additional technical documents are provided:

Entity relationship diagram for DiversityResources

Entity relationship diagram of DiversityResources Entity ResourceCollection, click to show attributes Entity ResourceCollectionManager, click to show attributes Entity ResourceQualityClass, click to show attributes Entity ResourceProvider, click to show attributes Entity ResourceAbstractItem, click to show attributes Entity ResourceAbstractItem_Rating, click to show attributes Entity ResourceDescription, click to show attributes Entity ResourceDescriptionTranslation, click to show attributes Entity ResourceKeyword, click to show attributes Entity ResourceTaxon, click to show attributes Entity ResourceInstance, click to show attributes Entity RscAutoGenerateMethod_Enum, click to show attributes Entity RscMediaType_Enum, click to show attributes Entity RscMediaTypeExtension_Enum, click to show attributes Entity RscMediaTypeIcon_Enum, click to show attributes Entity RscQualityLevel_Enum, click to show attributes

(You can click on the entities to go to the attribute tables.)

Two separate tables are intended to be used to allow "presentations" i.e. collection-views that can select and present material from several resource collections. Whereas the standard resource collection is optimized for management purposes (one team of managers, usually all resources are located at on the same server, usually the same or similar copyright situation), the presentation is optimized for consumption. Presentations have not yet been tested and the model presented here may well be inadequate!

Entity relationship diagram of DiversityResources

Index to entities

ResourceCollection
ResourceCollectionManager
ResourceQualityClass
ResourceProvider
ResourceAbstractItem
ResourceAbstractItem_Rating
ResourceDescription
 ResourceKeyword
ResourceTaxon
ResourceInstance
RscAutoGenerateMethod_Enum
RscMediaType_Enum
 RscMediaTypeIcon_Enum
RscPresentationMode_Enum
RscProviderStatus_Enum
RscQualityLevel_Enum

See also the separate alphabetical index to attribute names.

ResourceCollection

Defines common properties for a set of related information resources of various quality levels. A collection is defined by management (managing users, storage locations, etc.). Compare 'Presentation' for thematic collections!

Attributes and indices of the entity 'ResourceCollection'
Name Type Description / Default value & validation Rqrd./Index
ResourceCollectionID Long Resource collection ID, unique system generated value (primary key).
validation message: A resource collection ID must be a positive number.		 R I (P)
Title Text Unique user readable title, identifying the resource collection. Example: 'Ascochyta images from Melnik (1977)'. R I/I(UNM)+
Description Memo Short description of the resource collection, ca. a single paragraph long. Basic xhtml formatting tags are permitted. R -
Coverage Memo The extent or scope of the content of the resource. Coverage will typically include spatial location (e.g. a place name), temporal period (a period label, date, or date range) or taxonomic group [DC 1.1!] - -
Authors Text A list of authors displayed on the title page of the entire collection. Authors or editors of a collection need not be identical with resource managers, or creators of resources. - I(UNM)
Editors Text A list of editors displayed on the title page of the entire collection. The creators of a resource collection can decide whether they are Authors or Editors, but at least one of the two must be used. - I(UNM)
Contributors Text A list of contributors displayed on the title page of the entire collection. - -
SourceDescription Memo Where applicable, a general description of the source or origin of the resources covered in the current collection. 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). Example: 'ABE_1990_MPL' for figures from a book recorded under this ID. - I (N)
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 acknowledgement (foreign key). - I
Rights 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. Not published in public reports. - -
IconURI Text URI of a icon or logo, usually a small gif file that can be displayed next to the collection title. - -
IconLinkURI Text A URI that may optionally be placed behind the collection icon, to create a hyperlink to another site on the world-wide-web. - -
IconLinkHidden Boolean True = no link border around icon image (default); False = a colored link border is added around icon image.
Default value: True		 R -
IconDescription Text Text used for the alternative text of the image; usually this text is also displayed when the mouse hovers over the image. - -
IconWidth Long Width of image in pixels (improves speed with which html pages can be displayed). Set to 0 if no width is available.
Default value: 0		 R -
IconHeight Long Height of image in pixels (improves speed with which html pages can be displayed). Set to 0 if no height is available.
Default value: 0; Validation rule: [IconHeight]>=0 [IconHeight]<150		 R -
ReleaseDate Date/Time A date which may be up to 1 year 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: <(CLng(Now())+366), validation message: The release date may be no more than 1 year in the future. You can extend the release block at any time during that period.		 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). - -
ManagedContent Boolean True: the organization hosting the DiversityResources metadata management application is also legally responsible for the server from which the resource content is provided. Editable only by site managers, not by resource collection managers!
Default value: False		 R -
EditorialControl Boolean True if editorial control is required (always necessary for managed content). Editable only by site managers, not by resource collection managers! If set to false, EditorialReleaseBy/When are updated to document decisions.
Default value: True		 R -
EditorialControlDelegated Boolean Default is false = only site managers can set EditorialRelease, if true EditorialRelease can be set by all managers of the resource collection. Editable only by site managers, not by resource collection managers!
Default value: False		 R -
EditorialControlDocumentation Memo If EditorialControl is false or EditorialControlDelegated true, a documentation about the rejection or delegation is required. In the case of a delegation the responsibility must accepted a signed paper or agreement by email exchange should be cited. - -
EditorialControlSetBy Long The responsible site manager who delegated the editorial control. Editable only by site managers, not by resource collection managers! - -
EditorialControlSetWhen Date/Time Date/time when the EditorialControl was delegated.
Validation rule: Is Null Or <=Now()		 - -
EditorialReleaseBy Long The editorial review mechanism guarantees that no unwanted information is presented on the website. Important for images uploaded by external users. Editability depends on EditorialControlDelegated attribute. - -
EditorialReleaseWhen Date/Time Date/time up to which the all resources in the collection have been reviewed and found suitable for public release. Instances added at a later date are automatically prevented from being available in the internet. Editability like EditorialReleaseBy.
Validation rule: Is Null Or <=Now()		 - -
CheckAvailability_LastTestWhen Date/Time The data and time when the last routine availability check of all resource instances of this collection was performed. Compare also CheckAvailability_LastTestWhen of individual resource instances.
Default value: 0		 R -
CheckAvailability_Interval Integer The number of days after which a routine availability check of all resource instances shall be performed. Set to 999999 to disable routine test.
Default value: 60; Validation rule: (>0 And <501) Or 999999, validation message: The number of days between availability tests must be between 1 and 500, or set to 999999 to disable the test.		 R -
IsTemplate Boolean True for templates used to create a new resource collection together with the relevant resource classes. System attribute, not user editable, default is false.
Default value: False		 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 collection (use of ReleaseDate is not indicated, may later be changed to temporarily lock the collection).
Default value: Now()		 R -
Table validation rule:  (Not IsNull([Authors]) Or Not IsNull([Editors])) And ([EditorialControl] Or Not [ManagedContent]) And Not (IsNull([EditorialReleaseBy]) And Not IsNull([EditorialReleaseWhen])) And Not ((IsNull([EditorialControlSetBy]) And Not IsNull([EditorialControlSetWhen])) Or (Not IsNull([EditorialControlSetBy]) And IsNull([EditorialControlSetWhen]))) And Not (([EditorialControlDelegated] Or Not [EditorialControl]) And (IsNull([EditorialControlDocumentation]) Or IsNull([EditorialControlSetBy]) Or IsNull([EditorialControlSetWhen])))
Table validation text:  a) Either Authors or Editors must be defined. b) ManagedContent requires EditorialControl. c) EditorialControlDelegated=true or EditorialControl=false require E.Con.-Documentation, -SetBy and -SetWhen.
Index name:  Attributes & index properties
AcknowledgementID:  AcknowledgementID (Duplicates OK)
PrimaryKey:  ResourceCollectionID (Primary key; Unique values)
SourceReferenceID:  SourceReferenceID (Duplicates OK; Ignore Nulls)
Title:  Title (Duplicates OK)
TitleWithAuthorsUnique:  Title; Authors (Unique values; Ignore Nulls)
TitleWithEditorsUnique:  Title; Editors (Unique values; Ignore Nulls)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceAbstractItem.ResourceCollectionID
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceCollectionManager.ResourceCollectionID
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceProvider.ResourceCollectionID
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID

ResourceCollectionManager

A resource manager defines one or several persons that manage a ResourceCollection. Multiple resource managers can share the management responsibility equally, but no prioritization is yet possible.

Attributes and indices of the entity 'ResourceCollectionManager'
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 manages the resource information in the resource collection (foreign key, referring to DiversityUsers.UserID). R I/I(PM)
[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 -
Index name:  Attributes & index properties
ManagingUserID:  ManagingUserID (Duplicates OK)
PrimaryKey:  ResourceCollectionID; ManagingUserID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceCollectionManager.ResourceCollectionID

ResourceQualityClass

Quality classes contains instances of abstract items. Defined separately for each resource collection, but collectively for all providers. Examples of quality classes are preview or thumbnail versions, compressed versions, or high quality versions.

Attributes and indices of the entity 'ResourceQualityClass'
Name Type Description / Default value & validation Rqrd./Index
ResourceCollectionID Long Refers to a resource collection (foreign key and part of primary key). R I/I(PM)
QualityLevel Long A quality level for this resource class resources, as defined in RscQualityLevel_Enum (foreign key and part of primary key). R I/I(PM)
Values currently
restricted to:
QualityLevel   Title   Description
2   Information preview: snippet/excerpt   used especially for thumbnail images with ca. 60-80 pixel
4   Information preview: larger snippet/excerpt   used especially for thumbnail images with ca. 100-120 pixel
6   Information preview: informative but usually not satisfactorily   e.g. image with 150-300 pixel
8   Low quality version of resource, optimized for web use   e.g. mp3 or jpg ca. 300 pixel & high compression
10   Medium quality version of resource, optimized for web use   e.g. mp3 or jpg ca- 400-600 pixel & high compression
12   High quality version of resource, optimized for screen use   e.g. gif/png image with moderately reduced resolution
15   Highest quality of resource available (edited version)   e.g. high resolution png/tiff images, wave-audio files
40   Original, unprocessed version: high quality, but not edited   esp. files retained for backup purposes
50   Mixed or unknown quality, especially unstructured collections   may contain different media types
OnlineAvailability Byte+ Online availability scope (managers, login, intranet, internet) of resource instances of this quality class (also restricted by ItemOnlineAvailability of abstract item!).
Default value: 9; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
0   (locked)   not available; access restricted to managers of the resource collection or database
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
RequestAvailability Byte+ Availabilty scope of meta information (description, keywords); access information (URI) is available only on explicit request by electronic or postal means (also restricted by ItemRequestAvailability of abstract item!).
Default value: 9; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
URI_Part2 Text Optional string, inserted between URI_Part1 (see ResourceProvider) and the individual resource name URI_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, New-window-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 -
Values currently
restricted to:
Mode   Title   Description
L   Link   resource is presented as a link (opened in the same browser window)
N   New-Window-Link   resource is presented as a link (opened in a new browser window)
E   Embedded   resource is embedded directly into the generated document (used esp. for images)
D   Download   resource is presented as a download link (the download dialog will appear)
AutoGenerateMethodID Long Defines a method used to automatically generate instances for this class based on another resource class (usually of higher quality level). ID = 0 disables autogeneration.
Default value: 0		 R I
Values currently
restricted to:
AutoGenerateMethodID   Title
0   Autogeneration disabled
12   Preview image (150 px, color)
13   Preview image (150 px, gray/gif)
14   Preview image (300 px, color)
15   Preview image (300 px, gray/gif)
8   Thumbnail image (100 px, color)
9   Thumbnail image (100 px, gray/gif)
10   Thumbnail image (120 px, color)
11   Thumbnail image (120 px, gray/gif)
3   Tiny thumbnail image (40 px)
4   Tiny thumbnail image (60 px, color)
5   Tiny thumbnail image (60 px, gray/gif)
6   Tiny thumbnail image (80 px, color)
7   Tiny thumbnail image (80 px, gray/gif)
20   Web image (600 px, color)
21   Web image (600 px, gray/gif)
InternalNotes Text Internal notes regarding this quality version of the resource (history of editing, steps taken to generate this version, compression rate, etc.). - -
[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. R -
[LogUpdatedWhen] Date/Time The date and time when this record was last updated.
Default value: Now()		 R -
Table validation rule:  [RequestAvailability]>=[OnlineAvailability]
Table validation text:  The availability scope may not be smaller in 'On Request' (RequestAvailability) than in 'Online' (OnlineAvailability).
Index name:  Attributes & index properties
AutoGenerateMethodID:  AutoGenerateMethodID (Duplicates OK)
PrimaryKey:  ResourceCollectionID; QualityLevel (Primary key; Unique values)
QualityLevel:  QualityLevel (Duplicates OK)
ResourceQualityClassResourc...:  ResourceCollectionID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceQualityClass.ResourceCollectionID « ResourceInstance.ResourceCollectionID; ResourceQualityClass.QualityLevel « ResourceInstance.QualityLevel
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID
Simple relation (no integrity)  ResourceProvider.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID
Updates cascade  RscQualityLevel_Enum.QualityLevel « ResourceQualityClass.QualityLevel
Updates cascade  RscAutoGenerateMethod_Enum.AutoGenerateMethodID « ResourceQualityClass.AutoGenerateMethodID

ResourceProvider

Defines providers (primary/backup mirror/load balancing mirrors, online/offline status, etc.) of the content of a resource collection.

Attributes and indices of the entity 'ResourceProvider'
Name Type Description / Default value & validation Rqrd./Index
ResourceCollectionID Long Refers to a resource collection (foreign key and part of primary key). R I(PM)
ProviderOrder Long Number defining the order in which mirrored backup providers are accessed. Unique within a ResourceCollection (part of primary key).
Default value: 1		 R I(PM)
Status Text Defines status as: Online primary location, Online load balancing, Online backup/mirror, Offline backup. R -
Values currently
restricted to:
Status   Title
P   Online single primary
M   Online backup mirror
D   Online backup disabled
0   Online reserved primary
1   Online load-balancing primary
2   Online load-balancing mirror
B   Offline backup
L   LAN/Local provider
URI_Part1 Text The first part of the URI, before the variable part defined in the individual resource. It should include protocol, server, and beginning of path. Example: 'http:
www.example.net/images'.		 - -
URI_Part1_Write Text An alternative version of the first part of the URI, allowing write access (e.g. for updating mirrors or autogenerating instances). Example: 'user:pass@ftp:
www.example.net/images'. URI_Part1 may rarely allow write access, URI_Part_Write always does.		 - -
InternalNotes Memo Internal notes and remarks. - -
[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. R -
[LogUpdatedWhen] Date/Time The date and time when this record was last updated.
Default value: Now()		 R -
Index name:  Attributes & index properties
PrimaryKey:  ResourceCollectionID; ProviderOrder (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceProvider.ResourceCollectionID
Simple relation (no integrity)  ResourceProvider.ResourceCollectionID « ResourceQualityClass.ResourceCollectionID
Deletions cascade  ResourceProvider.ResourceCollectionID « ResourceInstance.ResourceCollectionID; ResourceProvider.ProviderOrder « ResourceInstance.ProviderOrder

ResourceAbstractItem

The abstract resource item defines general information that applies to all duplicates or quality versions of a resource .

Attributes and indices of the entity 'ResourceAbstractItem'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long Unique system generated value (primary key). Resource ID is a public ID. It may be stored outside of DiversityResources and should therefore not be changed after creation.
validation message: A resource ID must be a positive number.		 R I (P)
ResourceCollectionID Long Each resource belongs to a single resource collection (foreign key). The res. collection supplies general information not present in each item. R I
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 Class attributes URI_Part2 & Part4. Example: 'figure13.gif'. Required even if URI_ManualOverride is used.
Validation rule: Not (Like ' %' Or Like '% ' Or Like '% %' Or Like '%' & Chr(10) & '%' Or Like '%' & Chr(13) & '%'), validation message: Do not start or end with a blank and do not include double blanks or new line characters!		 R I
ItemOnlineAvailability Byte+ Online availability scope (managers, login, intranet, internet) of resource instances of this abstract item (also restricted by OnlineAvailability of resource class!).
Default value: 9; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
0   (locked)   not available; access restricted to managers of the resource collection or database
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
ItemRequestAvailability Byte+ Availabilty scope of meta information (description, keywords); access information (URI) is available only on explicit request by electronic or postal means (also restricted by RequestAvailability of resource class!).
Default value: 9; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
NumberingCategory Byte+ For reports where the resource will be embedded in another document: Defines a numbering sequence category (fig., tab., etc.) to be used.
Default value: 0		 R -
Values currently
restricted to:
ID   Abbreviation   Expr1002
0   any   numbering sequence for any kind of media (0)
1   fig.   Fig. = use numbering sequence for figures (1)
2   tab.   Tab. = use numbering sequence for tables (2)
3   box   Box = box with embedded text (3)
4   audio   Audio track numbering sequence (4)
5   video   Video numbering sequence (5)
6   page   (especially used for scanned text pages) (6)
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.).
Validation rule: Is Null Or Not (ALike ' %' Or ALike '% ' Or ALike '% %' Or ALike '%' & Chr(10) & '%' Or ALike '%' & Chr(13) & '%'), validation message: Do not start or end with a blank and do not include double blanks or new line characters!		 - -
UpdateStatus Byte+ 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		 R -
Values currently
restricted to:
ID   Abbreviation   Description
0   Normal   The resource has no special update status (default)
1   New   The resource is newly introduced
2   Updated   The resource has been modified or updated
SourceReferenceID Text For resources from published sources: the reference ID as defined in a bibliographic reference manager like DiversityReferences (RefID, foreign key). Compare also ResourceCollection.SourceReferenceID! - -
SourceRefDescriptionCache Text A readable description (author, year, etc.) corresponding to SourceReferenceID, automatically updated from the reference management subsystem. - -
SourceDetail Text Information how to locate original information in source, esp. page numbers. Do not add 'page' or 'p.' for page numbers (incl. roman numbers) – Specimen/culture collections: accession number or storage location code.
Validation rule: Is Null Or Not (ALike ' %' Or ALike '% ' Or ALike '% %' Or ALike '%' & Chr(10) & '%' Or ALike '%' & Chr(13) & '%'), validation message: Do not start or end with a blank and do not include double blanks or new line characters!		 - -
SourceLabel Text An identifier code used in the source from which a digitized resource is derived. This may, e. g. be the slide number of a digitized slide, or the page and figure number in a publication. - -
SourceOrder Long For resources from published sources: An ascending number reflecting the sequence of resources in the source. - -
SourceCaption Memo The full, unchanged text of the original caption of the resource in the source, esp. in the case of images (if resource has fragments/parts, the captions of all fragments are entered here).
Validation rule: Is Null Or Not (Like ' %' Or Like '% ' Or Like '% %' Or Like '%' & Chr(10) & '%' Or Like '%' & Chr(13) & '%'), validation message: Do not start or end with a blank and do not include double blanks or new line characters!		 - -
RatingCountCache Long The number of times this item was rated.
Default value: 0		 R -
RatingAverageCache Single The average rating score as obtained by averaging all values in ResourceAbstractItem_Rating for this abstract item.
Default value: 0		 R I
_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 (N)
IsTemplate Boolean Defines a template for new abstract items. Default is false, should be true only a single time within each collection. A template may already include dependent records for descriptions, taxa, and keywords.
Default value: False		 R -
[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:  [ItemRequestAvailability]>=[ItemOnlineAvailability]
Table validation text:  The item availability scope may not be smaller in 'On Request' (ItemRequestAvailability) than in 'Online' (ItemOnlineAvailability).
Index name:  Attributes & index properties
ParentResourceID:  _ParentResourceID (Duplicates OK; Ignore Nulls)
RatingAverageCache:  RatingAverageCache (Duplicates OK)
ResourceCollectionID:  ResourceCollectionID (Duplicates OK)
ResourceID:  ResourceID (Primary key; Unique values)
URI_Part3:  URI_Part3 (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceAbstractItem_Rating.ResourceID
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceDescription.ResourceID
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceInstance.ResourceID
Updates & deletions cascade  ResourceCollection.ResourceCollectionID « ResourceAbstractItem.ResourceCollectionID

ResourceAbstractItem_Rating

Individual rating scores of abstract item (relating to content, not presentation quality!).

Attributes and indices of the entity 'ResourceAbstractItem_Rating'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long Unique system generated value (primary key). Resource ID is a public ID. It may be stored outside of DiversityResources and should therefore not be changed after creation.
validation message: A resource ID must be a positive number.		 R -
EntryDate Date/Time Time when the rating was entered.
Default value: Now()		 R -
Rating Long A numerical rating value.
Default value: 0		 R -
RatingComment Text An optional comment associated with a rating. - -
RatingID Autonum Internal unique primary key number. R I (P)
Index name:  Attributes & index properties
PrimaryKey:  RatingID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceAbstractItem_Rating.ResourceID

ResourceDescription

Description of an entire resource (or an optional resource fragment). The entity combines the description and the resource fragment definition, which could also be modeled in a 1:1 relationship.

Attributes and indices of the entity 'ResourceDescription'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long ID of external resource to which this description applies (foreign key). R I(PM)
FragmentID Long A number that is unique within a resource ID, identifying the resource fragment. Use '0' for entire resource. The FragmentID is used by external modules to identify a resource fragment and should therefore not be changed after creation.
Default value: 0, validation message: You must use a positive number to identify a resource fragment.		 R I/I(PM)
FragmentLabel Text For fragments of resources: label identifying resource part, fragment, or component (e.g. figures in a composite image labeled a, b, etc.; tracks on audio resources, etc.). Use description like 'top', 'left side', etc. for unlabeled parts!
Default value: "-"		 R -
FragmentStart 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-code for text, etc. - -
FragmentEnd Text Optional: Definition in technical units of the end of this part of a multipart resource. Empty for entire resource! Compare FragmentStart for examples of technical units. - -
Creator Text Optional: Author(s), photographer, director, etc. Person(s) or institution(s) responsible for the creation of the abstract resource item (not of the instance, e.g. a scan of an image). [DC11!] - -
CreationDate Date/Time Creation date (optionally also time) of the original resource. For digitized resources this should refer to the original creation (of the abstract item, e.g. when picture was drawn or photographed), not the digitization process. - -
CreationMetadata Memo Optional: additional information regarding the creation process, e.g. image lens, scale, exposure time, etc. - -
Rights Memo Optional: Information about rights (copyright, intellectual property) held in and over the resource. Enter esp. name of person or institution holding the copyright. Leave empty if unknown or if rights are globally described in resource collection. [DC11!] - -
Language Text Language of the resource itself. Empty = not yet analysed; hyphen ('-') = language neutral (e.g. images without text). Compare also language of resource title or description meta data under DescriptionTranslation. 2 letter ISO code of language [DC 1.1!] - -
InternalNotes Memo Internal notes, applying to the entire resource or parts of the resource. Visible only to managers of the resource collection. - 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()		 - -
Table validation rule:  ([FragmentLabel]<>'-' Or [FragmentStart] Is Null And [FragmentEnd] Is Null)
Index name:  Attributes & index properties
FragmentID:  FragmentID (Duplicates OK)
InternalNotes:  InternalNotes (Duplicates OK)
PrimaryKey:  ResourceID; FragmentID (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceDescription.ResourceID
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceDescriptionTranslation.ResourceID; ResourceDescription.FragmentID « ResourceDescriptionTranslation.FragmentID
Simple relation (no integrity)  ResourceDescription.ResourceID « ResourceDisplayElement.ResourceID; ResourceDescription.FragmentID « ResourceDisplayElement.FragmentID
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceKeyword.ResourceID; ResourceDescription.FragmentID « ResourceKeyword.FragmentID
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceTaxon.ResourceID; ResourceDescription.FragmentID « ResourceTaxon.FragmentID

ResourceDescriptionTranslation

Defines language specific, translatable elements associated with a resource item. The web interface supports any language for which the language or audience specific elements have been defined for the requested resource items.

Attributes and indices of the entity 'ResourceDescriptionTranslation'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long ID of external resource to which this description applies (foreign key). R I(PM)
FragmentID Long ID of fragment ('0' for entire resource) to which the display element applies (foreign key).
Default value: 0, validation message: You must use a positive number to identify a resource fragment.		 R I(PM)
Language Text Language of the current title, description, keywords, etc. (i.e. language of meta data to the resource object; the language of the resource itself is defined in xxx). 2 letter ISO code of language [DC 1.1!]
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. If possible, the title should be unique within a resource collection (not enforced!) [DC 1.1!] R -
Description Memo Short description of the entire resource, primarily intended for use in hyperlink lists. Basic xhtml character formatting tags may be used. If no separate Caption is used, this is also used as caption for embedded resources [DC 1.1!] - -
Caption Memo Optional: If Description does not already provides an adequate caption for embedded resource display, a caption may be defined here. Basic xhtml formatting tags may be used. For images: the measurement scale (example: 'bar=10 µm') should be included here. - -
DisplayOrderOverride Text Normally the attribute is empty and resources are sorted by title. If filled, used to sort resources in a presentation. Example: 'The Area of New York' shall be sorted under 'New York''. Numbers are sorted as text, i.e. '10'<'9', use '09', '10'! - -
DisplayOrderCache Text Computed field, set to DisplayOrderOverride if present, otherwise to Title. The cache is introduced to allow indexing and fast sorting. - I
[LogUpdatedBy] Long The user who created/updated the keyword. R -
[LogUpdatedWhen] Date/Time The date and time when this record was last updated.
Default value: Now()		 R -
Index name:  Attributes & index properties
DisplayOrderCache:  DisplayOrderCache (Duplicates OK)
PrimaryKey:  ResourceID; FragmentID; Language (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceDescriptionTranslation.ResourceID; ResourceDescription.FragmentID « ResourceDescriptionTranslation.FragmentID
Simple relation (no integrity)  ResourceDescriptionTranslation.ResourceID « ResourceTaxon.ResourceID; ResourceDescriptionTranslation.FragmentID « ResourceTaxon.FragmentID

ResourceKeyword

Resource management subsystem: Keywords (general keywords applicable to the entire resource, not taxon-specific).

Attributes and indices of the entity 'ResourceKeyword'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long ID of external resource to which the keyword applies (foreign key). R I/I(PM)
FragmentID Long ID of fragment ('0' for entire resource) to which the keyword applies (foreign key).
Default value: 0, validation message: You must use a positive number to identify a resource fragment.		 R I(PM)
Keyword Text A keyword, including subject headings or private markers. A keyword entry may consist of multiple words or phrases (e. g. 'red herring'). R I(PM)
[LogUpdatedBy] Long The user who created/updated the keyword. R -
[LogUpdatedWhen] Date/Time The date and time when this record was last updated.
Default value: Now()		 R -
Index name:  Attributes & index properties
PrimaryKey:  ResourceID; FragmentID; Keyword (Primary key; Unique values)
ResourceID:  ResourceID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceKeyword.ResourceID; ResourceDescription.FragmentID « ResourceKeyword.FragmentID

ResourceTaxon

Defines organism names, features or characteristics of the organism, and topics (nomenclature, description, distribution, etc.) covered.

Attributes and indices of the entity 'ResourceTaxon'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long ID of external resource to which the taxon applies (foreign key). R I
FragmentID Long ID of fragment ('0' for entire resource) to which the taxon applies (foreign key).
Default value: 0, validation message: You must use a positive number to identify a resource fragment.		 R -
RecordID Autonum Internal number providing a primary key. A combined primary key would be ResourceID, FragmentID, and either TaxonomicName or VernacularName (one of which must be filled). Such an alternative use of fields is, however, not possible in a primary key. R I (P)
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. - I
VernacularName Text Non-scientific name of organism (e.g. 'white fir') or non-taxonomic name ('conifer', 'hardwood'). - I
NomID Long Unique ID code of the taxon. Refers to the NomID code of TaxonomyName (= foreign key) in the database DiversityTaxonomy. - 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'		 R -
FeatureList Memo Semicolon-separated list of features of the taxon, e.g. 'ascomata; asci; ascospores; germination'. - -
_TopicNomenclature Long *** All fields starting with underscore are present only as a reminder, not yet decided upon!
Default value: 0		 - -
_TopicDescription Long 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource.
Default value: 0		 - -
_TopicGeography Long 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource.
Default value: 0		 - -
_TopicPhylogeny Long 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource.
Default value: 0		 - -
_IDQuality Text *** assessment of identification quality? - -
_IDQualityResponsible Text *** person responsible for setting IDQuality? - -
[LogUpdatedBy] Long The user who created/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:  Not ([TaxonomicName] Is Null And [VernacularName] Is Null)
Index name:  Attributes & index properties
NomID:  NomID (Duplicates OK)
PrimaryKey:  RecordID (Primary key; Unique values)
ResourceID:  ResourceID (Duplicates OK)
TaxonomicName:  TaxonomicName (Duplicates OK)
VernacularName:  VernacularName (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceDescription.ResourceID « ResourceTaxon.ResourceID; ResourceDescription.FragmentID « ResourceTaxon.FragmentID
Simple relation (no integrity)  ResourceDescriptionTranslation.ResourceID « ResourceTaxon.ResourceID; ResourceDescriptionTranslation.FragmentID « ResourceTaxon.FragmentID

ResourceInstance

Resource instances define attributes that apply to a specific quality instance of an abstract information resource. Inherits information from collection, abstract item, provider, and quality class.

Attributes and indices of the entity 'ResourceInstance'
Name Type Description / Default value & validation Rqrd./Index
ResourceID Long ID of external resource to which this association applies (foreign key and part of primary key). R I(PM)
ResourceCollectionID Long Refers to a resource collection (foreign key and part of primary key). R I/I(PM)
ProviderOrder Long Refers to one of possible several resource providers within a resource collection (foreign key and part of primary key). R I/I(PM)
QualityLevel Long A quality level for this resource class resources, as defined in RscQualityLevel_Enum (foreign key and part of primary key). R I/I(PM)
Values currently
restricted to:
QualityLevel   Title   Description
2   Information preview: snippet/excerpt   used especially for thumbnail images with ca. 60-80 pixel
4   Information preview: larger snippet/excerpt   used especially for thumbnail images with ca. 100-120 pixel
6   Information preview: informative but usually not satisfactorily   e.g. image with 150-300 pixel
8   Low quality version of resource, optimized for web use   e.g. mp3 or jpg ca. 300 pixel & high compression
10   Medium quality version of resource, optimized for web use   e.g. mp3 or jpg ca- 400-600 pixel & high compression
12   High quality version of resource, optimized for screen use   e.g. gif/png image with moderately reduced resolution
15   Highest quality of resource available (edited version)   e.g. high resolution png/tiff images, wave-audio files
40   Original, unprocessed version: high quality, but not edited   esp. files retained for backup purposes
50   Mixed or unknown quality, especially unstructured collections   may contain different media types
URI_ManualOverride Text If this attribute is filled with a complete URI, it is directly used, ignoring URI_Part1 to URI_Part4. - -
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). - -
OnlineAvailabilityCache Byte+ (calculated value; = Min(Class.OnlineAvailability, ItemOnlineAvailability) AND current date > Collection.ReleaseDate AND (Collection.EditorialReleaseWhen (date) > Instance creation date OR Not EditorialControl)).
Default value: 0; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
0   (locked)   not available; access restricted to managers of the resource collection or database
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
RequestAvailabilityCache Byte+ (calculated value; = Min(Class.RequestAvailability, ItemRequestAvailability) AND current date > Collection.ReleaseDate AND (Collection.EditorialReleaseWhen (date) > Instance creation date OR Not EditorialControl)).
Default value: 0; Validation rule: In (0,3,6,9), validation message: The availability scope must come from the list of predefined values.		 R -
Values currently
restricted to:
ID   Abbreviation   Description
0   (locked)   not available; access restricted to managers of the resource collection or database
3   login   available after login to the DiversityWorkbench (= all project participants)
6   local   locally available in intranet ("in-house use") + available after login
9   public   publicly available in the Internet to everyone
CheckAvailability_LastResult Boolean The result of the last availability test (set by a link checking program). R -
CheckAvailability_LastStatusCode Integer Http status code of last availability test as defined in RFC 2616; contains 0 if status code not applicable (e. g. non-http request) or not evaluated (set by a link checking program).
Default value: 0; Validation rule: In (0,100,101,200,201,202,203,204,205,206,300,301,302,303,304,305,306,307,400,401,402,403,404,405,406,407,408,409,410,411,412,413,414,415,416,417,500,501,502,503,504,505), validation message: The status code must be a valid http 1.1 status code or 0.		 R -
Values currently
restricted to:
Code   CodeText   CategoryInfo
0   (http status code unavailable)   (---)
100   Continue   (Informational)
101   Switching Protocols   (Informational)
200   OK   (Successful)
201   Created   (Successful)
202   Accepted   (Successful)
203   Non-Authoritative Information   (Successful)
204   No Content   (Successful)
205   Reset Content   (Successful)
206   Partial Content   (Successful)
300   Multiple Choices   (Redirection)
301   Moved Permanently   (Redirection)
302   Found   (Redirection)
303   See Other   (Redirection)
304   Not Modified   (Redirection)
305   Use Proxy   (Redirection)
306   (Unused)   (Redirection)
307   Temporary Redirect   (Redirection)
400   Bad Request   (Client Error)
401   Unauthorized   (Client Error)
402   Payment Required   (Client Error)
403   Forbidden   (Client Error)
404   Not Found   (Client Error)
405   Method Not Allowed   (Client Error)
406   Not Acceptable   (Client Error)
407   Proxy Authentication Required   (Client Error)
408   Request Timeout   (Client Error)
409   Conflict   (Client Error)
410   Gone   (Client Error)
411   Length Required   (Client Error)
412   Precondition Failed   (Client Error)
413   Request Entity Too Large   (Client Error)
414   Request-URI Too Long   (Client Error)
415   Unsupported Media Type   (Client Error)
416   Requested Range Not Satisfiable   (Client Error)
417   Expectation Failed   (Client Error)
500   Internal Server Error   (Server Error)
501   Not Implemented   (Server Error)
502   Bad Gateway   (Server Error)
503   Service Unavailable   (Server Error)
504   Gateway Timeout   (Server Error)
505   HTTP Version Not Supported   (Server Error)
CheckAvailability_LastTestWhen Date/Time The date and time the availability was last tested (set by a link checking program). A standard testing cycle might retest every 3-6 days. The date is no longer updated when instance is deactivated.
Default value: 0		 R -
CheckAvailability_LastSuccessWhen Date/Time The date and time when the availability test result was positive the last time (set by a link checking program).
Default value: 0		 R -
CheckAvailability_Deactivated Boolean Automatically deactivated if LastResult is negative and LastSuccessWhen more than 14 days ago (set by a link checking program). Date and time when the resource instance was deactivated can be found in CheckAvailability_LastTestWhen.
Default value: 0		 R -
CheckAvailability_Attempts Long The total number of availability tests since the last ResetWhen (set by a link checking program).
Default value: 0		 R -
CheckAvailability_Failures Long The total number of failed availability tests since the last ResetWhen (set by a link checking program).
Default value: 0		 R -
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).
Default value: Now()		 R -
MediaTypeID Integer Media type according to MIME, refers to RscMediaType_Enum (foreign key). May be determined based on information in http requests or using recognized file extension (compare RscMediaTypeExtension_Enum). 0 indicates an unknown media type.
Default value: 0		 R -
Values currently
restricted to:
MediaTypeID   MediaType   Description
0   -   media type unknown / not recognized
1   image/gif   Compuserve Image (gif)
2   image/jpeg   Image File (jpeg)
3   image/png   Portable Network Graphic (png)
4   image/tiff   Image File (TIFF)
99   image/???   ?? Other image files ?? SCT PSP GIF BMP PCX IFF DXF CGM CMX CDR LBM CUT IMG HGL JIF KDC FPX PCD PIC PCT MAC DRW PSD PBM PGM PPM RAW CT RAS TGA CLP EMF WMF RLE DIB WPG DCX
100   text/plain   Plain Text
101   text/html   Web Document
102   text/sgml   SGML file
103   text/css   Cascading Style Sheet
104   text/xml   XML file
200   application/postscript   Postscript
201   application/pdf   Adobe Acrobat Document
210   application/x-zip-compressed   Compressed Archive File (zip)
211   application/x-tar   Compressed Archive File (various)
212   application/x-compressed   Compressed Archive File (gzip)
213   application/zip   Compressed Archive File (zip)
220   application/msaccess   Microsoft Access Database
222   application/vnd.ms-excel   Microsoft Excel Worksheet
224   application/vnd.ms-powerpoint   Microsoft Powerpoint Presentation
226   application/vnd.visio   Microsoft Visio Drawing
228   application/msword   Microsoft Word Document
301   audio/mpeg   Audio MP3 Sound
302   audio/wav   Audio Wave File
303   audio/mid   Audio MIDI Sequence
401   video/mpeg   Video MPEG Movie
402   video/quicktime   Quicktime Movie
403   video/avi   Video clip
ContentLength Long Size of resource in bytes: file size or content length of download stream. The information is used to add size indications to links, helping resource consumers to make appropriate choices. The value is -1 if the size is unknown.
Default value: -1		 R -
[LastModified] Date/Time Last-Modified date obtained during resource request (e. g. from http-header). Used to identify updated instances and update attributes that can be automatically obtained (e.g. size, pixel, etc.).
Default value: #12/30/1899#		 R -
ImgPixelHeight Integer 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 Integer 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 Integer Optional for images: The color depth in bits/pixel. The value is 0 if the color depth is not available.
Default value: 0		 R -
[LogUpdatedWhen] Date/Time The date and time when this record was last updated. The creation time is not recorded, since instance records are automatically created and deleted with item, provider, or quality class records.
Default value: Now()		 R -
Index name:  Attributes & index properties
PrimaryKey:  ResourceID; ResourceCollectionID; ProviderOrder; QualityLevel (Primary key; Unique values)
ProviderOrder:  ProviderOrder (Duplicates OK)
QualityLevel:  QualityLevel (Duplicates OK)
ResourceCollectionID:  ResourceCollectionID (Duplicates OK)
Relation type:  Attributes involved
Updates & deletions cascade  ResourceAbstractItem.ResourceID « ResourceInstance.ResourceID
Updates & deletions cascade  ResourceQualityClass.ResourceCollectionID « ResourceInstance.ResourceCollectionID; ResourceQualityClass.QualityLevel « ResourceInstance.QualityLevel
Deletions cascade  ResourceProvider.ResourceCollectionID « ResourceInstance.ResourceCollectionID; ResourceProvider.ProviderOrder « ResourceInstance.ProviderOrder
Updates cascade  RscMediaType_Enum.MediaTypeID « ResourceInstance.MediaTypeID

RscAutoGenerateMethod_Enum

Definitions how to create automatically generate instances for resource quality classes based on other classes.

Attributes and indices of the entity 'RscAutoGenerateMethod_Enum'
Name Type Description / Default value & validation Rqrd./Index
AutoGenerateMethodID Long Unique ID for the autogeneration method (primary key). The method with ID=0 is special, it defines "autogeneration is disabled". R I (P)
Title Text User readable, short and unique description of autogeneration method. - I (U)
ImgPixelExtension Integer Maximum extension (height or width) of autogenerated images in pixel. The other dimension will be scaled so that the aspect ratio remains constant. AutoGeneratePixelHeight/Width should both be 0.
Default value: 0		 R -
ImgPixelHeight Integer Height of autogenerated images in pixel. Enter 0 to keep aspect ratio of the image and resize based on width. AutoGeneratePixelExtension should be = 0 if used.
Default value: 0		 R -
ImgPixelWidth Integer Width of autogenerated images in pixel. Enter 0 to keep aspect ratio of the image and resize based on heigth. AutoGeneratePixelExtension should be = 0 if used.
Default value: 0		 R -
ImgCropping Byte+ Border around the original image in percent to be cropped, cropping occurs before reducing the size as requested in ImgPixelExtension/Height/Width. In a 1000x500 pixel image, ImgCropping=10 will leave 900 x 450 pixel after cropping (5% left, 5% right).
Default value: 0		 R -
ImgColorDepth Long If autogeneration is requested: The color depth in bits/pixel. The value 0 indicates that the color depth shall remain unchanged.
Default value: 0		 R -
ImgGrayscale Boolean True if image shall be gray-scale. R -
_Format Text Destination format for resource instance (currently as file extension, may later be changed to MIME types)
Not used, format is already defined in URI-components through file extension!		 - -
_Compression Text Compression factor for compression algorithms causing information loss. PROBLEM: unclear how to define for all formats! - -
InternalNotes Text Internal notes regarding this quality version of the resource (history of editing, steps taken to generate this version, compression rate, etc.). - -
Index name:  Attributes & index properties
PrimaryKey:  AutoGenerateMethodID (Primary key; Unique values)
Title:  Title (Unique values)
Relation type:  Attributes involved
Updates cascade  RscAutoGenerateMethod_Enum.AutoGenerateMethodID « ResourceQualityClass.AutoGenerateMethodID
Updates cascade  RscAutoGenerateMethod_Enum.AutoGenerateMethodID « RscQualityLevel_Enum._ImageAutoGenerateDefault

RscHTTP11StatusCode_Enum

Contains definitions of http status codes as defined in RFC 2616. Used in the context of the Availability Check (ResourceInstance) to report messages.

Attributes and indices of the entity 'RscHTTP11StatusCode_Enum'
Name Type Description / Default value & validation Rqrd./Index
Code Integer Code number according to internet standard RFC 2616. R I (P)
CodeText Text Short title. R I
Category Text Heading or category. R -
TechnicalDescriptionRFC2616 Memo Full text of description. R -
Index name:  Attributes & index properties
CodeText:  CodeText (Duplicates OK)
PrimaryKey:  Code (Primary key; Unique values)

RscMediaType_CompleteImported

Temporary table, documenting possible MIME media types. Not all media types should be made available in the system!

Attributes and indices of the entity 'RscMediaType_CompleteImported'
Name Type Description / Default value & validation Rqrd./Index
ID Autonum   R I (P)
Type Text   - -
Subtype Text   - -
Description Text   - -
Used Boolean   - -
DoNotUse Boolean   - -
Index name:  Attributes & index properties
PrimaryKey:  ID (Primary key; Unique values)

RscMediaType_Enum

System wide enumeration of resource media types, according to MIME (rfc 2046; e.g. file format image/gif).

Attributes and indices of the entity 'RscMediaType_Enum'
Name Type Description / Default value & validation Rqrd./Index
MediaTypeID Integer Unique internal ID number for a media type. R I (P)
MediaType Text Media type according to MIME (rfc 2046; e.g. file format: image/gif). R I
Examples
values (any
other values
may be added):
MediaTypeID
0
1
2
(Note: Only the first 3 rows of the pick list are displayed.)
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:  Attributes involved
Updates cascade  RscMediaType_Enum.MediaTypeID « ResourceInstance.MediaTypeID
Updates & deletions cascade  RscMediaType_Enum.MediaTypeID « RscMediaTypeExtension_Enum.MediaTypeID
Updates & deletions cascade  RscMediaType_Enum.MediaTypeID « RscMediaTypeIcon_Enum.MediaTypeID

RscMediaTypeExtension_Enum

System wide definition of file extensions to be recognized as a media type (e.g. '.gif' for image/gif).

Attributes and indices of the entity 'RscMediaTypeExtension_Enum'
Name Type Description / Default value & validation Rqrd./Index
RecognizedFileExtension Text File extension recognized for a media type. R I (P)
MediaTypeID Integer ID number of media type (foreign key). R -
Values currently
restricted to:
MediaTypeID   MediaType   Description
0   -   media type unknown / not recognized
1   image/gif   Compuserve Image (gif)
2   image/jpeg   Image File (jpeg)
3   image/png   Portable Network Graphic (png)
4   image/tiff   Image File (TIFF)
99   image/???   ?? Other image files ?? SCT PSP GIF BMP PCX IFF DXF CGM CMX CDR LBM CUT IMG HGL JIF KDC FPX PCD PIC PCT MAC DRW PSD PBM PGM PPM RAW CT RAS TGA CLP EMF WMF RLE DIB WPG DCX
100   text/plain   Plain Text
101   text/html   Web Document
102   text/sgml   SGML file
103   text/css   Cascading Style Sheet
104   text/xml   XML file
200   application/postscript   Postscript
201   application/pdf   Adobe Acrobat Document
210   application/x-zip-compressed   Compressed Archive File (zip)
211   application/x-tar   Compressed Archive File (various)
212   application/x-compressed   Compressed Archive File (gzip)
213   application/zip   Compressed Archive File (zip)
220   application/msaccess   Microsoft Access Database
222   application/vnd.ms-excel   Microsoft Excel Worksheet
224   application/vnd.ms-powerpoint   Microsoft Powerpoint Presentation
226   application/vnd.visio   Microsoft Visio Drawing
228   application/msword   Microsoft Word Document
301   audio/mpeg   Audio MP3 Sound
302   audio/wav   Audio Wave File
303   audio/mid   Audio MIDI Sequence
401   video/mpeg   Video MPEG Movie
402   video/quicktime   Quicktime Movie
403   video/avi   Video clip
Index name:  Attributes & index properties
PrimaryKey:  RecognizedFileExtension (Primary key; Unique values)
Relation type:  Attributes involved
Updates & deletions cascade  RscMediaType_Enum.MediaTypeID « RscMediaTypeExtension_Enum.MediaTypeID

RscMediaTypeIcon_Enum

System wide enumeration of generic icon images for resource media types (file formats), optionally quality level dependent.

Attributes and indices of the entity 'RscMediaTypeIcon_Enum'
Name Type Description / Default value & validation Rqrd./Index
MediaTypeID Integer ID number of media type (foreign key + 1st part of primary key). R I(PM)
Values currently
restricted to:
MediaTypeID   MediaType   Description
0   -   media type unknown / not recognized
1   image/gif   Compuserve Image (gif)
2   image/jpeg   Image File (jpeg)
3   image/png   Portable Network Graphic (png)
4   image/tiff   Image File (TIFF)
99   image/???   ?? Other image files ?? SCT PSP GIF BMP PCX IFF DXF CGM CMX CDR LBM CUT IMG HGL JIF KDC FPX PCD PIC PCT MAC DRW PSD PBM PGM PPM RAW CT RAS TGA CLP EMF WMF RLE DIB WPG DCX
100   text/plain   Plain Text
101   text/html   Web Document
102   text/sgml   SGML file
103   text/css   Cascading Style Sheet
104   text/xml   XML file
200   application/postscript   Postscript
201   application/pdf   Adobe Acrobat Document
210   application/x-zip-compressed   Compressed Archive File (zip)
211   application/x-tar   Compressed Archive File (various)
212   application/x-compressed   Compressed Archive File (gzip)
213   application/zip   Compressed Archive File (zip)
220   application/msaccess   Microsoft Access Database
222   application/vnd.ms-excel   Microsoft Excel Worksheet
224   application/vnd.ms-powerpoint   Microsoft Powerpoint Presentation
226   application/vnd.visio   Microsoft Visio Drawing
228   application/msword   Microsoft Word Document
301   audio/mpeg   Audio MP3 Sound
302   audio/wav   Audio Wave File
303   audio/mid   Audio MIDI Sequence
401   video/mpeg   Video MPEG Movie
402   video/quicktime   Quicktime Movie
403   video/avi   Video clip
QualityLevel Long A quality level as defined in RscQualityLevel_Enum (foreign key + 2nd part of primary key). R I/I(PM)
Values currently
restricted to:
QualityLevel   Title
2   Information preview: snippet/excerpt
4   Information preview: larger snippet/excerpt
6   Information preview: informative but usually not satisfactorily
8   Low quality version of resource, optimized for web use
10   Medium quality version of resource, optimized for web use
12   High quality version of resource, optimized for screen use
15   Highest quality of resource available (edited version)
40   Original, unprocessed version: high quality, but not edited
50   Mixed or unknown quality, especially unstructured collections
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:  Attributes involved
Updates & deletions cascade  RscMediaType_Enum.MediaTypeID « RscMediaTypeIcon_Enum.MediaTypeID
Updates & deletions cascade  RscQualityLevel_Enum.QualityLevel « RscMediaTypeIcon_Enum.QualityLevel

RscPresentationMode_Enum

System wide enumeration of possible presentation modes (link, embedded, etc.).

Attributes and indices of the entity 'RscPresentationMode_Enum'
Name Type Description / Default value & validation Rqrd./Index
Mode Text Unique 1 letter code defining a presentation mode (primary key). Code values are fixed and may be directly evaluated by applications. R I (P)
Title Text User readable, unique title for presentation mode. R I (U)
Description Text Optional additional description of presentation mode. - -
DisplayOrder Long Display order / sequence.
Default value: 0		 R -
Index name:  Attributes & index properties
PrimaryKey:  Mode (Primary key; Unique values)
Title:  Title (Unique values)

RscProviderStatus_Enum

System wide enumeration of provider status, used in ResourceProvider.

Attributes and indices of the entity 'RscProviderStatus_Enum'
Name Type Description / Default value & validation Rqrd./Index
Status Text Unique 1 letter code defining a provider status (primary key). Code values are fixed and may be directly evaluated by applications. R I (P)
Title Text User readable, unique title for provider status. R I (U)
Description Text Optional additional description of provider status. - -
AccessType Text 'Internet', 'LAN', 'offline storage'.
Validation rule: In ('Internet','LAN','Offline')		 R -
IsOnline Boolean Is the provider available online? R -
InternetAccess Boolean In the provider available on the Internet? R -
LoadBalancing Boolean Is the access load shared between multiple providers? R -
ContentMaster Boolean This provider provides the original resource version, from which backup or load balancing mirrors may be updated (if they are present). R -
DisplayOrder Long Display order / sequence.
Default value: 0		 R -
Index name:  Attributes & index properties
PrimaryKey:  Status (Primary key; Unique values)
Title:  Title (Unique values)

RscQualityLevel_Enum

System wide enumeration of quality levels, used in ResourceQualityClass.

Attributes and indices of the entity 'RscQualityLevel_Enum'
Name Type Description / Default value & validation Rqrd./Index
QualityLevel Long Unique ID for the quality level (primary key). A higher level indicates a higher quality. R I (P)
Abbreviation Text Short abbreviated description of the quality level, may displayed in the user interface. - -
Title Text User readable, unique title for quality level, e.g. 'original version' or 'modified'; for images: 'full resolution', 'default compressed', or 'thumbnail image'. R I (U)
Description Text Additional description of quality level. R -
_PresentationDefault Text Default for recommended presentation mode (Link, New-window-link, Download, Embed) of new ResourceQualityClass records based on this quality level.
Default value: "L"; Validation rule: "L" Or "N" Or "E" Or "D"		 R -
Values currently
restricted to:
Mode   Title   Description
L   Link   resource is presented as a link (opened in the same browser window)
N   New-Window-Link   resource is presented as a link (opened in a new browser window)
E   Embedded   resource is embedded directly into the generated document (used esp. for images)
D   Download   resource is presented as a download link (the download dialog will appear)
_ImageAutoGenerateDefault Long Default for recommended method to automatically generate instances for ResourceClasses of this quality level (currently only for images).
Default value: 0		 R -
Values currently
restricted to:
AutoGenerateMethodID   Title
0   Autogeneration disabled
12   Preview image (150 px, color)
13   Preview image (150 px, gray/gif)
14   Preview image (300 px, color)
15   Preview image (300 px, gray/gif)
8   Thumbnail image (100 px, color)
9   Thumbnail image (100 px, gray/gif)
10   Thumbnail image (120 px, color)
11   Thumbnail image (120 px, gray/gif)
3   Tiny thumbnail image (40 px)
4   Tiny thumbnail image (60 px, color)
5   Tiny thumbnail image (60 px, gray/gif)
6   Tiny thumbnail image (80 px, color)
7   Tiny thumbnail image (80 px, gray/gif)
20   Web image (600 px, color)
21   Web image (600 px, gray/gif)
_Abridged Boolean Information in this quality level is abridged, e.g. thumbnail image preview, or short preview video sequences.
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)
Title:  Title (Unique values)
Relation type:  Attributes involved
Updates cascade  RscQualityLevel_Enum.QualityLevel « ResourceQualityClass.QualityLevel
Updates cascade  RscAutoGenerateMethod_Enum.AutoGenerateMethodID « RscQualityLevel_Enum._ImageAutoGenerateDefault
Updates & deletions cascade  RscQualityLevel_Enum.QualityLevel « RscMediaTypeIcon_Enum.QualityLevel

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.

Attribute names of system fields and logging fields (record creation or updating) are enclosed in square brackets: [].

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. All text is Unicode text. 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 24. Sep. 2003; last update: 2005-03-30, email address revised 2010-08-05.

This work is licensed under a Creative Commons License Valid XHTML 1.0! Valid CSS1!