# Welcome to DOVU OS In a world where businesses and organizations face mounting challenges in creating efficient workflows, validating new markets, and embracing sustainable practices, **DOVU OS** is designed to provide a practical solution. Built as a modular, adaptable operating system, DOVU OS empowers users to streamline complex processes, reduce costs, and unlock opportunities for growth and innovation. This documentation serves as your guide to understanding and leveraging the tools, methodologies, and systems that form the core of DOVU OS. Whether you're navigating sustainability projects, managing supply chains, or exploring the tokenization of real-world assets, DOVU OS offers a unified platform to tackle these challenges head-on. *** ## Explore the System This guide is structured to give you a clear understanding of DOVU OS and its components. Each section offers insights into how our platform addresses real-world problems while enabling enterprise-ready solutions. *** ### **DOVU Operating System**
The ProblemGain insight into the critical issues businesses face today and how DOVU is solving for tomorrow./pages/BwOmLnoXcscy53uK2VuW
What is DOVU OS?Discover how DOVU OS combines modular tools with flexible workflows to meet a range of needs./pages/CyH2xJQs9yWJ1S8BYNav
Core ConceptsUnderstand the foundational principles driving the design and functionality of DOVU OS./pages/A3ySZmvDec4GNXTMO3U9
Charger ProtocolExplore our key vision for using DOVU tokens to power the operating system./pages/ADTQMqSWiQOfDYF8210f
Beyond SustainabilitySee how DOVU OS extends its value beyond sustainability to power enterprises in diverse industries./pages/4JXQL2RBKpcxZadJuD3n
*** ### **Workflow Engine**
The EngineDelve into the architecture that drives seamless workflow management for projects and processes./pages/7aUFmnCMx9m4smGncsXL
What to Expect NextUnderstand how to proceed working with DOVU OS during the developer preview./pages/L9tNFkjtwQrSPnQt6zXi
API ReferenceAccess detailed API documentation to integrate your workflows and systems effortlessly./pages/cEHgDv7NGBquDGHeLyQ4
Tutorials and ExamplesTry the DOVU OS developer preview yourself by following the tutorial./pages/o0yb8MupFvj1TMbg8s7S
*** ### **Template Language**
RationaleLearn why we built the DOVU template language and how it simplifies complex workflows./pages/021YXGVqBQfo2YhgqGmy
At a GlanceA concise overview of its capabilities and benefits./pages/ilKOwaF06wo5ON0ocKxB
Use Case: ELV RecyclingSee the language in action with a real-world sustainability example./pages/S2Oem8wrV9OH4ao4ZbDx
Language PrimitivesDive into the technical details that underpin the flexibility of the template language./pages/lMN7MBDIOtG390n1rxDW
*** ### **DOVU Guardian Tools**
Guardian Deployment SystemDOVU's proprietary deployment system for our guardian networks, allow an isolated deployments in less than 30 minutes./pages/q8kSBmMbZ3ogqjEzcItt
Guardian PHP SDKExplore V3 of our Guardian SDK for integration into your PHP and Laravel projects./pages/LwQpxvyM2aPcosNfg94a
*** ## **Where to Begin** Explore the sections that resonate with your needs. Whether you're a developer looking to integrate with existing systems, a business exploring new digital markets, or an organization seeking scalable sustainability solutions, DOVU OS provides the tools to get you there. # The Problem The modern world is a patchwork of disconnected systems, this needs to be fixed. The modern world is a patchwork of disconnected systems. From sustainability projects to supply chains, real-world assets to digital infrastructures, inefficiencies and silos hinder progress. These disconnected systems make it nearly impossible to validate emerging markets, create transparent workflows, or build scalable, future-proof solutions. Businesses and sustainability projects alike need a solution that doesn't just solve today's inefficiencies but also sets the stage for a more interconnected future. Without a unifying layer, the costs of managing disparate processes and platforms are overwhelming, and opportunities for innovation are missed. ## The Solution: DOVU OS **DOVU OS is the unifying layer the modern world needs—an overarching operating system designed to connect disparate systems with ease and flexibility.** Its primary purpose is to create interoperability across fragmented platforms, enabling businesses, sustainability initiatives, and enterprises to work seamlessly together. * **For today:** DOVU OS simplifies workflows and reduces the barriers to entry for sustainability and enterprise solutions. * **For tomorrow:** It lays the groundwork for connecting traditionally siloed systems, bridging the gaps between digital and physical assets, public and private ecosystems, and local and global markets. By focusing on **interoperability as its core purpose**, DOVU OS empowers enterprises to align their operations with broader sustainability goals while remaining adaptable to future technological and market developments. This makes it not just a solution for current challenges but a cornerstone for the next generation of interconnected ecosystems. *** ## Powered by the DOVU Token With every transaction fixed in **USD**, **DOVU OS** ensures predictability and stability across its ecosystem. This fixed pricing model enables **downstream service providers** to accurately assess and plan the cost of delivering value, removing uncertainty and fostering trust within the network. By combining this transparency with the microtransaction capabilities of the **DOVU token**, businesses and individuals alike can effortlessly access and deliver services, making participation in the ecosystem both **accessible** and **economically efficient**. This structure is designed to streamline workflows and incentivize participation, empowering a truly global and inclusive Web3 economy. ### The Goal **DOVU OS** is not just a framework—it's the foundation for delivering measurable and real-world value through the **DOVU token**. Our approach ensures that every interaction and transaction powered by the DOVU token is tied to a system that is already proven, functional, and valuable. This is not about overpromising or delivering vaporware; it’s about creating infrastructure that genuinely works, unlocking the token's potential after the system demonstrates real, tangible results. By anchoring the **DOVU token** to a fully operational and tested ecosystem, we provide developers, enterprises, and end-users the confidence they need to build, transact, and innovate. Once our system is proven, the token becomes the catalyst for enabling value creation, seamless microtransactions, and scalable adoption in the real world. Read more on how the DOVU token will be used in the system through the link below. {% content-ref url="/pages/ADTQMqSWiQOfDYF8210f" %} [Charger Protocol](/dovu-operating-system/charger-protocol) {% endcontent-ref %} # What is DOVU OS? The DOVU Operating System is a modular platform empowering developers and enterprises to seamlessly create, manage, and tokenize real-world assets and environmental credits. ## What is DOVU OS? **DOVU OS** is a modular, developer-focused platform designed to simplify the creation, management, and issuance of real-world assets (RWAs) and environmental credits. It is the culmination of years of research and development, with the goal of bridging the gap between complex decentralized systems and user-friendly workflows. ### **Why DOVU OS?** Traditional systems for managing ecological credits are fragmented, inefficient, and lack scalability. DOVU OS is designed to overcome these challenges by providing: * **Demand-Driven Credit Creation**: Align credit supply with market needs by integrating demand-side signals directly into the workflow, bridging the gap between what is needed and what is created. * **Agnostic Workflow Engine**: Simplify interactions between schemas, registries, and decentralized identity (DID) systems, making complex processes accessible and efficient. * **End-to-End Ecosystem Support**: Cover the full lifecycle, from data onboarding to credit issuance, trading, and retirement, ensuring a seamless and scalable ecosystem. * **Open and Modular Design**: Enable developers to build, test, and deploy workflows with pre-defined templates and flexible configurations, fostering rapid innovation and adaptability. DOVU OS empowers enterprises and developers to create impactful solutions that align with sustainability goals, optimize processes, and drive transparency in emerging markets. ### **Core Features of DOVU OS** 1. **Developer Preview API**: A robust testnet environment to explore API calls for creating workflows, managing actors, and minting credits. 2. **Rapid Guardian Deployments**: Deploy isolated infrastructure in under 30 minutes, ensuring secure and compliant credit issuance for clients. 3. **Guardian PHP SDK**: Simplify interactions with Hedera Guardian through an intuitive, developer-friendly SDK. 4. **Templating Language**: Reduce complexity with reusable templates that abstract the intricacies of third-party integrations. ### **DOVU’s Vision** Our mission is to create a platform that empowers developers, enterprises, and project owners to tokenize and manage assets with trust and transparency. By offering a developer-first approach, DOVU OS makes it possible to build and innovate within nascent markets like sustainability, supply chains, and more. # Core Concepts DOVU OS is built on modular components designed to simplify the creation, management, and issuance of environmental credits and real-world assets. DOVU OS is built on foundational components that simplify the creation, management, and issuance of environmental credits and real-world assets. This page introduces the core concepts, giving developers a clear understanding of the building blocks that make DOVU OS unique and powerful. *** ### **1. Interoperable Workflow Engine** At the heart of DOVU OS is the **interoperable workflow engine**, designed to simplify and automate complex processes. * **What it does**: Connects data, schemas, decentralized identity (DID) systems, and third-party system integrations to build workflows for credit creation, validation, and issuance. * **Why it matters**: Provides flexibility for developers to create custom workflows, enabling support for a wide range of use cases, from ecological credits to supply chain validation. *** ### **2. Demand-Side Signal Integration** Bridging the gap between market demand and credit supply is a core principle of DOVU OS. * **What it does**: Allows enterprises to communicate specific needs—like credit volume, type, or data attributes—and connects them with relevant supply-side actors. * **Why it matters**: Ensures that credit creation aligns with market needs, improving efficiency and enabling tailored solutions for Scope 3 emissions and beyond. *** ### **3. Hedera Guardian Integration** DOVU OS leverages the **Hedera Guardian**, a decentralized policy and identity framework. * **What it does**: Manages roles, permissions, and compliance workflows while ensuring all credits meet verifiable standards. * **Why it matters**: Guarantees trust and transparency across the credit lifecycle, enabling cryptographic proof of every interaction. *** ### **4. Rapid Guardian Deployment** Deploying Guardian infrastructure securely and efficiently is key to DOVU OS’s enterprise readiness. * **What it does**: Enables fully isolated deployments in under 30 minutes, ensuring client data and workflows remain secure. * **Why it matters**: Reduces setup time, minimizes operational complexity, and provides a significant edge over traditional systems. *** ### **5. Templating Language** The **DOVU OS templating language** simplifies the complexity of building workflows and integrating third-party systems. * **What it does**: Provides reusable templates that abstract the details of policy definitions, workflow structures, and integrations. * **Why it matters**: Reduces developer effort, ensures consistency, and accelerates the deployment of new workflows. *** ### **6. Testnet Environment** Experimentation is at the core of the DOVU OS Developer Preview. * **What it does**: Offers a hosted testnet environment for developers to create workflows, test API calls, and issue testnet credits. * **Why it matters**: Allows developers to prototype and validate real-world use cases without risk or additional setup. *** ### **Why These Concepts Matter** Together, these components form the backbone of DOVU OS, making it a comprehensive platform for developers and enterprises looking to tokenize real-world assets, align credits with demand signals, and drive innovation in emerging markets. Whether you’re onboarding new workflows, scaling your operations, or connecting to demand-side markets, DOVU OS provides the tools you need to succeed. *** ## Get Started Now you should have a basic understanding of DOVU OS, feel free to get started exploring the API below. {% content-ref url="/pages/egwCdJLeYZSB2nwzGVPw" %} [The Engine](/workflow-engine/the-engine) {% endcontent-ref %} # Charger Protocol The future vision of using the DOVU token as the core The Charger Protocol serves as the foundation for connecting the DOVU token to the DOVU OS ecosystem, enabling seamless, scalable, and predictable payment mechanisms. Designed with a long-term vision, the protocol provides the infrastructure for both fiat-based and token-based fee systems, ensuring flexibility during its early adoption phase while laying the groundwork for real-time micro-payments in DOVU. *** ## **Developer Preview and Initial Launch** For the developer preview phase, fees will primarily be collected in fiat currencies. This ensures simplicity and accessibility for enterprise clients while the DOVU OS ecosystem gains adoption and proves its value. Fiat fees provide a predictable and familiar structure, allowing businesses to onboard without the complexity of token management during the early stages. *** ## **Transition to DOVU Token Fees** As the ecosystem matures, the Charger Protocol will evolve to introduce real-time micro-payments using DOVU tokens, planned for H2 2025, inspired from [Hedera Hashgraph's fee structure.](https://hedera.com/fees) This transition will enable: * **Real-Time Transactions:** Leveraging an allowance mechanism, users will be able to execute micro-payments seamlessly within workflows, with fees calculated in USD and settled in DOVU tokens. * **Scalable Fee Structures:** The initial focus will remain on credit minting fees, starting at **$0.125 per credit,** while future updates will expand fee structures to include broader DOVU OS, workflow, and AI operations. * **Developer Empowerment:** Developers will gain full control of how they integrate and utilize the token, creating new opportunities for tokenized services and applications. *** ## **A Long-Term Vision** The phased approach ensures that businesses can adopt DOVU OS without barriers while setting the stage for a fully tokenized system. By introducing fiat-based fees first and token-based real-time fees later, DOVU ensures an efficient transition for enterprises, empowering them to leverage blockchain-backed infrastructure without operational disruptions. The Charger Protocol exemplifies DOVU’s commitment to combining accessibility with innovation, making Web3 infrastructure practical, scalable, and ready for real-world enterprise use. *** ## Try out the Charger Protocol Demo Explore the Charger Protocol through our interactive demo. This allows you to see how key features, such as allowance approvals and workflow interactions, function seamlessly within the DOVU OS ecosystem. The demo provides a simple and practical way to understand how real-time token usage and fee structures integrate into your workflows.
[**Try the charger protocol**](https://charger.staging.dovu.earth/)**.** # Beyond Sustainability Looking forward beyond sustainability, the power of DOVU OS. > "At **DOVU**, we’ve built the foundation businesses need: a seamless system that bridges market validation, digitization, and tokenization of processes and assets. This system connects supply and demand across emerging digital markets, empowering enterprises to scale smarter, reduce inefficiencies, and unlock transformative outcomes. This is the future of sustainable and scalable operations, and we couldn’t be more excited to share it with the world." > > Matt Smithies - CTO DOVU ## **The Challenge Businesses Face** Market validation and capital deployment are among the most complex challenges businesses encounter. Without visibility into demand, many investments fail to achieve their full potential. DOVU solves this with an end-to-end infrastructure that captures market signals, validates demand, and empowers businesses to act confidently. ## Simplifying Global Standards Adoption DOVU OS integrates standards and schemas from initiatives like the **InterWork Alliance (IWA)** and the **Global Standards Mapping Initiative (GSMI)**. By supporting frameworks like the **Voluntary Ecological Markets (VEM)**, DOVU ensures businesses can meet global requirements for workflows, compliance, and market readiness with ease. {% hint style="info" %} Read the DOVU use case in the published ["Voluntary Ecological Markets (VEM) v2" ](https://gbbcouncil.org/wp-content/uploads/2022/09/Voluntary-Ecological-Markets-Version-2-InterWork-Alliance.pdf)published by the IWA through the Global Blockchain Business Council (GBBC) {% endhint %} Our modular, adaptable system enables businesses to: * Streamline workflows while adhering to established standards (e.g., IWA VEM) and larger scale alignments — Global Standards Mapping Initiative (GSMI). * Digitize MRV (Measurement, Reporting, and Verification) with validated schemas, tokenized credits, and modular identity. * Scale and connect infrastructure across industries, from **supply chain automation** to **real-world asset (RWA) tokenization**. Which results in: * **Lower Barriers to Adoption:** DOVU OS reduces the cost and complexity of developing and deploying workflows through a unified interface. Developers can start quickly with minimal investment, leveraging a streamlined, intuitive system to meet their needs. * **Flexibility for Enterprises:** Enterprises gain the ability to create custom, adaptable workflows without the need for extensive infrastructure or technical overhead. Whether managing global supply chains or tracking real-world assets, the system empowers businesses to respond to dynamic requirements effectively. {% hint style="info" %} [Learn more on how DOVU supports](https://mmcm.in/elv-carbon-credit/) government driven initiatives within India for the ministry of transport to model circular economies for the recycling of end-of-life vehicles resulting in issueance of tokenised credits for sale. {% endhint %} ## Real-World Applications * **Supply Chain Automation**: Track provenance, reduce fraud, and validate ecological and operational claims. * **Asset Tokenization**: Bridge physical and digital assets for transparency, accountability, and enhanced liquidity. * **Compliance Standards**: Align workflows with global standards like ISO 20022 and IWA VEM, ensuring seamless regulatory adherence. * **Fraud Prevention**: Ensure oversight in critical processes such as procurement and contract execution. ## Why DOVU Matters DOVU OS sets a new standard for developers and enterprises, making the adoption of **global standards** effortless. With tools like our API-first architecture, SDKs, and comprehensive documentation, businesses can create impactful solutions faster than ever. By connecting **validated workflows** with emerging standards like GSMI and leveraging frameworks such as the **IWA VEM**, DOVU becomes the easiest vehicle for businesses looking to lead the future of sustainable and compliant ecosystems. ## Find out more. For further support on leveraging DOVU OS, our team is here to help you unlock your next milestone. Explore more at [**DOVU Earth**.](https://dovu.earth/) # The Engine The Workflow Engine has been a core component of DOVU’s operations, powering real-world use cases. This Developer Preview marks the first opportunity for external developers to explore. ## **Overview** The Workflow Engine is the foundational infrastructure of DOVU OS, designed to serve both **project developers creating supply** and **demand-side actors querying credits** to meet their specific needs. It acts as a core system for managing workflows, data, identity, and tokenized assets, while also functioning as a **data warehouse** for demand-side insights. By seamlessly connecting supply creation with demand insights, the Workflow Engine provides the tools needed to build scalable, high-integrity ecosystems for environmental credits and tokenized assets. This dual role makes the Workflow Engine the backbone of DOVU OS: 1. **For Project Developers**: A platform to onboard, manage, and issue credits with full compliance and traceability. 2. **For Demand-Side Actors**: A query system for enterprises and buyers to connect with credits tailored to their goals and regulatory obligations. **DOVU works with clients to fully understand their business requirements, particularly in developing circular economies or managing specific projects tied to sustainability objectives.** From these requirements, we map needs into schemas, data flows, and workflows within the system. Flexibility is paramount, enabling us to test and refine different use cases to deliver effective solutions. In future releases of the system, developers and product teams will have this power within their own hands.

Figure 1: The Workflow Engine as a Flywheel
This diagram illustrates the Workflow Engine’s dual role as a system connecting supply creation and demand-side querying in a seamless feedback loop.

### **Use Case Example** The Workflow Engine’s versatility is exemplified by its role in the [**digitization of End-of-Life Vehicle (ELV) credits**](https://dovu.earth/en/dovuos/). **The Challenge**: Supporting a **circular economy** for Original Equipment Manufacturers (OEMs) by reducing carbon emissions through verified government-backed Certificate of Deposits (CDs). Government-sanctioned recycling centers, such as **Registered Vehicle Scrapping Facilities (RVSFs)**, invest additional time and care in the recycling process to minimize environmental impact. However, this higher standard of recycling incurs additional costs, which can only be offset through the creation of credits that are sold on marketplaces to generate additional revenue streams. ### **The Solution**: Using the DOVU Engine to onboard projects, manage data, and issue tokenized ELV credits. These credits are generated through RVSFs and tied directly to emissions reductions. OEMs can leverage these credits to provide retail discounts for customers, closing the loop between emissions reduction and consumer benefits. By tokenizing these processes, the system ensures compliance, traceability, and scalability for all participants in the ecosystem.

Figure 2: Workflow Engine as a Data Warehouse
This diagram showcases how the Workflow Engine integrates supply workflows with demand-side queries, enabling enterprises to align credits with regulatory and market requirements.

*** ## **Key Features of the Workflow Engine** 1. **Supply Creation for Developers** * Onboard projects and issue credits using prebuilt workflows connected to Hedera Guardian policies. * Schema validation ensures compliance and traceability for all data submissions. 2. **Demand-Side Data Warehouse** * Enterprises can query available credits based on type, volume, or geography to align with sustainability and Scope 3 goals. * Demand signals feed directly into workflows, ensuring the supply aligns with real-time market needs. 3. **Integrated Workflows and Actors** * Assign roles dynamically and connect actors to workflows, mirroring real-world processes like verifications and approvals. 4. **End-to-End Lifecycle Support** * Manage everything from data onboarding to credit issuance and marketplace integration, creating a seamless credit lifecycle. *** ## **A Proven System, Solving Problems** DOVU’s Workflow Engine has already been used to support high-impact projects, from sustainability initiatives to data-heavy regulatory use cases. With the **Developer Preview**, external developers can now: * Access and experiment with prebuilt workflows. * Issue testnet credits and manage actors. * Understand how the Workflow Engine bridges demand-side signals with supply-side action. Looking forward, the Workflow Engine will expand to include: 1. **Custom Workflow Creation**: Developers will soon be able to design and publish their own workflows, enabling unique use cases. 2. **Advanced Data Integration**: Future iterations will include more modular features and expanded integrations, making the system adaptable for even more industries. *** ## **Next Steps** Start exploring the Workflow Engine today: 1. **Experiment with Prebuilt Workflows**: Test workflows designed to streamline credit creation and management. 2. **Dive into the API Documentation**: Understand how to interact with workflows, roles, and credit issuance processes. 3. **Issue Testnet Credits**: Simulate the full lifecycle of credit creation and validate how data and actors interact. # What to Expect Next ## **Explore the Developer Preview** Now that you’ve been introduced to the Workflow Engine and its capabilities, the next step is diving deeper into the tools and resources provided in the Developer Preview. This includes detailed tutorials, API endpoints, and hands-on experimentation with prebuilt workflows. *** ## **What’s Covered in the Next Section** In the following pages, you’ll find: 1. **Tutorials for Getting Started** * Learn how to interact with the Workflow Engine through practical examples. * Follow a step-by-step guide to issue your first testnet credit. 2. **API Documentation** * A comprehensive list of API endpoints available in the Developer Preview. * Example payloads and responses to help you build quickly. 3. **Use Case Walkthroughs** * Explore predefined workflows for real-world applications, such as ELV credits. * Understand how to map workflows to your own projects. *** ## **How to Prepare** Before jumping into the tutorials and API documentation, here are a few tips: * The **Developer Preview is completely open**, allowing you to test freely and explore the system’s capabilities. * **Set up a developer environment** where you can make API calls. We recommend using Postman for additional documentation and testing API requests. * Familiarize yourself with the **basic structure of workflows, actors, and credits** introduced in the previous pages. * Have a **local developer environment** ready to start experimenting with workflow instances and credit issuance with the language of your choice. *** ## **Ready to Build?** Let’s get started! Move on to the **Getting Started with Tutorials** page to begin your journey with the Workflow Engine. # API Reference The Workflow Engine API is the core interface for interacting with workflows, actors, and credits within DOVU OS. The Workflow Engine API is the core interface for interacting with workflows, actors, and credits within DOVU OS. This reference provides detailed documentation for all endpoints, including examples and expected responses, empowering developers to integrate seamlessly into the system. *** At a glance, the Workflow Engine system is driven by different actors assigned specific roles. These roles determine how users interact with workflows, such as submitting data, verifying approvals, or managing workflow blocks. Tutorials and examples will link back to their corresponding API documentation for easy reference. Tutorials and examples will link back to their respective section to specific API documentation. {% hint style="info" %} The primary *domain* for DOVU OS during the developer preview period is listed below: [***https://testnet-os.dovu.earth***](#user-content-fn-1)[^1] Within your postman environment please set the **domain** value to be the address above. {% endhint %} if you would like to start testing with the API, without reading the documentation further, you can do so through the postman link below. {% embed url="" %} ***
Workflow Blueprint MangementHow to publish, and manage workflow instances, including searching for existing workflows./pages/w33SdHy8jabKlg7r6MDI
Workflow Instance ProcessingProcess workflow instances, and related block, such as pushing data or approval steps using specific actors with roles./pages/2e3X3zUKGkKFbQCuY4pk
Actor Registration and RolesHow to register users, assign roles, and connect them to specific workflows./pages/HnSuFbvhumhqSrfUW9Bq
Credit Query SystemHow to query the credit warehouse to find specific credits using advanced filtering options./pages/Paa5MP6jE1ur7xvoBvyi
Audit TrailsHow to retrieve comprehensive audit trails for processed workflows, ensuring traceability and compliance./pages/61XTixIJYQncMAhHtwWn
Schema and Data ValidationHow to discover workflow-related schemas and validate submitted data against predefined rules./pages/4VEcsNOgC7FRhzEXn8F9
[^1]: # Workflow Blueprints How to manage, search, and publish new workflow instances from blueprints. Workflow Blueprints enable users to define, manage, and publish reusable workflow templates. These blueprints streamline the process of creating workflows by breaking them into modular components like blocks, roles, and schemas. With Workflow Blueprints, developers and project owners can ensure consistency, scalability, and transparency across their workflows. **Key Benefits**: * **Reusability**: Easily replicate workflows for similar projects, saving time and effort. * **Traceability**: Maintain full visibility into workflow components and execution history, ensuring accountability. * **Integration Ready**: Publish workflows that seamlessly integrate with validation schemas and external systems. ## Core workflow blueprint handling These below methods are focused on working directly with workflows or blueprint, and how owners can publish, and understand what instances have connected status. *** {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/blocks" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/instances" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/instances/workflow\_instance\_id" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/publish" method="post" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/schemas" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} # Workflow Block Instance Processing This section details how to interact with workflow instances by submitting data to different block types within a workflow. It covers both Approval Process Blocks and Data Process Blocks. **Submitting Block Types in Workflow Instances**\ Workflow Block instances are the operational units of the DOVU OS Workflow Engine. Within each block instance, block types define specific stages or actions, such as data submission, validation, or approval processes. This section focuses on two primary block types: 1. **Data Process Blocks**:\ These blocks allow users to submit and store structured data related to the workflow. Typical use cases include collecting user information, project details, MRV data, or geographic data necessary for the workflow's progression. 2. **Approval Process Blocks**:\ These blocks facilitate decision-making steps in the workflow. Users can submit approvals or rejections, with optional messages explaining the decision. This ensures compliance and transparency in workflows requiring oversight or multiple stakeholders. **How It Works** * Each block is tied to a specific **workflow instance ID** and acts as a modular step in the broader workflow lifecycle. * Each block is tied to a specific role that can act on the block, all roles are connected actors that must be prior connected to a workflow instance from the owner or registry actor. * Developers can interact with these blocks via POST requests, submitting data that drives the instance forward or changes its state. * Responses from these endpoints include metadata about the workflow instance, enabling further actions or integrations. **Key Use Cases**: * Submitting project data for environmental credit issuance. * Approving or rejecting specific workflow stages to ensure compliance. * Using returned data for visualization or tracking in front-end applications. With these endpoints, developers can manage workflow instances dynamically, ensuring seamless integration of data submissions and approvals into the workflow lifecycle. *** {% openapi src="/files/8Pvw8mj5JRwQoHlDDzln" path="/api/v1/workflow-block-instances/data\_workflow\_block\_instance\_id" method="post" %} [DOVU OS.openapi(2).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2F06V2ZUViujbBzewa1wXh%2FDOVU%20OS.openapi\(2\).yaml?alt=media\&token=ba5bcc29-0fb4-48cf-9884-1823433ae77d) {% endopenapi %} {% openapi src="/files/8Pvw8mj5JRwQoHlDDzln" path="/api/v1/workflow-block-instances/approval\_workflow\_block\_instance\_id" method="post" %} [DOVU OS.openapi(2).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2F06V2ZUViujbBzewa1wXh%2FDOVU%20OS.openapi\(2\).yaml?alt=media\&token=ba5bcc29-0fb4-48cf-9884-1823433ae77d) {% endopenapi %} # Actor Registration and Roles How to onboard new actors into the DOVU OS system, manage their access, and assign them specific roles within workflows. The DOVU OS Workflow Engine relies on actors to execute, manage, and interact with workflows. These actors are users who are assigned roles such as project owners, verifiers, or registries. The **Actor Registration and Roles** module provides tools to onboard and manage these users, ensuring that workflows operate smoothly and securely. **Key Features** 1. **Actor Registration**: Create a new actor by registering them with a unique email, name, and role. This step is essential for adding users who will interact with the workflow engine. 2. **Authentication**: Authenticate actors via the login endpoint, enabling secure access to the system and generating authorization tokens for API requests. 3. **Role Assignment**: Assign specific roles to actors, determining their permissions and responsibilities within workflows. 4. **Linking to Workflow Instances**: Attach users to specific workflow instances, granting them access to manage or interact with specific tasks. **How It Works** * Actors are registered with a predefined role, such as **supplier**, **verifier**, or **registry**. * Authentication tokens are used to ensure secure access to the system. * Each actor can be linked to one or more workflow instances, defining their specific responsibilities. **Use Cases** * **Onboarding New Users**: Register project developers or verifiers to manage and approve workflow stages. * **Assigning Workflow Roles**: Ensure that only authorized actors can access or modify workflows. * **Securing Access**: Use authentication tokens to safeguard interactions with the API. With these endpoints, enterprises can easily manage user access, assign roles, and integrate actors into the workflow lifecycle. {% hint style="info" %} This currently is a longer running query when workflows are connected to a guardian instance, this is a piece that we will be working on to optimise the developer experience. {% endhint %} *** {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/register" method="post" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/login" method="post" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/user-workflow-instances" method="post" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} # Credit Warehouse Queries By enabling data-driven insights at both workflow and instance levels, this module empowers developers and enterprises to align supply-side credit issuance with real-time demand signals. The Credit Warehouse serves as the intelligence hub of the DOVU OS ecosystem, enabling users to query issued assets with unparalleled granularity. By connecting demand-side insights with workflow-level data, it empowers project developers to make better decisions when creating and issuing ecological or carbon credits. **Key Benefits to Users** 1. **Actionable Insights**\ Project developers gain real-time visibility into issued credits, filtered by workflow, workflow instances, or specific data points within schemas. This allows them to adapt their credit issuance strategies to meet market demand more effectively. 2. **Demand-Driven Decision Making**\ By using query results as demand signals, enterprises can better align their credit supply with sustainability goals, market trends, and regulatory requirements. 3. **Granular Filtering**\ Filters at the workflow and instance levels make it easy to access highly specific data. Whether developers want to analyze credits linked to specific project owners, geographies, or verification statuses, the Credit Warehouse supports precise queries. 4. **Future Integration with Market Signals**\ As the system evolves, query data will integrate with **demand-side signals** to create a feedback loop. Developers will gain predictive insights, such as which types of credits are most in demand, helping them optimize their projects for maximum impact and revenue. *** **How It Works for Users** 1. **Query Workflows and Instances**\ Users can search for issued assets across workflows or drill down into specific instances. This enables them to track credits from creation to issuance and beyond. 2. **Schema-Based Flexibility**\ Queries can include schema field values, enabling dynamic searches for credits based on specific parameters, such as project type, region, or verification method. 3. **Immediate Feedback**\ By analyzing query results, developers can adjust workflows to better align with demand signals, ensuring that the credits they produce meet real-world needs. *** **Use Cases** 1. **Informed Credit Creation**\ Developers can analyze which types of credits are most frequently issued or in high demand, guiding future projects toward areas with the highest market potential. 2. **Market Responsiveness**\ Enterprises can monitor issued credits to identify emerging trends, such as regional demand for specific types of offsets, and adjust their supply strategies accordingly. 3. **Optimized Reporting**\ Use the query functionality to generate reports on issued credits, broken down by workflow instance or schema-defined categories, for stakeholders or compliance purposes. *** **Looking Ahead: Signals-Driven Development** The true power of Credit Warehouse Queries will be realized when they integrate with **market demand signals**. By connecting this data to dynamic demand indicators, project developers will be able to anticipate market trends, such as: * Which regions are most in need of specific credits. * What types of projects are being prioritized by buyers. * How regulatory changes are influencing credit demand. This integration will close the loop between supply and demand, ensuring that every credit issued is optimized for both ecological impact and market relevance. Over time, this will help create a smarter, more efficient ecosystem for carbon and ecological credits. *** {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflows/workflow/issued-assets" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} # Audit Trails Audit trails play a critical role in ensuring transparency, compliance, and trust within the DOVU OS system. Audit trails play a critical role in ensuring transparency, compliance, and trust within the DOVU OS system. By providing a detailed record of every action and event associated with a workflow instance, these trails form the backbone of provenance tracking. Whether for visualizing credits in a marketplace or generating compliance reports, audit trails offer the insights needed to validate the integrity of credits. **Key Benefits** 1. **End-to-End Provenance**:\ Track the entire lifecycle of a credit, from its creation to issuance, transfer, and beyond. This ensures that every step in the workflow is fully traceable. 2. **Marketplace Visualization**:\ Enable third-party marketplaces or platforms to display the complete journey of a credit, giving buyers and stakeholders confidence in its authenticity and impact. 3. **Compliance and Reporting**:\ Provide detailed records to meet regulatory requirements or demonstrate adherence to industry standards. This is especially valuable for sustainability-focused projects. 4. **Seamless Integration**:\ Use the audit trail data to integrate with front-end visualizations, dashboards, or external systems, enabling easy consumption of the provenance data. *** **How It Works** * The **Get Workflow Instance Audit Trail** endpoint retrieves a chronological list of actions, events, and associated metadata for a specific workflow instance. * Each audit trail entry captures key information such as timestamps, user actions, workflow transitions, and schema updates. * The endpoint supports structured responses, including pagination and links for navigating large datasets. *** {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/workflow-instances/workflow\_instance\_id/audit-trail" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} # Schema and Data Validation Empowers developers to explore schemas, validate data, and test system integrations for specific workflows before committing to their execution. The Schema and Data Validation module enables developers to fully understand and test the structural requirements of workflows. By exposing schema details and providing tools to validate data, it ensures that workflows are configured correctly and ready for production. This functionality is critical for ensuring alignment between data inputs and workflow expectations. **Key Benefits** 1. **Schema Exploration**:\ Developers can retrieve schema definitions and their associated fields, understanding the structure and constraints of the data required for workflows. 2. **Data Validation**:\ The ability to test data submissions against schemas ensures that workflows are not disrupted by invalid or improperly formatted data. 3. **Pre-Workflow Testing**:\ Developers can simulate data submissions to validate the workflow’s functionality before committing to real-world use. This eliminates errors during the workflow lifecycle. 4. **Enhanced Querying**:\ When combined with Credit Warehouse Queries, users can align schema details with the fields required to interact with issued assets, creating a seamless querying experience. *** **How It Works** 1. **Schema Index**:\ Retrieve a list of schemas tied to specific workflows. Each schema outlines the structure, fields, and validation requirements for data submissions. 2. **Schema Fields**:\ Explore detailed field-level metadata within schemas, such as required fields, primary keys, and data types. 3. **Test Data Validation**:\ Use the validation endpoint to test data submissions before applying them to a live workflow. This ensures that data meets all schema requirements and prevents issues downstream. *** **Use Cases** 1. **Pre-Deployment Testing**:\ Developers can test workflows and validate data against schemas to ensure smooth operation in production environments. 2. **External Query Alignment**:\ Schema exploration helps external users understand which fields are required to query the system, especially when interacting with the Credit Warehouse. 3. **Streamlined Workflow Development**:\ By understanding schemas and validating data, developers can design workflows that are optimized for their specific use cases. *** {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/schema" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/schema/schema/fields" method="get" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} {% openapi src="/files/6mJSP7xbb1mnOT7LWsQy" path="/api/v1/schema/schema/validate" method="post" %} [DOVU OS.openapi(1).yaml](https://116257023-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FMgfYR4iNMhdWqFrJ1ibn%2Fuploads%2Fp3lUNEaW0nFPV2ZCMt2b%2FDOVU%20OS.openapi\(1\).yaml?alt=media\&token=2b22f069-e425-4f40-8e6d-176ba0f1db49) {% endopenapi %} *** #### **Future Enhancements** In future iterations, we plan to introduce a **Schema Builder** that will revolutionize how developers and users interact with the DOVU OS system. This highly visual, drag-and-drop interface will enable seamless creation, modification, and updating of schemas in real-time. The key features of the Schema Builder will include: 1. **User-Friendly Design**:\ A simple, intuitive interface that empowers developers and non-technical users to construct schemas with ease, eliminating the need for extensive technical knowledge. 2. **Dynamic Updates**:\ The ability to modify schemas dynamically and pivot designs as project needs evolve, ensuring maximum flexibility and adaptability. 3. **Workflow Integration**:\ Once built or updated, schemas will automatically connect to the larger workflow system, enabling seamless integration into the project lifecycle. This ensures that schema changes are instantly reflected in workflows, maintaining alignment across the system. 4. **Visual Flow Representation**:\ A drag-and-drop flow representation that simplifies schema creation and aligns it with workflow visualization, making it easier to design end-to-end solutions. This future enhancement will significantly streamline the process of schema creation and management, making the system more accessible, flexible, and efficient for all users. It represents a key step forward in empowering users to fully harness the potential of the DOVU OS Workflow Engine. # 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. 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. {% hint style="info" %} For more information on how DOVU can model different process flows please read our section on our [template language](broken://pages/Ldyz5gtV13VkXY0VoiS6). {% endhint %} *** ### 1. **Register Users** 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. {% content-ref url="/pages/HnSuFbvhumhqSrfUW9Bq" %} [Actor Registration and Roles](/workflow-engine/editor/actor-registration-and-roles) {% endcontent-ref %}

Example: Registering A new user

*** ### 2. **Search for Workflows** 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. {% content-ref url="/pages/w33SdHy8jabKlg7r6MDI" %} [Workflow Blueprints](/workflow-engine/editor/workflow-blueprints) {% endcontent-ref %}

Example: List all Workflow blueprints that exist in system

From this you may extract out the **id** value to use for publishing. *** ### 3. **Publish a Workflow** 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.** {% content-ref url="/pages/w33SdHy8jabKlg7r6MDI" %} [Workflow Blueprints](/workflow-engine/editor/workflow-blueprints) {% endcontent-ref %}

Example: publishing a workflow

**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.

Example: a workflow instance currently importing its downstream dependencies.

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.

Example: a workflow instance in a Ready state

{% hint style="info" %} Note: The publishing and Guardian policy import process may take a few minutes. Ensure the workflow instance is ready before proceeding to user attachment. {% endhint %} *** ### 4. **Attach Users to the Workflow** After the workflow instance has reached the **Ready** state, attach the previously registered users (supplier, verifier) to your workflow. {% content-ref url="/pages/HnSuFbvhumhqSrfUW9Bq" %} [Actor Registration and Roles](/workflow-engine/editor/actor-registration-and-roles) {% endcontent-ref %} {% hint style="warning" %} 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."* {% endhint %} *** ### 5. **Submit Data to Blocks** 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. {% content-ref url="/pages/2e3X3zUKGkKFbQCuY4pk" %} [Workflow Block Instance Processing](/workflow-engine/editor/workflow-block-instance-processing) {% endcontent-ref %} *** ### 6. **Approval Block Workflow** 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. {% content-ref url="/pages/2e3X3zUKGkKFbQCuY4pk" %} [Workflow Block Instance Processing](/workflow-engine/editor/workflow-block-instance-processing) {% endcontent-ref %} *** ### 7. **Final Submission and Claim Approval** 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. {% content-ref url="/pages/2e3X3zUKGkKFbQCuY4pk" %} [Workflow Block Instance Processing](/workflow-engine/editor/workflow-block-instance-processing) {% endcontent-ref %} *** ### 8. **Issuing Credits and Querying Assets** 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. {% content-ref url="/pages/61XTixIJYQncMAhHtwWn" %} [Audit Trails](/workflow-engine/editor/audit-trails) {% endcontent-ref %} {% content-ref url="/pages/Paa5MP6jE1ur7xvoBvyi" %} [Credit Warehouse Queries](/workflow-engine/editor/credit-warehouse-queries) {% endcontent-ref %} # Rationale Creating an interoperable workflow system requires more than static configurations. Creating an interoperable workflow system requires more than static configurations. The primary goal is to map and develop processes that can seamlessly connect to any integration or third-party Distributed Ledger Technology (DLT) system. To achieve this, the language must: * **Be Readable:** Allow both technical and non-technical users to understand the process at a glance. * **Be Flexible:** Adapt to diverse systems and evolving requirements. * **Be Maintainable:** Serve as a bridge between workflows and integrations. We drew inspiration from **Extensible Data Notation (EDN)**, a configuration format commonly used in Clojure. EDN’s lightweight and expressive structure makes it ideal for modeling workflows in a clear and concise manner. Unlike JSON or YAML, EDN excels at showing data flows and dependencies, making it a better fit for a modular and extensible workflow system. This approach provides a unified interface between DOVU workflows and third-party integrations, enabling seamless connections and human-readable logic. {% hint style="info" %} This is a work in progress. Over time, the language will become even more intuitive, ensuring accessibility and ease of use for all stakeholders. {% endhint %} # At a glance The DOVU Template Language is a configuration-based approach to streamline and standardize workflow management. The DOVU Template Language is a configuration-based approach to streamline and standardize workflow management. Designed with simplicity and flexibility in mind, this language offers a human-readable and machine-parseable way to model processes, integrate third-party systems, and manage approval workflows. This foundation empowers users to define workflows efficiently while maintaining interoperability with existing systems like Guardian or future integrations. While in its early stages, this template language is designed to evolve into a cornerstone of our interoperable workflow ecosystem. *** ## **Example Use Case** Imagine a workflow for End-of-Life Vehicle (ELV) recycling: 1. **Role Assignment**: A **supplier** uploads ecological project data to initiate the workflow. 2. **Dynamic Approvals**: An **registry** reviews the project using the Guardian integration, ensuring compliance with predefined policies. 3. **Data Submissions**: Additional data blocks are processed, each tied to specific schemas and actions. 4. **Final Verification**: A **verifier** completes the approval cycle, triggering automated processes like audit trails and credit issuance. This flow demonstrates the power of a lightweight, expressive configuration language tailored for real-world sustainability use cases. For more information, please read our detailed breakdown in the link below. {% content-ref url="/pages/S2Oem8wrV9OH4ao4ZbDx" %} [Use Case: ELV Recycling](/template-language/use-case-elv-recycling) {% endcontent-ref %} # Use Case: ELV Recycling End-of-Life Vehicle (ELV) recycling is a critical area in sustainability, presenting complex challenges for managing data, approvals, and certifications. ### Overview End-of-Life Vehicle (ELV) recycling is a critical area in sustainability, presenting complex challenges for managing data, approvals, and certifications. The DOVU Template Language provides a lightweight yet powerful way to address these challenges by modeling workflows that integrate seamlessly with third-party systems like the **Hedera Hashgraph Guardian**. In this use case, we illustrate how the template language simplifies the ELV recycling process by defining roles, actions, and approvals while ensuring traceability and interoperability. Find out more by reading our [case study on DOVU.earth.](https://dovu.earth/en/dovuos/) ## An example configuration Below, you can see the configuration that we used to model data or more specifically model the actual process for managing the entire project. One of the exciting features about this configuration is that it is data and schema agnostic, so that any process that uses three stages of data ingestion, followed by approvals can be consumed by simply duplicating this configuration for a given use case. ```clojure ;; EXPERIMENTAL (DOVU OS) Configuration Language v0.0.2 ;; ;; Minimise cost for getting credits to market through a simple and repeatable template process. ;; ;; Encapsulate the overarching process of how credits are created and managed, use this process to branch ;; for specific methodologies. ;; ;; This is an example template that would encapsulate policies for a particular registries ;; The goal here would be to describe how a policy process can be navigated where the schema don't matter [ { :role :supplier :tag :create_ecological_project :type :data :key :create-project } { :role :owner :require { :status :waiting } :filter { :tag :supplier_grid_filter :key :uuid } :source_tag :supplier_grid :tag :approve_supplier_btn :options [ :approve.template :reject.template ] :type :approval :key :approve-project } { :role :supplier :require { :status :approved } :tag :create_site_form :source_tag :create_site_form :type :data :key :register-site } { :role :owner :require { :status :waiting } :filter { :tag :site_grid_owner_filter :key :uuid } :source_tag :approve_sites_grid :tag :approve_site_button :options [ :approve.template :reject.template ] :type :approval :key :approve-site } { :role :supplier :require { :status :approved } :tag :create_claim_request_form :filter { :tag :site_grid_supplier_filter :key :uuid } :source_tag :sites_grid :type :data :key :create-claim } { :role :verifier :require { :status :waiting } :filter { :tag :claim_request_verifier_filter :key :uuid } :source_tag "claim_requests_grid(verifier)" :tag :approve_claim_requests_btn :options [ :approve.template :reject.template ] :type :approval :key :approve-claim :hooks [ { :action :audit_trail :async { :wait 5 ;; seconds :retries 10 } :field :uuid } { :action :asset_provenance :async { :wait 30 :retries 25 } :field :uuid } ] } ] ``` # Language Primitives Below are a number of core primitives that make up the DOVU template language. ## **Blocks** Blocks are the fundamental units of the DOVU Template Language. Each block defines a specific stage or action within the workflow. Let’s break down the key components: * **Role:** Specifies the actor responsible for executing the block (e.g., `:supplier`, `:verifier`). * **Type:** Defines the nature of the block, such as `:data` for data submission or `:approval` for decision-making steps. * **Key:** Maps the block to a specific schema or process, ensuring consistency and traceability. * **Tag:** Optionally links the block to third-party integrations, like Guardian, for enhanced functionality. Example: ``` { :role :supplier :type :data :key :create-project :tag :create_ecological_project } ``` This block: * Assigns the `:supplier` role. * Requires data submission (`:data`). * References the `create-project` schema. * Links to a specific Guardian policy using the `:tag` attribute. *** ## **Filters and Require States** {% hint style="danger" %} When working with third-party systems, occasionally one needs to wait until the system is a correct state before continuing, these specific keys allow for scanning for state before consuming the next stage of a given workflow. {% endhint %} Filters and require states enhance block functionality by defining dependencies and prerequisites. For example: * **Require States:** Ensure that a block cannot proceed unless a specific condition is met (e.g., `:status :approved`). * **Filters:** Narrow down the scope of data or actions based on predefined criteria, such as `:tag` or `:key` values. These mechanisms ensure that workflows progress logically and efficiently, maintaining data integrity and reducing errors — while reducing complexity for developers. *** ## **Hooks** Hooks allow developers to attach side-effects to specific blocks, enabling additional functionality. Common use cases include: * **Audit Trails:** Automatically record actions for compliance and transparency. * **Asset Provenance:** Trigger events to generate and store metadata for issued credits. After a approval has happened, we know that we need to use a third-party integration hook to find some data to store in our system, we provide wait and we try figures so that we can have more than one attempt to capture the data required. ### Example: ``` { :role :verifier :type :approval :key :approve-claim :hooks [ { :action :audit_trail :async { :wait 5 :retries 10 } :field :uuid } ] } ``` *** ## **Integration with Core Systems** The template language integrates seamlessly with DOVU’s core workflow engine and third-party systems. Current integrations include: * **Guardian:** Manage policy imports and approvals. * **Data Validation:** Ensure submitted data conforms to predefined schemas. * **Credit Warehouse:** Query and store issued credits for downstream usage. As the system evolves, we plan to add: * **Drag-and-Drop Configuration:** A visual interface for creating templates. * **Dynamic Schema Updates:** Real-time schema modifications without disrupting workflows. * **Cross-System Integration:** Expand support for IoT, AI, and other advanced systems. * **General Issuance:** Example for mapping any issuance of RWA, Supply chain, or regulatory process. # Guardian Deployment System Introducing DOVU's guardian deployment system. **DOVU's Guardian Infrastructure** redefines simplicity and speed for developers and enterprises, making it easier than ever to issue credits through the Guardian ecosystem. By combining rapid deployment with robust interoperability, this infrastructure eliminates the barriers that have traditionally slowed down access to distributed ledger technology and the issuance of tokenized credits. {% embed url="" %} Video: Walkthrough demo of DOVU's Guardian Deployments {% endembed %} ### **Built for Speed and Simplicity** Deploying a Guardian instance has never been easier. With the DOVU Guardian Infrastructure, developers can set up fully isolated Guardian environments in under **30 minutes**, allowing them to move from concept to execution faster than ever before. This capability ensures that projects can scale quickly without the technical overhead of building from scratch. ### **Enterprise-Grade Scalability** For enterprises, the infrastructure offers **horizontal and vertical scalability**, enabling them to: * Deploy isolated Guardian instances for individual clients, ensuring privacy, security, and compliance. * Expand deployments as business needs grow, whether scaling the number of environments or increasing capacity for larger operations. This flexibility allows businesses to adapt quickly to changing demands, paving the way for efficient and scalable credit issuance. ### **Interoperability Through the Workflow Engine** At the heart of this system lies the **DOVU Workflow Engine**, which acts as the connective tissue between deployments. The engine: * Facilitates seamless communication across Guardian instances. * Tracks user identities, creating a **centralized identity repository** that ensures transparency and accountability across workflows. * Standardizes processes, allowing developers to integrate their solutions with minimal effort. This combination of interoperability and centralized management makes issuing credits through the Guardian ecosystem simpler and more efficient than ever. **The New Standard for Issuing Credits** The DOVU Guardian Infrastructure sets a new benchmark for issuing tokenized credits: * **For Developers**: Fast, modular deployment means you can focus on building innovative solutions, not infrastructure. * **For Enterprises**: A scalable, secure platform ensures you can meet the needs of clients and stakeholders with ease. By streamlining deployment and enabling seamless interoperability, the DOVU Guardian Infrastructure positions itself as the fastest and most efficient way to issue credits within the Guardian ecosystem. # Guardian PHP SDK The development of DOVU's ongoing PHP SDK for Guardian. The **Guardian PHP SDK by DOVU** simplifies the process of interacting with the Guardian API, enabling developers to efficiently manage policies, workflows, and tokenized credits within the DOVU ecosystem. This SDK is designed to reduce complexity, provide clear workflows, and ensure seamless integration with Guardian infrastructure. Check it out below: {% embed url="" %} ## **Key Features** 1. **Configuration-Based Management**\ The SDK enables configuration-driven consumption and management of Guardian policies, leveraging workflows and templates to streamline interactions. 2. **Rapid Integration**\ Using the SDK, developers can easily: * Import and manage Guardian workflows. * Assign roles to users and interact with workflow stages. * Validate payloads against schema specifications before submission. 3. **Workflow Automation**\ The SDK supports a mediator and strategy pattern, making it possible to automate complex workflows with minimal code. It ensures clear and reliable data flow for submitting and approving ecological projects, sites, and claims. 4. **End-to-End Testing and Validation**\ The SDK includes robust testing capabilities to validate workflows and detect potential bottlenecks in Guardian operations, such as data queries and scaling challenges. Developers can use dry-run scenarios and testnet environments to simulate production workflows. ## **Strategic Approach** The SDK prioritizes: * **Simplicity**: Minimizing the number of methods required to interact with Guardian. * **Scalability**: Addressing N+1 query issues and ensuring readiness for large-scale deployments. * **Flexibility**: Supporting custom schemas and workflows to meet enterprise needs. ### **Developer Flow Example** The SDK enables step-by-step interaction with Guardian workflows: 1. **Setup**: Configure the SDK with Guardian API details. 2. **Policy Import**: Import workflows using `GuardianWorkflowConfiguration`. 3. **Stage Execution**: Perform actions such as creating projects, approving claims, and minting tokens. 4. **Validation**: Use schema specifications to validate data before submission. ## **Why It Matters** The **Guardian PHP SDK** is a foundational tool for developers building on DOVU and the Guardian ecosystem in PHP and Laravel projects. By abstracting complex API interactions, it empowers users to focus on creating impactful solutions for sustainability and beyond. The SDK sets a new standard for working with Guardian policies, combining ease of use with enterprise-grade capabilities. ## Need Support? If you need assistance using the **Guardian PHP SDK** or have questions about how to integrate it into your projects, our team is here to help. Please don’t hesitate to reach out for further guidance or support in making the most of this powerful tool.