Slide Menu
Search Help Show/Hide Menu

Item Identification

Title: REFERENCE_DOCUMENTS
Short Name: REFERENCE_DOCUMENTS
Status: Planned
Abstract:

Stores information such as title, author, and publication year about reference documents that were used to gather salmon abundance data.

Entity Information

Entity Type: Data Table
Active Version?: Yes
Schema Name: SPS
Description:

Stores information such as title, author, and publication year about reference documents that were used to gather salmon abundance data.

Data Attributes

Attribute Summary

Rubric Score Primary Key? Name Type Description
100
REFERENCE_ID NUMBER A reference number originating from the MS-Access database version, used to identify a particulare reference document. This ID may not be consistent over time due to the nature of the data source.
100
Primary Key REFERENCE_DOCUMENT_DB_ID NUMBER Database-generated primary key (unique identifier) for each REFERENCE_DOCUMENTS record, created by an internal sequence generator and used by the database to maintain referential integrity. This ID is not designed to be managed by users. This primary key constraint is named RD_PK.
100
DOCUMENT_TYPE NUMBER Foreign key to the REFERENCE_DOCUMENT_TYPES table to link REFERENCE_DOCUMENTS records to a specific REF_NO using the REFERENCEDOCUMENTTYPE_PK primary key. This foreign key constraint is named RDT_RD_FK.
100
TITLE VARCHAR2 The recognized, given title for a piece of reference material.
100
AUTHOR VARCHAR2 The name of the author of a piece of reference material.
100
PUBLICATION_YEAR NUMBER If the reference material is published, the four-digit year in which the reference material was published.
100
PUBLISHER VARCHAR2 If the reference material is published, the name of the publisher of the reference material.
100
NOTES VARCHAR2 Any comments or other information about the reference material or its publication or use.
100
REFERENCE_TYPE VARCHAR2 The classification of a reference document to its PRIMARY category. (If the reference document can be classified to more than one category, others are not accomodated here.) Acceptable values include: Age Reference, Catch Reference, Hatchery Reference, Spawner Reference, and Wild-Fraction Reference.
100
EXTERNAL_DOCUMENT_LINK VARCHAR2 A web-link to any pertinent external document that relates to this reference document OR the link to the reference document itself.
100
RECORD_APPROVED_BY_PERSON VARCHAR2 If there is a certification process for these records, name of person who certified approval of the particular record.
100
RECORD_APPROVED_ON_DATE DATE If there is a certification process for these records, date that the particular record was approved or officially certified.
100
RECORD_COMPUTER_LOAD_BY_USER VARCHAR2 The username that loaded the record into the database. The username is dynamically captured by the database trigger when the record is inserted and saved to the database. This person may have no knowledge of content or meaning but ran the computer process that put the record into the database.
100
RECORD_COMPUTER_LOAD_ON_DATE TIMESTAMP(4) The date that the record was loaded into the database. This date is dynamically captured by the database trigger when the record is inserted and saved.
100
RECORD_CREATED_BY_PERSON VARCHAR2 The name of the person who originated this record PRIOR to its being entered into the database. The name of the person to contact with administrative questions or an explanation of it content.
100
RECORD_CREATED_ON_DATE DATE The date, or approximate date, that the person with content knowledge originated this record PRIOR to its being entered into the database.
100
RECORD_EFFECTIVE_DATE DATE If necessary, the date that the individual record becomes effective. Prior to this date the record is not valid.
100
RECORD_EXPIRATION_DATE DATE If necessary, the date that the individual record ceases to be effective. To force a midnight expiration, this may be set by "Select to_date(to_char(sysdate +1 ,'mm/dd/yyyy')||' 23:59:59','mm/dd/yyyy hh24:mi:ss') from dual". After this date and time the record is not valid.
100
RECORD_LAST_EDITED_BY_USER VARCHAR2 The username of the last person who modified this record. This username is dynamically captured by the database trigger any time the record is edited.
100
RECORD_LAST_EDITED_ON_DATE TIMESTAMP(4) The last date that the particular record was modified. This date is dynamically captured by the database trigger any time the record is edited.
100
RECORD_NUMBER_OF_EDITS NUMBER The number of times that the particular record was modified. This count is dynamically incremented by 1 by the database trigger each time the record is edited.
100
RECORD_SOFT_DELETED VARCHAR2 Flag whether or not this record has the "Deleted" status. Null means this record has NOT been deleted. "Y" means this record HAS been deleted. This flag allows "deleted" records to remain in the table for technical reasons. When the record is "Hard Deleted" it will be removed from this table and may or may not be placed in a historical table to preserve historical status.
100
RECORD_STEWARDSHIP VARCHAR2 If a set of User-Roles are developed for these records, this allows a particular Role (which may be a collection of other Roles) to be assigned to steward individual records. When any user attempts to modify a record, a database procedure will then dynamically examine the user's Role to determine if they are authorized to edit particular records.
100
PUB_YEAR_SUFFIX VARCHAR2 Used to provide additional information about the publication year if needed.
100
RECORD_JOURNAL_NOTE VARCHAR2 Short narrative describing the last change/edit made to this particular record. In a post-edit summary, this text is intended to describe what was done by the latest edit job.
100
RECORD_CHANGE_COMMENT VARCHAR2 Unlimited narrative describing the last change/edit made to this particular record. In a post-edit summary, this text is intended to describe what was done by the latest edit job.
100
SECONDARY_TITLE VARCHAR2 An additional title used by the reference.
100
VOLUME VARCHAR2 The volume of the journal where the reference is published.
100
PLACE_PUBLISHED VARCHAR2 The location where a publication was published.
100
PAGES VARCHAR2 The total number of pages included in the reference.
100
RECORD_HISTORY CLOB An accumulated set of statements describing how THIS RECORD has been edited over time including WHEN and by WHOM.

