Skip to main content

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:

  1. Login to your Rossum account.
  2. Navigate to Extensions → My extensions.
  3. Click on Create extension.
  4. Fill the following fields:
    1. Name: Custom format templating purge
    2. Trigger events: Export and document status Changed (!)
    3. Extension type: Webhook
    4. URL (see below)
  5. In "Advanced settings" select Token owner (should have Admin access)
  6. In the "Additional notification metadata" enable Schemas
  7. Click Create the webhook.

Webhook URL endpoints

EnvironmentWebhook URL
EU1 Irelandhttps://elis.custom-format-templating-purge.rossum-ext.app/
EU2 Frankfurthttps://shared-eu2.custom-format-templating-purge.rossum-ext.app/
US east coasthttps://us.custom-format-templating-purge.rossum-ext.app/
Japan Tokyohttps://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.