Diversity Workbench: Schema for DiversityResources, version '1.1'.
Document last revised on 28.Sep.2003 10:28
Copyright 2001-2002 G. Hagedorn. All rights reserved.
Suggestions how to correct or improve the schema are welcome! 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! Resource collection ID, unique system generated value (primary key). Unique user readable title, identifying the resource collection. Example: 'Ascochyta images from Melnik (1977)'. Short description of the resource collection, ca. a single paragraph long. Basic xhtml formatting tags are permitted. 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!] 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. 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. A list of contributors displayed on the title page of the entire collection. 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. 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. A readable description (author, year, etc.) corresponding to SourceReferenceID, automatically updated from the reference management subsystem. Refers to an acknowledgement definition that documents source and intellectual property rights, and provides a formatted acknowledgement (foreign key). 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. Internal notes and remarks. Not published in public reports. URI of a icon or logo, usually a small gif file that can be displayed next to the collection title. A URI that may optionally be placed behind the collection icon, to create a hyperlink to another site on the world-wide-web. True = no link border around icon image (default); False = a colored link border is added around icon image. Text used for the alternative text of the image; usually this text is also displayed when the mouse hovers over the image. Width of image in pixels (improves speed with which html pages can be displayed). Set to 0 if no width is available. Height of image in pixels (improves speed with which html pages can be displayed). Set to 0 if no height is available. 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). 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). 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! 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 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! 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. The responsible site manager who delegated the editorial control. Editable only by site managers, not by resource collection managers! Date/time when the EditorialControl was delegated. 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. 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. 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. The number of days after which a routine availability check of all resource instances shall be performed. Set to 999999 to disable routine test. True for templates used to create a new resource collection together with the relevant resource classes. System attribute, not user editable, default is false. The user who created this record. 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). 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. ID of the resource collection (foreign key). ID of user who may manages the resource information in the resource collection (foreign key, referring to DiversityUsers.UserID). The user who created this record. The date and time when this record was created. 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. Refers to a resource collection (foreign key and part of primary key). A quality level for this resource class resources, as defined in RscQualityLevel_Enum (foreign key and part of primary key). Online availability scope (managers, login, intranet, internet) of resource instances of this quality class (also restricted by ItemOnlineAvailability of abstract item!). 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!). Optional string, inserted between URI_Part1 (see ResourceProvider) and the individual resource name URI_Part3 (see ResourceAbstractItem). 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. Recommended presentation mode (Link, New-window-link, Download, Embed). The web interface may either follow the recommendation or implement its own rules. 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. Internal notes regarding this quality version of the resource (history of editing, steps taken to generate this version, compression rate, etc.). The user who created this record. The date and time when this record was created. The user who updated this record the last time. The date and time when this record was last updated. Defines providers (primary/backup mirror/load balancing mirrors, online/offline status, etc.) of the content of a resource collection. Refers to a resource collection (foreign key and part of primary key). Number defining the order in which mirrored backup providers are accessed. Unique within a ResourceCollection (part of primary key). Defines status as: Online primary location, Online load balancing, Online backup/mirror, Offline backup. 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'. 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. Internal notes and remarks. The user who created this record. The date and time when this record was created. The user who updated this record the last time. The date and time when this record was last updated. The abstract resource item defines general information that applies to all duplicates or quality versions of a resource . 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. Each resource belongs to a single resource collection (foreign key). The res. collection supplies general information not present in each item. 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. Online availability scope (managers, login, intranet, internet) of resource instances of this abstract item (also restricted by OnlineAvailability of resource class!). 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!). For reports where the resource will be embedded in another document: Defines a numbering sequence category (fig., tab., etc.) to be used. 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.). 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. For resources from published sources: the reference ID as defined in a bibliographic reference manager like DiversityReferences (RefID, foreign key). Compare also ResourceCollection.SourceReferenceID! A readable description (author, year, etc.) corresponding to SourceReferenceID, automatically updated from the reference management subsystem. 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. 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. For resources from published sources: An ascending number reflecting the sequence of resources in the source. 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). The number of times this item was rated. The average rating score as obtained by averaging all values in ResourceAbstractItem_Rating for this abstract item. 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**] 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. The user who created this record. The date and time when this record was created. The user who updated this record the last time. The date and time when this record was last updated. Individual rating scores of abstract item (relating to content, not presentation quality!). 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. Time when the rating was entered. A numerical rating value. An optional comment associated with a rating. Internal unique primary key number. 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. ID of external resource to which this description applies (foreign key). 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. 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! 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. 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. 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!] 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. Optional: additional information regarding the creation process, e.g. image lens, scale, exposure time, etc. 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 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!] Internal notes, applying to the entire resource or parts of the resource. Visible only to managers of the resource collection. The user who created this record. The date and time when this record was created. The user who updated this record the last time. The date and time when this record was last updated. 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. ID of external resource to which this description applies (foreign key). ID of fragment ('0' for entire resource) to which the display element applies (foreign key). 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!] 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!] 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!] 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. 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'! Computed field, set to DisplayOrderOverride if present, otherwise to Title. The cache is introduced to allow indexing and fast sorting. The user who created/updated the keyword. The date and time when this record was last updated. Resource management subsystem: Keywords (general keywords applicable to the entire resource, not taxon-specific). ID of external resource to which the keyword applies (foreign key). ID of fragment ('0' for entire resource) to which the keyword applies (foreign key). A keyword, including subject headings or private markers. A keyword entry may consist of multiple words or phrases (e. g. 'red herring'). The user who created/updated the keyword. The date and time when this record was last updated. Defines organism names, features or characteristics of the organism, and topics (nomenclature, description, distribution, etc.) covered. ID of external resource to which the taxon applies (foreign key). ID of fragment ('0' for entire resource) to which the taxon applies (foreign key). 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. Scientific name of taxon (if possible include authors). Any name can be entered, regardless of whether it is present in taxonomy or not. Non-scientific name of organism (e.g. 'white fir') or non-taxonomic name ('conifer', 'hardwood'). Unique ID code of the taxon. Refers to the NomID code of TaxonomyName (= foreign key) in the database DiversityTaxonomy. Qualification of the identification e.g. 'cf.', 'aff.', 'sp. nov.'. 'ORIGINAL' = according to original description (e.g. publication), else name of person responsible for a later identification. Semicolon-separated list of features of the taxon, e.g. 'ascomata; asci; ascospores; germination'. *** All fields starting with underscore are present only as a reminder, not yet decided upon! 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource. 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource. 0 = not covered (or negligible), 1 = partly covered, 2 = primary topic of resource. *** assessment of identification quality? *** person responsible for setting IDQuality? The user who created/updated this record the last time. The date and time when this record was last updated. 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. ID of external resource to which this association applies (foreign key and part of primary key). Refers to a resource collection (foreign key and part of primary key). Refers to one of possible several resource providers within a resource collection (foreign key and part of primary key). A quality level for this resource class resources, as defined in RscQualityLevel_Enum (foreign key and part of primary key). If this attribute is filled with a complete URI, it is directly used, ignoring URI_Part1 to URI_Part4. 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). (calculated value; = Min(Class.OnlineAvailability, ItemOnlineAvailability) AND current date > Collection.ReleaseDate AND (Collection.EditorialReleaseWhen (date) > Instance creation date OR Not EditorialControl)). (calculated value; = Min(Class.RequestAvailability, ItemRequestAvailability) AND current date > Collection.ReleaseDate AND (Collection.EditorialReleaseWhen (date) > Instance creation date OR Not EditorialControl)). The result of the last availability test (set by a link checking program). 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). 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. The date and time when the availability test result was positive the last time (set by a link checking program). 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. The total number of availability tests since the last ResetWhen (set by a link checking program). The total number of failed availability tests since the last ResetWhen (set by a link checking program). 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). 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. 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. 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.). 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. 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. Optional for images: The color depth in bits/pixel. The value is 0 if the color depth is not available. 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. Definitions how to create automatically generate instances for resource quality classes based on other classes. Unique ID for the autogeneration method (primary key). The method with ID=0 is special, it defines "autogeneration is disabled". User readable, short and unique description of autogeneration method. 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. 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. 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. 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). If autogeneration is requested: The color depth in bits/pixel. The value 0 indicates that the color depth shall remain unchanged. True if image shall be gray-scale. 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 factor for compression algorithms causing information loss. PROBLEM: unclear how to define for all formats! Internal notes regarding this quality version of the resource (history of editing, steps taken to generate this version, compression rate, etc.). Contains definitions of http status codes as defined in RFC 2616. Used in the context of the Availability Check (ResourceInstance) to report messages. Code number according to internet standard RFC 2616. Short title. Heading or category. Full text of description. Temporary table, documenting possible MIME media types. Not all media types should be made available in the system! System wide enumeration of resource media types, according to MIME (rfc 2046; e.g. file format image/gif). Unique internal ID number for a media type. Media type according to MIME (rfc 2046; e.g. file format: image/gif). Description of the media type, displayed in user interface. The quality level is compatible with current internet browsers. Resources of this format can be embedded in html files using the html image tag. Resources of this format can be embedded in html files directly (header/body less html resources designed to be included elsewhere). System wide definition of file extensions to be recognized as a media type (e.g. '.gif' for image/gif). File extension recognized for a media type. ID number of media type (foreign key). System wide enumeration of generic icon images for resource media types (file formats), optionally quality level dependent. ID number of media type (foreign key + 1st part of primary key). A quality level as defined in RscQualityLevel_Enum (foreign key + 2nd part of primary key). 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. Width of small icon image in pixel. Height of small icon image in pixel. Like SmallIconURI, but for a larger icon size. Width of large icon image in pixel. Height of large icon image in pixel. System wide enumeration of possible presentation modes (link, embedded, etc.). Unique 1 letter code defining a presentation mode (primary key). Code values are fixed and may be directly evaluated by applications. User readable, unique title for presentation mode. Optional additional description of presentation mode. Display order / sequence. System wide enumeration of provider status, used in ResourceProvider. Unique 1 letter code defining a provider status (primary key). Code values are fixed and may be directly evaluated by applications. User readable, unique title for provider status. Optional additional description of provider status. 'Internet', 'LAN', 'offline storage'. Is the provider available online? In the provider available on the Internet? Is the access load shared between multiple providers? This provider provides the original resource version, from which backup or load balancing mirrors may be updated (if they are present). Display order / sequence. System wide enumeration of quality levels, used in ResourceQualityClass. Unique ID for the quality level (primary key). A higher level indicates a higher quality. Short abbreviated description of the quality level, may displayed in the user interface. User readable, unique title for quality level, e.g. 'original version' or 'modified'; for images: 'full resolution', 'default compressed', or 'thumbnail image'. Additional description of quality level. Default for recommended presentation mode (Link, New-window-link, Download, Embed) of new ResourceQualityClass records based on this quality level. Default for recommended method to automatically generate instances for ResourceClasses of this quality level (currently only for images). Information in this quality level is abridged, e.g. thumbnail image preview, or short preview video sequences. Information of this quality level is normally not intended for public use, esp. original scans, internal backup copies, etc. (potential root element for the namespace of current database subsystem)