Document event
An event that occurred on a document, a document fragment or a URL.
The document events are listed in the document history and represented with the <event> element.
Some document events relate to fragment also.
Event types
The following is a list of all document events.
| Type | Fragment | Description |
|---|---|---|
comment | Yes | When a comment is posted on a document or fragment |
creation | No | When a PSML document is created |
draft | Yes | When a draft is created on a fragment |
edit | Yes | When a fragment edit is saved |
image | Yes | An image has been inserted in an edit |
modification | No | When the document information (title, description, labels) has been modified |
move | No | When the document is moved to a new location |
note | Yes | When an edit note is attached to a fragment edit |
structure | No | When the structure of the document is modified, this can occur when fragments are moved or sections are created, deleted or moved within the document. Structural changes affecting sections can only occur during a document upload. |
revert | No | When a document is reverted to previous content |
task | Yes | When a task is created or updated on the document |
upload | No | When a document is updated using an upload or is received as an email attachment |
version | No | When a new version is created |
workflow | No | When the document workflow is updated, for example, if the status of the document changes or if the document is assigned. |
xref | Yes | When an xref pointing to another document or a link to a URL is created |
Notes
- If defined, the
creationevent is always the first event in the document history and there can only be one. - The
draftevent is removed when the author of the draft saves it as an edit. Theeditevent doesn’t replace thedraftevent – it is inserted in the history at the time of theeditwith a different ID. - When a discussion is turned into a task, the events prior to the change are shown as
comment, but subsequent events astask. - There is no event when an xref, link or image is removed, and the event when the xref, link or image is created remains.
- The
versionevent is removed if the version is deleted. - The
revertevent only applies when the whole document is reverted to previous content. When individual fragment edits are reverted, theeditevent is used.