Skip to main content

Business Process Tools


Overview

Business Process tools provide full lifecycle management for Process Orchestrator processes and their versions. Business Processes define structured, multi-stage workflows attached to Dataverse 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 Process Orchestrator product to be installed and licensed in the connected environment.


create_business_process

Creates a New Flowon business process.

ParameterTypeRequiredDescription
projectNamestringThe name of the project to which the business process belongs to.
businessProcessNamestringThe name of the new business process.
entityLogicalNamestringThe logical name of the business process entity.
isActionboolIndicates whether the business process is exposed as action.
enableTracingboolIndicates whether the business process is exposed as action.
titlestringThe title of the business process.
descriptionstringThe description of the business process.

Returns: The GUID of the newly created Business Process.


list_business_processes

Lists Flowon business processes.

ParameterTypeRequiredDescription
pageNumberintThe page number for pagination. If not provided, defaults to the first page. Optional.
pagingCookiestringThe paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional.

Returns: A paginated list of Business Processes including:

FieldDescription
businessProcessNameThe name of the process
projectNameThe project it belongs to
entityLogicalNameThe Dataverse entity this process is attached to
activeVersionIdThe ID of the currently active version (if one exists)
isActionWhether the process is exposed as an action
enableTracingWhether tracing is enabled
titleDisplay title
descriptionDescription

See Pagination for details on iterating through large result sets.


list_business_process_versions

Lists Flowon business process versions.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the business process.
projectNamestringThe name of the project the business process belongs to.
pageNumberintThe page number for pagination. If not provided, defaults to the first page. Optional.
pagingCookiestringThe paging cookie for pagination. This should be provided if pageNumber is provided and there are more records to retrieve. Optional.

Returns: A paginated list of all versions for the specified Business Process, each including version number, ID, and metadata.


get_business_process_active_version_details

Gets the details for a Flowon business process active version.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the business process.
projectNamestringThe name of the 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

Gets the details for a Flowon business process draft version.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the business process.
projectNamestringThe name of the 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.


update_business_process_draft_version

Updates the draft version for a Flowon business process.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the business process.
projectNamestringThe name of the project the business process belongs to.
metadatastringThe metadata for the draft version in JSON format.

Returns: Confirmation that the draft version metadata was updated.

Error cases:

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

publish_business_process_draft_version

Publishes the draft version for a Flowon business process.

ParameterTypeRequiredDescription
businessProcessNamestringThe name of the business process to publish.
projectNamestringThe name of the project the business process belongs to.
activateboolWhether to activate the draft version after publishing.

Returns: The published version number as a string.

Error cases:

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

activate_business_process_version

Activates a specific version of a Flowon business process.

ParameterTypeRequiredDescription
businessProcessVersionIdGUIDThe unique identifier of the business process version to activate.

Returns: Confirmation that the specified version has been activated.

Error cases:

ConditionError
Version not foundMcpException: business process version not found