Attribute Details

REFERENCE_ID

CC ID: 324314
Data Storage Type: NUMBER
Max Length: 22
Required: No
Primary Key: No
Status: Active
Description:

A reference number originating from the MS-Access database version, used to identify a particulare reference document. This ID may not be consistent over time due to the nature of the data source.

General Data Type: NUMBER

REFERENCE_DOCUMENT_DB_ID

CC ID: 324315
Data Storage Type: NUMBER
Max Length: 22
Required: Yes
Primary Key: Yes
Status: Active
Description:

Database-generated primary key (unique identifier) for each REFERENCE_DOCUMENTS record, created by an internal sequence generator and used by the database to maintain referential integrity. This ID is not designed to be managed by users. This primary key constraint is named RD_PK.

General Data Type: NUMBER

DOCUMENT_TYPE

CC ID: 324316
Data Storage Type: NUMBER
Max Length: 22
Required: No
Primary Key: No
Status: Active
Description:

Foreign key to the REFERENCE_DOCUMENT_TYPES table to link REFERENCE_DOCUMENTS records to a specific REF_NO using the REFERENCEDOCUMENTTYPE_PK primary key. This foreign key constraint is named RDT_RD_FK.

General Data Type: NUMBER

TITLE

CC ID: 324317
Data Storage Type: VARCHAR2
Max Length: 400
Required: No
Primary Key: No
Status: Active
Description:

The recognized, given title for a piece of reference material.

General Data Type: VARCHAR2

AUTHOR

CC ID: 324318
Data Storage Type: VARCHAR2
Max Length: 400
Required: No
Primary Key: No
Status: Active
Description:

The name of the author of a piece of reference material.

General Data Type: VARCHAR2

PUBLICATION_YEAR

CC ID: 324319
Data Storage Type: NUMBER
Max Length: 22
Required: No
Primary Key: No
Status: Active
Description:

If the reference material is published, the four-digit year in which the reference material was published.

General Data Type: NUMBER

PUBLISHER

CC ID: 324320
Data Storage Type: VARCHAR2
Max Length: 200
Required: No
Primary Key: No
Status: Active
Description:

If the reference material is published, the name of the publisher of the reference material.

General Data Type: VARCHAR2

NOTES

CC ID: 324321
Data Storage Type: VARCHAR2
Max Length: 2000
Required: No
Primary Key: No
Status: Active
Description:

