Custom format templating purge
Extensions like Custom format templating and REST API export (and possibly others) store their API responses and artefacts in the annotation metadata. When re-exporting, we need to remove these old documents and responses to ensure a clean start. The purge extension helps us achieve this.
Additionally, this extension takes care of a cleanup when purging the original documents from Rossum (by default, all generated artifacts would stay in the system orphaned). Deleting such orphaned artifacts might be very important for compliance reasons.
Installation
"Custom format templating purge" extension is provided and maintained by Rossum.ai in the form of webhook. To start using it, follow these steps:
- Login to your Rossum account.
- Navigate to Extensions → My extensions.
- Click on Create extension.
- Fill the following fields:
- Name:
Custom format templating purge
- Trigger events:
Export
and document statusChanged
(!) - Extension type:
Webhook
- URL (see below)
- Name:
- In "Advanced settings" select Token owner (should have Admin access)
- In the "Additional notification metadata" enable
Schemas
- Click Create the webhook.
Webhook URL endpoints
Environment | Webhook URL |
---|---|
EU1 Ireland | https://elis.custom-format-templating-purge.rossum-ext.app/ |
EU2 Frankfurt | https://shared-eu2.custom-format-templating-purge.rossum-ext.app/ |
US east coast | https://us.custom-format-templating-purge.rossum-ext.app/ |
Japan Tokyo | https://shared-jp.custom-format-templating-purge.rossum-ext.app/ |
Basic usage
No additional configuration is required. This extension should be run first in the extension chain.