Document Object: Difference between revisions

Revision as of 15:59, 18 February 2022

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

The version (e.g. draft, submitted, published, etc.) of the document.

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

@@ Line 38: / Line 38: @@
 * [[Archives/ARCHIVEID/cfg/namedsets/]]security
 * [[Archives/ARCHIVEID/cfg/namedsets/]]licenses
+== See Also ==
+* [[API:EPrints/DataObj/Document|EPrints::DataObj::Dcocument]] - API page