Advanced Settings of Extensions in Rossum
When creating a new extension in Rossum, function or webhook, you may want the extension to perform more advanced behavior that might need extra setup. Such advanced setup might need access to:
- Metadata of extra objects such as username, name of the queue, etc.
- Access to the Rossum's API - when you need to update some object over the API
- Passing extra configuration to the Rossum extension
See the image below in order to find out what advanced settings can be set for an extension.
Passing extra metadata information to the extension
You might want to pass more information to the webhook / custom functions notifications. Such metadata could include:
- Username of the user who updated the annotation
- Taking the fields name from the Extraction schema when analyzing the user updates online in your custom extension.
- Queue name on which the document was updated
Such extra metadata can be enabled on the extension detail in the Rossum's UI.
Enabling access to the Rossum's API from the extension
In some cases you might want to access the Rossum's API from the custom extension. Such cases might include:
- Setting metadata of the annotation over the API
- Accessing the Data matching database over the API
- Getting the annotation content over the API, e.g. after you get notification about the status change of a specific annotation.
In each of the scenarios above, you need to access the Rossum's API from the extension. However, you do not want to hardcode your username and password into the extension code. A better practice is to tell Rossum to pass the authentication token as part of the notification payload. Afterwards, you can reuse the token for accessing the Rossum's API.
Passing extra configuration to the extension
In most cases you would like to maintain one webhook or custom function code for all your customers. However, usually such customers need to have slightly different configuration of the business logic. Therefore, we have enabled passing of extra configuration to the extension.
Updated almost 2 years ago