Any comments or other information about the reference material or its publication or use.

General Data Type: VARCHAR2

REFERENCE_TYPE

CC ID: 324322
Data Storage Type: VARCHAR2
Max Length: 50
Required: No
Primary Key: No
Status: Active
Description:

The classification of a reference document to its PRIMARY category. (If the reference document can be classified to more than one category, others are not accomodated here.) Acceptable values include: Age Reference, Catch Reference, Hatchery Reference, Spawner Reference, and Wild-Fraction Reference.

General Data Type: VARCHAR2

EXTERNAL_DOCUMENT_LINK

CC ID: 324323
Data Storage Type: VARCHAR2
Max Length: 300
Required: No
Primary Key: No
Status: Active
Description:

A web-link to any pertinent external document that relates to this reference document OR the link to the reference document itself.

General Data Type: VARCHAR2

RECORD_APPROVED_BY_PERSON

CC ID: 324324
Data Storage Type: VARCHAR2
Max Length: 40
Required: No
Primary Key: No
Status: Active
Description:

If there is a certification process for these records, name of person who certified approval of the particular record.

General Data Type: VARCHAR2

RECORD_APPROVED_ON_DATE

CC ID: 324325
Data Storage Type: DATE
Max Length: 7
Required: No
Primary Key: No
Status: Active
Description:

If there is a certification process for these records, date that the particular record was approved or officially certified.

General Data Type: DATE

RECORD_COMPUTER_LOAD_BY_USER

CC ID: 324326
Data Storage Type: VARCHAR2
Max Length: 40
Required: Yes
Primary Key: No
Status: Active
Description:

The username that loaded the record into the database. The username is dynamically captured by the database trigger when the record is inserted and saved to the database. This person may have no knowledge of content or meaning but ran the computer process that put the record into the database.

General Data Type: VARCHAR2

RECORD_COMPUTER_LOAD_ON_DATE

CC ID: 324327
Data Storage Type: TIMESTAMP(4)
Max Length: 11
Required: Yes
Primary Key: No
Status: Active
Description:

The date that the record was loaded into the database. This date is dynamically captured by the database trigger when the record is inserted and saved.

General Data Type: TIMESTAMP(4)

RECORD_CREATED_BY_PERSON

CC ID: 324328
Data Storage Type: VARCHAR2
Max Length: 40
Required: No
Primary Key: No
Status: Active
Description:

The name of the person who originated this record PRIOR to its being entered into the database. The name of the person to contact with administrative questions or an explanation of it content.

General Data Type: VARCHAR2

RECORD_CREATED_ON_DATE

CC ID: 324329
Data Storage Type: DATE
Max Length: 7
Required: No
Primary Key: No
Status: Active
Description:

The date, or approximate date, that the person with content knowledge originated this record PRIOR to its being entered into the database.

General Data Type: DATE

RECORD_EFFECTIVE_DATE

CC ID: 324330
Data Storage Type: DATE
Max Length: 7
Required: No
Primary Key: No
Status: Active
Description:

If necessary, the date that the individual record becomes effective. Prior to this date the record is not valid.

General Data Type: DATE

RECORD_EXPIRATION_DATE

CC ID: 324331
Data Storage Type: DATE
Max Length: 7
Required: No
Primary Key: No
Status: Active
Description:

If necessary, the date that the individual record ceases to be effective. To force a midnight expiration, this may be set by "Select to_date(to_char(sysdate +1 ,'mm/dd/yyyy')||' 23:59:59','mm/dd/yyyy hh24:mi:ss') from dual". After this date and time the record is not valid.

General Data Type: DATE

RECORD_LAST_EDITED_BY_USER

CC ID: 324332
Data Storage Type: VARCHAR2
Max Length: 40
Required: No
Primary Key: No
Status: Active
Description:

The username of the last person who modified this record. This username is dynamically captured by the database trigger any time the record is edited.

General Data Type: VARCHAR2

RECORD_LAST_EDITED_ON_DATE

CC ID: 324333
Data Storage Type: TIMESTAMP(4)
Max Length: 11
Required: No
Primary Key: No
Status: Active
Description:

