Documents plugin
Deleting files
The Documents plugin provides functionality for deleting files.
Prerequisites
Before deleting files, ensure:
-
Access Permissions: Ensure that the user account used has the necessary access rights for updates or deletions.
-
Kafka Configuration:
- Verify Kafka Setup: Ensure proper configuration and accessibility of the Kafka messaging system.
- Kafka Topics: Understand the Kafka topics used for these operations.
- File IDs and Document Types: Prepare information for updating or deleting files:
fileId
: ID of the file to delete.customId
: Custom ID associated with the file.
In the example below, we use a fileId
generated for a document using Uploading a New Document scenario.
Configuring the deletion process
To delete files, follow these steps:
- Create a process that includes a Send Message Task (Kafka) node and Message Event Receive (Kafka) node:
- Use the Send Message Task node to send the delete request.
- Use the Receive Message Task node to receive the delete reply.
- Configure the first node (Send Message Task) by adding a Kafka Send Action.
- Specify the Kafka topic for sending the delete request.
To identify defined topics in your environment:
- Navigate to Platform Status > FLOWX Components > document-plugin-mngt and click the eye icon on the right side.
- In the details screen, expand the
KafkaTopicsHealthCheckIndicator
line and then details → configuration → topic → file → delete. Here will find the in and out topics for deleting files.
- Fill in the request message body.
Message request example
Example of a message following the custom integration data model:
- fileId: The ID of the file.
- customId: The custom ID.
- Configure the second node (Receive Message Task) by adding a Data stream topic:
The response will be sent to ..out
Kafka topic.
Receiving the reply
The reply body should contain the following values:
- customId: The unique identifier for your document (it could be for example the ID of a client)
- fileId: The ID of the file
- documentType: The document type
- error: Any error message in case of an error during the deleting process
Message response example
Was this page helpful?