Event Queue Object
Revision as of 10:51, 18 February 2022 by Drn@ecs.soton.ac.uk (talk | contribs) (Added event queue object)
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 |
---|---|---|
eventqueueid | uuid field | Either a UUID or a hash of the event (if created with create_unique method). |
cleanup | boolean field | If set to true removes this event once it has finished. Defaults to true |
priority | int field | The priority for this event. |
start_time | timestamp field | The event should not be executed before this time. |
end_time | time field | The event was last touched at this time. |
status | set field eprint | The status of the event. Can be one of waiting, inprogress, success or failed. |
userid | itemref field | The user (if any) that was responsible for creating this event. |
description | longtext field | A human-readable description of this event (or error). |
pluginid | id field | The EPrints::Plugin::Event plugin id to call to execute this event. |
action | id field | The name of the action to execute on the plugin (i.e. method name). |
params | storable field | Parameters to pass to the action (a text serialisation). |