Document Object
Revision as of 16:00, 18 February 2022 by Drn@ecs.soton.ac.uk (talk | contribs)
EPrints 3 Reference: Directory Structure - Metadata Fields - Repository Configuration - XML Config Files - XML Export Format - EPrints data structure - Core API - Data Objects
Data Objects: Access - Document - EPrint - Event Queue - File - History - Import - Login Ticket - Request - Saved Search - Subject - User
Built in Fields
Field Name | Type | Description |
---|---|---|
docid | int field | The ID number of this Document Object (unique within a single repository) |
rev_number | int field | The metadata revision number. Increased by 1 every time this record is modified. |
files | multiple file field | File Objects associated with the Document Object |
eprintid | eprint itemref field | EPrint Object of the Document Object |
pos | int field | Position of the Document Object within the EPrint Object (used in URLs) |
placement | int field | Placement of the Document Object within the EPrint Object (used in the workflow/citation ordering) |
mime_type | id field | MIME type of the primary file of the Document Object. |
format | namedset field document | Generalised format of the document. |
formatdesc | text field | Description of the format of the document . |
language | namedset field languages | Language of the document. |
security | namedset field security | Security for accessing the document. |
license | namedset field licenses | Licence for the document. |
main | set field | The filename of the document |
date_embargo | date field | The date the document is emabargoed until. |
date_embargo_retained | date field | Retained version of the embargo date for once it is lifted. |
embargo_reason | namedset field embargo_reason | The reason the. document was embargoed |
content | namedset | The version (e.g. draft, submitted, published, etc.) of the document. |
Related configuration files
- doc_rewrite.pl
- document_fields_automatic.pl
- document_fields_default.pl
- document_upload.pl
- document_validate.pl
- media_info.pl
- security.pl
- Archives/ARCHIVEID/cfg/namedsets/content
- Archives/ARCHIVEID/cfg/namedsets/document
- Archives/ARCHIVEID/cfg/namedsets/embargo_reason
- Archives/ARCHIVEID/cfg/namedsets/security
- Archives/ARCHIVEID/cfg/namedsets/licenses
See Also
- EPrints::DataObj::Dcocument - API page