Skip to content

Latest commit

 

History

History
109 lines (90 loc) · 10.4 KB

table_of_contents.md

File metadata and controls

109 lines (90 loc) · 10.4 KB

StatefulWorkflow Docs

Overview

StatefulWorkflow is an extensible and sophisticated workflow class designed for Temporal.io, a popular workflow orchestration platform. It provides a robust foundation for creating dynamic, hierarchical workflows that can seamlessly manage state, synchronize data, and communicate across multiple levels of parent-child relationships. With features such as automatic child state management, dynamic data loading from APIs, powerful subscription-based state synchronization, and intelligent handling of circular relationships, StatefulWorkflow is well-suited for complex systems where entities interact across various layers and domains.

The core philosophy of StatefulWorkflow is to facilitate efficient, scalable, and flexible workflow management by abstracting away many of the tedious details associated with state handling, entity normalization, and data propagation. It allows developers to focus on implementing their business logic while the workflow itself manages the complexities of state updates, data consistency, and hierarchical relationships.

StatefulWorkflow is designed to address the complexities of managing stateful, hierarchical workflows in distributed systems. By combining automatic state management, dynamic data loading, flexible subscription-based synchronization, and intelligent relationship handling, it offers a comprehensive solution for building robust and scalable workflows. This powerful class abstracts away the complexities associated with state propagation, API integration, and entity management, allowing developers to focus on delivering business value while leveraging Temporal.io’s workflow orchestration capabilities.


Table of Contents

  1. Introduction to StatefulWorkflow

  2. Getting Started with StatefulWorkflow

  3. Defining Workflow Relationships with managedPaths

  4. State Management and Data Normalization

  5. Exposed Queries and Signals in StatefulWorkflow

  6. Dynamic Data Loading and API Integration

  7. Child Workflow Lifecycle Management

  8. Subscriptions and Signal-Based Communication

  9. Handling Circular Relationships and Workflow Ancestry

  10. Security and API Token Management

  11. Best Practices and Advanced Usage

  12. Conclusion and Further Reading