corrad-bp/doc/README.md
Afiq fa90c234c5 Enhance Process Builder with New Features and Configuration Options
- Added a new ProcessTemplatesModal component for selecting process flow templates, improving user experience in template management.
- Introduced a ProcessSettingsModal component for comprehensive process configuration, including process info, execution settings, and permissions management.
- Updated BusinessRuleNodeConfiguration and FormNodeConfiguration components to enhance user interaction and streamline configuration processes.
- Implemented new API endpoints for managing form fields and settings, allowing for better integration and data handling.
- Enhanced existing components with improved styling and functionality, including dynamic field conditions and bidirectional data mapping.
- Updated nuxt.config.js to include security settings for API routes, ensuring better protection against XSS and request size limitations.
- Removed the deprecated TaskNodeConfiguration component to streamline the process builder interface.
- Improved documentation to reflect recent changes and enhancements in the process builder features.
2025-05-27 17:00:24 +08:00

4.7 KiB

Corrad ProcessMaker Documentation

Welcome to the Corrad ProcessMaker documentation. This repository contains comprehensive guides and technical documentation for developers and users of the Corrad ProcessMaker platform.

Documentation Structure

The documentation is organized into the following sections:

Overview

Process Builder

  • User Guide - How to use the Process Builder
  • Technical Guide - Technical details of the Process Builder implementation
  • Roadmap - Planned improvements for the Process Builder

Form Builder

Process Execution

  • User Guide - How to use the Process Execution interface
  • Technical Guide - Technical details of the Process Execution implementation

Getting Started

New to the project? We recommend reading the documentation in this order:

  1. Project Overview - Understand what the system does
  2. Development Guide - Learn how to set up your development environment
  3. Architecture - Understand the technical architecture
  4. User guides for components you'll be working with
  5. Technical guides for deeper implementation details

Contributing to Documentation

When contributing to this documentation:

  1. Keep the structure organized and logical
  2. Update cross-references when moving or renaming files
  3. Ensure code examples are up-to-date
  4. Include diagrams where helpful
  5. Keep the language clear and concise

Contact

If you have questions about this documentation or need help with the system, please contact the development team.

Last updated: December 2024

Recent Updates

December 2024 - Major Process Builder Enhancements

  • Enhanced Form Node Configuration: Complete redesign of form task configuration with step-by-step workflow
  • Input/Output Mappings: Bidirectional data flow between process variables and form fields
  • Field Conditions: Dynamic field behavior based on process variables (readonly, hidden, required states)
  • 4-Point Connection System: All nodes now have 4 connection points (top, bottom, left, right) to prevent edge overlaps
  • Improved Visual Design: Better handle styling with hover effects and connection state feedback
  • Auto-Save Mechanism: Reliable data persistence for form configurations and mappings
  • Variable Integration: Seamless integration with process variables for form pre-filling and data capture
  • Conditional Logic: Support for complex field conditions with multiple operators and actions
  • Process Settings Management: Comprehensive process configuration with 5 organized tabs:
    • Process Info: Name, description, priority, category, ownership management
    • Execution Settings: Process type, timeouts, parallel execution, error recovery
    • Variables & Data: Data persistence policies, logging, encryption, retention controls
    • Permissions: Role-based access control, execution permissions, approval workflows
    • JSON Export: Complete configuration export with metadata for API integration
  • Advanced Configuration Options: Professional-grade settings comparable to enterprise BPM platforms
  • Enhanced State Management: Improved process store with settings persistence and history tracking

December 2024 - Major Form Builder Enhancements

  • JavaScript Execution Engine: Added FormScriptEngine component for real-time calculations
  • Dynamic Field Updates: Implemented onFieldChange and onLoad event handlers
  • Real-time Calculations: Forms now support live mathematical calculations and field dependencies
  • Enhanced Debugging: Comprehensive logging and error handling for JavaScript execution
  • API Documentation: Complete JavaScript API reference with practical examples
  • Performance Optimizations: Improved change detection and memory management
  • Security Enhancements: Sandboxed JavaScript execution with input validation