The last date that the particular record was modified. This date is dynamically captured by the database trigger any time the record is edited.

General Data Type: TIMESTAMP(4)

RECORD_NUMBER_OF_EDITS

CC ID: 324334
Data Storage Type: NUMBER
Max Length: 22
Required: No
Primary Key: No
Status: Active
Description:

The number of times that the particular record was modified. This count is dynamically incremented by 1 by the database trigger each time the record is edited.

General Data Type: NUMBER

RECORD_SOFT_DELETED

CC ID: 324335
Data Storage Type: VARCHAR2
Max Length: 1
Required: No
Primary Key: No
Status: Active
Description:

Flag whether or not this record has the "Deleted" status. Null means this record has NOT been deleted. "Y" means this record HAS been deleted. This flag allows "deleted" records to remain in the table for technical reasons. When the record is "Hard Deleted" it will be removed from this table and may or may not be placed in a historical table to preserve historical status.

General Data Type: VARCHAR2

RECORD_STEWARDSHIP

CC ID: 324336
Data Storage Type: VARCHAR2
Max Length: 100
Required: No
Primary Key: No
Status: Active
Description:

If a set of User-Roles are developed for these records, this allows a particular Role (which may be a collection of other Roles) to be assigned to steward individual records. When any user attempts to modify a record, a database procedure will then dynamically examine the user's Role to determine if they are authorized to edit particular records.

General Data Type: VARCHAR2

PUB_YEAR_SUFFIX

CC ID: 324337
Data Storage Type: VARCHAR2
Max Length: 5
Required: No
Primary Key: No
Status: Active
Description:

Used to provide additional information about the publication year if needed.

General Data Type: VARCHAR2

RECORD_JOURNAL_NOTE

CC ID: 324338
Data Storage Type: VARCHAR2
Max Length: 4000
Required: No
Primary Key: No
Status: Active
Description:

Short narrative describing the last change/edit made to this particular record. In a post-edit summary, this text is intended to describe what was done by the latest edit job.

General Data Type: VARCHAR2

RECORD_CHANGE_COMMENT

CC ID: 324339
Data Storage Type: VARCHAR2
Max Length: 4000
Required: No
Primary Key: No
Status: Active
Description:

Unlimited narrative describing the last change/edit made to this particular record. In a post-edit summary, this text is intended to describe what was done by the latest edit job.

General Data Type: VARCHAR2

SECONDARY_TITLE

CC ID: 324340
Data Storage Type: VARCHAR2
Max Length: 255
Required: No
Primary Key: No
Status: Active
Description:

An additional title used by the reference.

General Data Type: VARCHAR2

VOLUME

CC ID: 324341
Data Storage Type: VARCHAR2
Max Length: 50
Required: No
Primary Key: No
Status: Active
Description:

The volume of the journal where the reference is published.

General Data Type: VARCHAR2

PLACE_PUBLISHED

CC ID: 324342
Data Storage Type: VARCHAR2
Max Length: 100
Required: No
Primary Key: No
Status: Active
Description:

The location where a publication was published.

General Data Type: VARCHAR2

PAGES

CC ID: 324343
Data Storage Type: VARCHAR2
Max Length: 40
Required: No
Primary Key: No
Status: Active
Description:

The total number of pages included in the reference.

General Data Type: VARCHAR2

RECORD_HISTORY

CC ID: 324344
Data Storage Type: CLOB
Max Length: 4000
Required: No
Primary Key: No
Status: Active
Description:

An accumulated set of statements describing how THIS RECORD has been edited over time including WHEN and by WHOM.

General Data Type: CLOB

Catalog Details

Catalog Item ID: 32699
GUID: gov.noaa.nmfs.inport:32699
Metadata Record Created By: Jeffrey W Cowen
Metadata Record Created: 2016-05-09 14:19+0000
Metadata Record Last Modified By: SysAdmin InPortAdmin
Metadata Record Last Modified: 2019-06-04 13:14+0000
Metadata Record Published: 2016-05-11
Owner Org: NWFSC
Metadata Publication Status: Published Externally
Do Not Publish?: N
Metadata Next Review Date: 2017-05-12