Skip to main content

Business Process Tools

Version: 1.0
Last Updated: February 2025


Overview

Business Process tools provide read access to FlowOn BPM processes and their versions. Business Processes define structured, multi-stage workflows attached to Dynamics 365 entities—governing how records move through a lifecycle, what logic executes at each stage, and what conditions must be met for a transition to occur.

Business Processes are versioned. At any point in time a process may have:

  • An active version — the currently published, executing version
  • A draft version — a work-in-progress version being designed for the next release
┌─────────────────────────────────────────────────────────────────────┐
│ BUSINESS PROCESS VERSIONING │
├─────────────────────────────────────────────────────────────────────┤
│ │
│ Business Process: "OrderApproval" │
│ ────────────────────────────────── │
│ │
│ ┌──────────────────────┐ ┌──────────────────────┐ │
│ │ Active Version │ │ Draft Version │ │
│ │ v2.1 │ │ v2.2 │ │
│ ├──────────────────────┤ ├──────────────────────┤ │
│ │ Currently executing │ │ Under development │ │
│ │ for all records │ │ Not yet published │ │
│ └──────────────────────┘ └──────────────────────┘ │
│ │
│ Use get_business_process_ Use get_business_process_ │
│ active_version_details draft_version_details │
│ │
└─────────────────────────────────────────────────────────────────────┘

Requirement: Business Process tools require the FlowOn BPM product to be installed and licensed in the connected environment.


list_business_processes

Lists all FlowOn Business Processes in the environment with pagination support.

ParameterTypeRequiredDescription
pageNumberintThe page to retrieve (default: 1)
pagingCookiestringThe paging cookie from the previous page response

Returns: A paginated list of Business Processes including:

FieldDescription
businessProcessNameThe name of the process
projectNameThe project it belongs to
entityLogicalNameThe Dynamics 365 entity this process is attached to
activeVersionIdThe ID of the currently active version (if one exists)

See Pagination for details on iterating through large result sets.


get_business_process_active_version_details

Retrieves the complete definition of the active (published) version of a Business Process.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the Business Process
projectNamestringThe project the Business Process belongs to

Returns: Full version details including all stages, transitions, logic blocks, and logic flows referenced by the active version.

Error cases:

ConditionError
Business Process not foundMcpException: process not found in project
No active version existsMcpException: process does not have an active version

Use when: You need to understand what logic is currently executing in production for a given Business Process.


get_business_process_draft_version_details

Retrieves the complete definition of the draft (unpublished) version of a Business Process.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the Business Process
projectNamestringThe project the Business Process belongs to

Returns: Full version details for the current draft, including all stages and transitions under development.

Error cases:

ConditionError
Business Process not foundMcpException: process not found in project
No draft version existsMcpException: draft version not found

Use when: You need to inspect a Business Process that is currently being designed or modified but has not yet been activated.