S1. Document Events Overview

---

XDOC can be configured to publish Document related events to an external system. There are currently two types of Document events:

1. Document Add Events
   • Occurs during normal File Workflow processing when new files and documents are added to the system.
   • Events are placed on the workflow queue file event publish, and delivered to the external application.
     
     
2. Document Update Events
   • Occurs when documents are edited via the Document Viewer.
   • Events are placed on the workflow queue doc event publish, and delivered to the external application.
   • Includes document deletes (or moves to another container), and update of document fields or document types.
   • For a notification to be generated on document field changes, Trigger Notifiy must be set to 'yes' for the field within the Document Schema Editor page in the UI. (Found under Admin > 'Projects' Tab > Document Definitions > double-click a listed document type to open the editor window)

Document Event Delivery Delivery of Document Events is accomplished by sending related Document Information in XML format to an HTTP Simple URL Service endpoint:

• The XML corresponds to XSD Schema Notfication.ContainerDocument.xsd, which can be found along with sample XML under the XDOC directory /doc/api/httpServices/Schemas/
• The XML is written directly to the Request Input Stream of the Service URL Endpoint, using an HTTP post, with a content type of text/xml
• The Service Endpoint must return an OK http status code (200) for the entry to be removed from the XDOC Workflow queue.
• The Service Endpoint should handle logging any errors it may encounter during its processing logic.
• •