@orion-front/docs

Appearance

BPMN Panel API / Shared Types

Shared Types ​

Description ​

Common type definitions shared across BPMN panel components.

Type Aliases ​

Type AliasDescription

MethodRunObject

Configuration for running a custom backend method via /MetaMethods/Run endpoint.

Used in entity creation to execute custom backend logic instead of standard object/link creation endpoints. When configured in EditorType.runMethod, form field values are automatically merged with pre-configured params.

Examples

Basic Object Creation

typescript
{
  parent: "WorkOrder",
  method: "CreateWithValidation",
  objects: [],
  params: {}
}

With Pre-configured Parameters

typescript
{
  parent: "WFEntityInstance",
  method: "createWorkflowInstance",
  objects: [],
  params: {
    workflowType: "production",
    autoStart: true
  }
}

When form has fields name and priority, the final request merges:

  • Pre-configured params: workflowType, autoStart
  • Form field values: name, priority

Event-based Object Selection

typescript
{
  parent: "WFEntityInstance",
  method: "getWorkFlowGraphState",
  objects: [],
  params: {
    getSelectedObjectForEventId: "workorder--on-object-select--link-table"
  }
}

The selected object's GUID will be retrieved using the event ID, enabling context-aware object creation across panels.

Link Creation with Custom Method

typescript
{
  parent: "ProductSupplier",
  method: "CreateLinkWithBusinessRules",
  objects: ["product-guid", "supplier-guid"],
  params: {
    sourceGuid: "product-guid",
    targetGuid: "supplier-guid",
    linkName: "ProductSupplier"
  }
}

Pre-configured objects are merged with resolved source/target GUIDs.

KeyValue

Key-value pair for displaying a field.

EditorType

‐