The Audit Event workflow toolbox item allows you to log new audit events.
The system automatically logs a whole host of audit events. Phase changes, role changes, participant addition/removal, key date updates, and more. Sometimes, this isn't specific enough, or you want to add a bespoke audit record.
The Audit Event can be triggered anywhere in a workflow and logs the content to the audit record for a Work Item, Person, Event, or Team.
Prerequisites
The workflow must have an input parameter configured to identify a relevant Entity Type.
Configuration
| Entity Type: | Select the type of entity you wish to log the Audit Event against: Work Item, Person, Organisation, or Team. In the example shown, we will use Work Item. |
| Identifier: |
This field could be named a few things, depending on the Entity Type you have selected: Work Item, ODS Identity. In the example provided, we have set up an identifier which pulls in a Work Item Identifier we've labeled |
|
Audit type system name Title Description |
Then the following three fields are what you want to log on the Audit Record. For each of these fields, you can put whatever content you want. You can also insert a variable tag to use in the content. As you can see in this example, we've used the |
As a really basic example, we are firing the new Audit Event whenever a comment is logged on a given Work Item.
And this is the simple workflow:
The result is as follows: when a new comment is left on the Matter, the workflow is triggered, and a new audit event is logged.
Below, you can see screenshots of a comment being added and the logged audit event:
Because comment-saved is one of the standard audit events, you can see there are two records here:
- one logged when the comment is added by the system, logged with the User Identity of the person who made the change
- a separate audit record Workflow-Audit-Event created using the new Audit Event workflow block.
Best Practice
As the Audit Type System Name field from the workflow block corresponds to the ‘Event’ column in the audit view (as seen above), we recommend creating these consistently, i.e. whenever the system logs a comment-saved event, they always have the same name.
Because it is now possible to create your own events, keep this in mind when using this block.