Introduction

Welcome to the BizFlowsEngine documentation. This is your complete guide to building, managing, and scaling your business workflows with our platform.

🔗 Integration Options — BizFlowEngine

BizFlowEngine supports multiple integration methods to connect with external systems, internal modules, and databases. These integrations enable seamless data exchange, workflow automation, and system interoperability.

🧩 Types of Integration

1. Integration with Other Systems via Code

  • BizFlowEngine provides a .NET Core–based API controller.
  • When a request is authorized, it automatically sends UI data to a specified controller and action.
  • Developers map the incoming data to:
    • Perform CRUD operations in external databases
    • Call third-party APIs

🔧 Setup in UI Design:

  • Open UI in Edit Mode
  • Go to Integration Parameters
  • Define:
    • Controller Name
    • Action Name

These must match the controller and action in your API code.

🧱 Developer Tasks:

  • Create a response object
  • Use transaction scope to handle Create/Edit logic
  • Map BizFlowEngine request data to external system
  • Return a structured response

2. Integration Within BizFlowEngine

  • Link UIs internally (e.g., Public Facing UI → Back Office UI)
  • Useful for multi-step flows across different user roles
  • Covered in detail in the Public Facing Interfaces section

3. Integrate External Systems Using BizFlowEngine Workflow

  • External systems can trigger BizFlowEngine workflows via API
  • After authorization, BizFlowEngine sends status updates back to the external system

🔧 Setup Steps:

  1. Design a UI and configure its workflow and alerts
  2. Enable API integration:
    • Edit UI → Builtin Integration Parameters → Check API Integration Allowed
  3. Get request payload:
    • Open UI in Display Mode
    • Scroll to Builtin Integration Parameters
    • Click Get Request JSON for External Integration

📤 API Payload Requirements:

  • IntUsername
  • IntPassword
  • Values for all required UI objects

📥 Fetching UI Data via API:

  • Another API method allows fetching data of any UI record
  • Required fields:
    • IntUsername
    • IntPassword
    • MenuID
    • XID

4. Direct External Database Access

  • Configure System Fields to fetch live data from external databases
  • Supported connections:
    • 2 MySQL databases
    • 2 MSSQL databases
  • Additional providers can be added on request

See System Fields for detailed configuration steps.

✅ Summary

Integration Type Use Case
With Other Systems via Code Push data to external APIs or databases after authorization
Internal Integration Link UIs within BizFlowEngine (e.g., public to back office)
External Systems Using BizFlowEngine Workflow External systems trigger BizFlowEngine workflows and receive status
Direct External Database Access Fetch live data from external DBs using System Fields

© BizFlowEngine — Built to Connect, Designed to Scale