DOCSEARCHbyAlgolia
Submit Docs

BPMAX Documentation

website·Indexed 30 days ago

https://doc.bpmax.cn/

Comprehensive guides and developer documentation for BPMAX, a platform for end-to-end business process management. Includes detailed resources on plugin development (frontend and backend extensions, Hook mechanisms, and lifecycle management), bpmax-cli for Agent integration and E2E testing, system administration, and OpenAPI integration.

Tokens
76K
Snippets
254
Records
589
Agent score
50%

What's inside BPMAX

  1. Overview of BPMAX Process Management Software

    BPMAX is a flexible process management software designed for enterprise digital transformation. It enables organizations to improve operational efficiency and management levels through the following core capabilities:

    • Visual Process Design: A graphical designer allows users to create, modify, and manage processes without writing code.
    • Workflow Engine: A built-in engine supporting various process modes and rules for diverse business scenarios.
    • Task Management: Flexible task allocation based on roles and permissions, supporting actions such as approval, handover, and forwarding.
    • Data Analytics: Real-time monitoring and statistical analysis of process data to generate reports and charts.
    • Integration & Extensibility: Supports multiple data sources and application integration methods for seamless connectivity with other systems.

    BPMAX is applicable across various industries, including government, finance, healthcare, and manufacturing.

  2. Overview of System Entities

    System entities are standard data structure definitions used to describe a unified data format within the system. They allow developers to establish uniform data standards for business objects (e.g., users, orders, products), reuse the same data structures across multiple APIs, and provide a consistent data format for upper-layer business logic.

  3. Overview of BPMax System Configuration

    System configurations in BPMax are managed using JSON code. This allows developers to define various system-level behaviors and UI elements through structured data.

  4. Overview of BPMAX Built-in Interfaces

    BPMAX provides built-in interfaces for common third-party systems such as Enterprise WeChat and Feishu. These interfaces offer several advantages: they are ready-to-use without requiring deep technical knowledge of the external API, they handle authentication (Token acquisition and refreshing) automatically, and they are pre-tested for stability.

  5. Overview of Internationalization Management

    Internationalization management allows administrators to maintain multi-language text for various configuration templates within a workspace. The system uses Simplified Chinese as the source language and extracts translatable names, titles, and prompts into translation entries for English or Japanese translations.

  6. Overview of Flow Archives Plugin

    The Flow Archives plugin centralizes files, forms, and key process records from workflows. It is designed for scenarios where users need to:

    • Review attachments submitted for a project and their origins.
    • Quickly identify forms submitted within a project's flow.
    • Trace the progress of a project, including key timestamps and operators.
    • Analyze the global distribution of files, forms, and events across visible flows.

  7. Overview of BPMAX API Integration

    API Integration in BPMAX allows business processes to interact with external systems to fetch data, push data, automate cross-system workflows, and validate form data. It supports two types of interfaces:

    1. HTTP Interfaces: Standard RESTful APIs, SOAP Web Services, and custom HTTP interfaces.
    2. Built-in Interfaces: Pre-configured connectors for common platforms like Enterprise WeChat (messages, user/department management) and Feishu (message push, calendar, user management). Built-in interfaces handle authentication and request encapsulation automatically.

  8. Overview of BPMAX Entity Mapping

    Entity Mapping is a data standardization capability in the BPMAX platform. It allows developers to define a unified data structure (System Entity) and automatically convert data from different third-party sources or API versions into this standard format. This decouples business logic from the specific data formats of external systems, reducing maintenance costs when data sources change.

  9. Overview of Timeout Automation Plugin functionality

    The Timeout Automation Plugin allows developers to define specific timeout handling logic for processes and stages. When a process or stage exceeds its standard time, the system automatically triggers predefined logic such as reminders or automated transitions.

  10. Overview of bpmax-cli E2E Testing Capabilities

    bpmax-cli provides E2E testing to verify that BPMAX business processes are functional for end-users. Unlike simple API checks, it manages formal test cases, enforces execution order, drives real browser page operations, saves execution evidence, and generates reports to determine if a test passes. It is particularly suited for Agent-led process acceptance, configuration regression, customer demo validation, and batch business scenario testing.

  11. Overview of Report Template and Document Generation

    Report templates allow users to configure Word templates, field mappings, and script expressions for specific workflows to generate final documents from project details or via API. The system uses a management page for template maintenance and a GenerateReport component on project detail pages to trigger generation. Generated documents are returned as file streams rather than JSON.

  12. Overview of Feishu Team Sync and Login Plugin

    The 'Feishu - Team Sync Organization Structure and Feishu Login' plugin allows developers to map multiple Feishu tenants to multiple bpmax teams. It provides three primary functional touchpoints:

    1. Team Creation: Adds a Feishu button during team creation to bind Feishu tenant information.
    2. Organization Sync: Adds a synchronization button to the root team of a Feishu team.
    3. Authentication: Adds a Feishu login button to the login page. Note: The route must include the corresponding team app_id; otherwise, the system defaults to the default team login.