Using the plugin
Once you have deployed the Documents Plugin in your infrastructure, you can start creating various document templates. After selecting a document template, proceed to create a process definition by including Kafka nodes and custom document-related actions in your process flow.
The plugin offers the following actions:
- Generating docs based on templates
- Uploading documents
- Converting documents
- Splitting documents
- Updating / deleting documents
- Getting URLs to documents
- Listing stored documents
- OCR integration
Before adding these actions to your process definition, follow these steps:
- Ensure that all custom information is properly configured in the plugin database, such as the document templates to be used.
- For each event type, you will need a corresponding Kafka topic.
The topic names configured for the plugin should match the ones used when configuring the engine. Make sure to use an outgoing topic name that matches the pattern configured in the Engine. The value can be found and overwritten in the KAFKA_TOPIC_PATTERN variable. For more details about Kafka topics configuration, click here.
To make a request to the plugin, the process definition needs to have an action of type Kafka send defined on a Message event send node. The action parameter should have the key topicName and the corresponding topic name as its value.
To receive a reply from the plugin, the process definition needs to include a Message event receive node with a node value having the key topicName and the topic name as its value.
Once the setup is complete, you can begin adding custom actions to your processes.
Let's explore a few examples that cover both the configuration and integration with the engine for all the use cases supported by the plugin:
»Generating docs based on templates»Uploading a new document»Converting documents to different formats»Splitting a document»Updating / deleting document files»Getting URLs to documents»Listing stored documents