Tutorials and Examples
Learn how to use DOVU OS workflow engine with an overarching flow that can be applied to many of the workflows in built into the system.
Last updated
Learn how to use DOVU OS workflow engine with an overarching flow that can be applied to many of the workflows in built into the system.
Last updated
All workflows in DOVU OS follow a consistent structure based on data blocks and approval blocks, assigned to specific actors with defined roles in the system. This flow is linked to our DOVU standard process, providing a robust and repeatable approach.
While this example showcases a typical use case, the platform offers complete flexibility to adapt and create unique processes tailored to specific supply chain or workflow requirements in the future. For now, this serves as an excellent example to guide you through the key functionalities of the system.
To begin, register three users with roles: Registry, Supplier, and Verifier. These roles are critical in enabling different permissions and interactions with the workflow. Follow the registration routes previously detailed in the API reference.
Use the Workflow Index route to search for workflows available in the system. Here you will find two key workflows:
example_workflow (recommended to test): A generic example showcasing how to process data through a workflow without external integrations.
mmcm_elv_2024 (alpha): A specific example tied to end-of-life vehicles, this is connected to a guardian instance behind the scenes.
From this you may extract out the id value to use for publishing.
Once you’ve identified your workflow, publish it while logged in as a registry actor to create your own unique instance. This isolates your workflow and republishes the associated Guardian policy (if applicable), ensuring it is tied exclusively to your user account.
See: the workflow blueprint publish endpoint.
Next, you may scan for the individual instance of the workflow to understand its ongoing status, if it is connected to Guardian, integrations, it will be in an "Importing" state while underlying policies, are imported and published.
After a few minutes, the status of the workflow should update to "Ready", at this point, you can attach your verifier and supplier to the workflow itself so that they may process actions.
After the workflow instance has reached the Ready state, attach the previously registered users (supplier, verifier) to your workflow.
If you attempt to attach users to a workflow instance, before it is ready, you will receive a warning from the system.
"The workflow instance is currently not ready yet, this is usually related to the import and publishing of related Guardian policies."
With the workflow ready and users attached, start pushing data to the initial Data Block. Ensure the data aligns with the schema formats provided during workflow publishing. Proper schema compliance is necessary for successful data submission.
Switch to the Registry role to approve the submitted Data Block. This process will repeat across subsequent data and approval blocks as the workflow progresses.
After submitting the "claim" Data Block, the Verifier role is required to approve the final Approval Block. This step ensures compliance and verification of the entire workflow.
Upon successful verification:
The system generates credits in the background using Guardian.
Audit trails are created to track all actions and data points within the workflow.
Issued assets can be queried via the Credit Warehouse System, allowing for comprehensive reporting and tracking.
