Difference between revisions of "EPrint Object"

From EPrints Documentation
Jump to: navigation, search
(language setting information updated, file explanation added)
Line 5: Line 5:
It belongs to the "eprint" dataset.
It belongs to the "eprint" dataset.
In the API it is represented as an instace of EPrints::DataObj::EPrint
In the API it is represented as an instance of EPrints::DataObj::EPrint.
== Metadata Fields ==
== Metadata Fields ==
Line 34: Line 34:
== Related configuration files ==
== Related configuration files ==
* '''[[eprint_fields.pl]]''' -
* [[archives/ARCHIVEID/cfg/cfg.d/]] - repository-specific settings (initially copied from lib/defaultcfg/cfg.d) overriding/extending lib/cfg.d/
* '''[[eprint_fields_automatic.pl]]''' -
** '''[[eprint_fields.pl]]''' - object definitions influencing database definition
* '''[[eprint_fields_default.pl]]''' -
** '''[[eprint_fields_automatic.pl]]''' - defines automatic object setting
* '''[[eprint_render.pl]]''' -
** '''[[eprint_fields_default.pl]]''' - defines initial object setting
* '''[[eprint_validate.pl]]''' -
** '''[[eprint_render.pl]]''' - defines object rendering
* '''[[eprint_warnings.pl]]''' -
** '''[[eprint_validate.pl]]''' - defines object validation
* [[Archives/ARCHIVEID/cfg/workflows/eprint/]]
** '''[[eprint_warnings.pl]]''' - defines object checks to warn user
** default.xml
* [[archives/ARCHIVEID/cfg/workflows/eprint/]]
* [[Archives/ARCHIVEID/cfg/namedsets/]]
** '''[[default.xml]]''' - defines workflow
** eprint
* [[archives/ARCHIVEID/cfg/namedsets/]]
* [[Archives/ARCHIVEID/cfg/lang/en/phrases/]]
** '''eprint''' - sets known eprint types
** eprint_fields.xml - names, help text and names for options (in set fields) of fields in the EPrint Object.
* [[archives/ARCHIVEID/cfg/lang/en/phrases/]] - extends/overrides lib/lang/en/phrases/*.xml
** eprint_order.xml - human readable rendering of the allowed orderings of search results for eprint searches.
** '''*.xml''' - defines language-specific names, help text and so on of the '''EPrint Object'''; all definition files are read in alphabetic order and override each other (survival of the last one ...!)
** eprint_types.xml - name and description of each of the eprint types.
See also [[Document Object]] configuration files.
See also [[Document Object]] configuration files.

Revision as of 16:21, 19 November 2015

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

Data Object representing a single EPrint record.

It belongs to the "eprint" dataset.

In the API it is represented as an instance of EPrints::DataObj::EPrint.

Metadata Fields

Field NameTypeDescription
eprintidint fieldThe ID number of this EPrint Object (unique within a single repository)
rev_numberint fieldThe metadata revision number. Increased by 1 every time this record is modified.
documentsmultiple subobject fieldzero or more Document Objects attached to this EPrint. In effect these are sub-objects.
eprint_statusset fieldthe status of this eprint.
useriditemref fieldthe userid of the User Object which first created this item. This is the user that can see the eprint in their userarea.
dirtext fieldthe path that the documents for this eprint are stored, relative to Archives/ARCHIVEID/documents/
datestamptime fieldthe time the eprint first appeared in the live archive. Is only ever set once.
lastmodtime fieldthe time this eprint was last modified
status_changedtime fieldthe time the eprint_status field was last modified (ie. when it was last moved between datasets)
typenamedset field eprintthe type of this eprint (eg. article, etc).
succeedsitemref fieldif this eprint is a new version (not revision) of an existing eprint record, this is the id of the record it replaces.
commentaryitemref fieldif this eprint is a commentary on an existing eprint record this is the id of the record it comments upon.
replacedbyitemref fieldif this eprint has a newer version then this is the id of the newer version (opposite of "succeeds")
metadata_visibilityset fieldif set to no_search then this record does not appear in search results. Used for older versions of a thing where all versions must exist but it's only useful to discover the newest one.
contact_emailemail fieldan email address for correspondance about this eprint. Used to request documents which are not online, or not public.
fileinfolongtext fieldused to cache the icon urls and links for the documents, so they can be easily used in citations.
latitudefloat field
longitudefloat fieldthese store the position on earth which this eprint relates to, if any. This could be where it was presented, where the author lives, or the location may be the subject of the eprint such as a city or an archaelogical dig. The exact use depends on the repository.
****Repository-specific fields for the EPrint Object are defined in eprint_fields.pl - these are in addition to the fields listed here, which are always in EPrints for any repository.

Related configuration files

See also Document Object configuration files.