Business Process Tools
Overview
Business Process tools manage Logic Process Orchestrator business processes and their versioned definitions in Logic Assist. Each business process maintains a draft version under development and an active version that is currently executing, and moves through a draft → publish → activate lifecycle: you edit the draft, publish it, and then activate the resulting version to make it live.
Requirement: These tools require the Logic Process Orchestrator product to be installed and licensed in the connected environment.
search_business_processes
Searches Logic Fabric business processes by name.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessName | string | ✓ | The name of the business process to search for. |
Returns: Matching business processes including name, title, description, and project.
create_business_process
Creates a new Logic Fabric business process.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | ✓ | The ID of the project to which the business process belongs. |
businessProcessName | string | ✓ | The name of the new business process. |
entityLogicalName | string | ✓ | The logical name of the business process entity. |
isAction | bool | ✓ | Indicates whether the business process is exposed as an action. |
enableTracing | bool | ✓ | Indicates whether tracing is enabled for the business process. |
title | string | ✓ | The title of the business process. |
description | string | ✓ | The description of the business process. |
Returns: The GUID of the newly created business process.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
list_business_processes
Lists Logic Fabric business processes.
| Parameter | Type | Required | Description |
|---|---|---|---|
projectId | GUID | The ID of the project to filter business processes by. Optional. | |
pageNumber | int | The page number for pagination. If not provided, defaults to the first page. Optional. | |
pagingCookie | string | The 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 name, title, description, and project.
See Pagination for details on iterating through large result sets.
list_business_process_versions
Lists Logic Fabric business process versions.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessId | GUID | ✓ | The ID of the business process. |
pageNumber | int | The page number for pagination. If not provided, defaults to the first page. Optional. | |
pagingCookie | string | The 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.
See Pagination for details on iterating through large result sets.
get_business_process_active_version_details
Gets the details for a Logic Fabric business process active version.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessId | GUID | ✓ | The ID of the business process. |
Returns: Full version details including all stages, transitions, logic blocks, and logic flows referenced by the active version.
get_business_process_draft_version_details
Gets the details for a Logic Fabric business process draft version.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessId | GUID | ✓ | The ID of the business process. |
Returns: Full version details for the current draft, including all stages and transitions under development.
update_business_process_draft_version
Updates the draft version for a Logic Fabric business process.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessId | GUID | ✓ | The ID of the business process. |
metadata | string | ✓ | The metadata for the draft version in JSON format. |
Returns: Confirmation that the draft version metadata was updated.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
Best practice: Always call get_business_process_draft_version_details first to read the current draft metadata before updating, to avoid unintentionally overwriting parts of the definition you did not intend to change.
publish_business_process_draft_version
Publishes the draft version for a Logic Fabric business process.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessId | GUID | ✓ | The ID of the business process to publish. |
activate | bool | ✓ | Whether to activate the draft version after publishing. |
Returns: The published version number as a string.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.
activate_business_process_version
Activates a specific version of a Logic Fabric business process.
| Parameter | Type | Required | Description |
|---|---|---|---|
businessProcessVersionId | GUID | ✓ | The unique identifier of the business process version to activate. |
Returns: Confirmation that the specified version has been activated.
Restriction: Cannot be called on projects associated with a managed solution. See Managed Solution Protection.