Event properties
There is a collection of standard properties that apply to all events:
| Property | Mandatory Y/N | Description |
|---|---|---|
| processType | Y | Represents the type of event (e.g.,create.document, submit.document, etc.) |
| eventType | Y | Represents the level of the event (e.g., Error, Informational, Warning, Debug) |
| userId | Y | User ID related to the event raised |
| externalSource | Y | Application that originated the event (e.g., EngageOne) |
| externalId | N | Application-defined identifier to the external entity in the application table |
| startTimestamp | Y | Start timestamp of the event |
| endTimestamp | Y | End timestamp of the event |
| comments | N | Optional comments |
| workflowName | N | Optional workflow name |
| workflowEventName | N | Optional workflow step name |
| message | N | Optional message |
| exception.name | N | Optional exception name (only used when eventType is an error event) |
| exception.message | N | Optional exception message (only used when eventType is an error event) |
| exception.stack | N | Optional exception stack trace (only used when eventType is an error event) |
In addition, all EngageOne events contain the following mandatory property:
| Property | Description |
|---|---|
| domain.name | EngageOne domain name |
Finally, each specific type of event has its own set of properties, which are all mandatory.
| Process type | Property | Description |
|---|---|---|
| *.document | document.name | Name of the document |
| document.id | Internal identifier of the document (system generated) | |
| template.name | Name of the template | |
| template.id | Internal identifier of the template (system generated) | |
| *.template | template.name | Name of the template |
| template.id | Internal identifier of the template (system generated) | |
| *.keymap.image | keymap.image.name | Name of the keymap image |
| keymap.image.id | Internal identifier of the keymap image (system generated) | |
| *.document.class | doc.class.name | Name of the document class |
| doc.class.id | Internal identifier of the document class (system generated) | |
| *.keymap | keymap.name | Name of the keymap |
| keymap.id | Internal identifier of the keymap (system generated) | |
| *.active.content | active.content.name | Name of the Active Content |
| active.content.id | Internal identifier of the Active Content (system generated) | |
| *.resource.access.rights | ||
| *.resource.delivery.options | ||
| *.batch | batch.id | Internal identifier of a batch run (system generated) |
| purge.batch | documents.purged | Number of documents purged |
| documents.not.purged | Number of documents not purged | |
| restart.batch | documents.delivered | Number of documents delivered |
| documents.not.delivered | Number of documents not delivered | |
| resume.batch | documents.delivered | Number of documents delivered |
| documents.not.delivered | Number of documents not delivered | |
| *.channel | channel.name | Name of the delivery channel |
| channel.id | Internal identifier of the delivery channel (system generated) | |
| purge.channel | documents.purged | Number of documents purged |
| documents.not.purged | Number of documents not purged | |
| run.channel | batch.id | Internal identifier of a batch run (system generated) |
| documents.delivered | Number of documents delivered | |
| documents.not.delivered | Number of documents not delivered | |
| purge.status | batch.id | Internal identifier of a batch run (system generated) |
| status | Purge status | |
| documents.purged | Number of documents purged | |
| documents.not.purged | Number of documents not purged | |
| select.delivery.option | document.name | Name of document |
| documents.id | Internal identifier of the document (system generated) | |
| template.name | Name of the template | |
| template.id | Internal identifier of the template (system generated) | |
| delivery.option.id | Internal identifier of the delivery option (system generated) | |
| *.workflow | workflow.name | Name of the workflow |
| delete.template.retention, move.template.retention | retention.ruleID | an ID for the policy |
| retention.rule.desc | The description of the policy | |
| retention.fileCount | The number of files either moved or deleted | |
| retention.template.path | The path of the template to be moved or deleted | |
| smtp.to | The e-mail address 'to' | |
| smtp.from | The e-mail address 'from' | |
| template.name | The template name | |
| template.id | The template ID | |
| template.version | The version of the template | |
| effective.date | The date that the retention policy took effect | |
| retention.template.src.path | The src path before a move policy event | |
| Retention.template.dest.path | The dest path after a move policy event |
In the example configuration file that follows, note the class
sink, which allows you to define custom sinks.
Also note, email
admin, which is set up to send all errors.
<?xml version="1.0" encoding="utf-8"?>
<sinks>
<!-- Setup a database sync to send all CreateDocument and SaveDocument process types OR -->
<!-- all warnings and errors to the event monitor database. -->
<sink name="database">
<config type="database"/>
<filters>
<filter>
<property name="processType" include="CreateDocument,SaveDocument"/>
</filter>
<filter>
<property name="eventType" exclude="Error"/>
</filter>
</filters>
</sink>
<!-- Setup an SMTP sync to send all errors to admin@whoever.com -->
<sink name="email admin">
<config type="smtp">
<property name="host">161.228.123.180</property>
<property name="port">26</property>
<property name="to">admin@whoever.com</property>
<property name="from">engageone@whoever.com</property>
<property name="subject">Fatal error</property>
</config>
<filters>
<filter>
<property name="eventType" include="Error"/>
</filter>
</filters>
</sink>
<!-- Setup an SMTP sync to send all template imports to docmgrs@whoever.com -->
<sink name="email document managers">
<config type="smtp">
<property name="host">161.228.123.180</property>
<property name="port">26</property>
<property name="to">docmgrs@whoever.com</property>
<property name="from">engageone@whoever.com</property>
<property name="subject"> A template has been imported </property>
</config>
<filters>
<filter>
<property name="processType" include="ImportTemplate"/>
</filter>
</filters>
</sink>
<!-- Setup a log sync to send all warnings and errors to the log file. -->
<sink name="log">
<config type="log"/>
<filters>
<filter>
<property name="eventType" include="Warning,Error"/>
</filter>
</filters>
</sink>
<!-- Setup a class sync to send all warnings and errors to the log file. -->
<sink name="my event sink">
<config type="class">
<property name="className>com.whoever.engageone.event.MyEventSink"</property>
<property name="classpath>d:/blah/mylib/mysink.jar"</property>
</config>
<filters>
<filter>
<property name="processType" include="CreateDocument,SaveDocument"/>
</filter>
</filters>
</sink>
</sinks>