BPMN Panel API / Panel Types / BpmnContextualLinkEndpoint

Type Alias: BpmnContextualLinkEndpoint

type BpmnContextualLinkEndpoint = {
  getGraphContextLink: {
     linkName: string;
     reverse?: boolean;
  };
};

Defined in: features/panels/variants/bpmn/types/panel/graph/toolbar/toolbar-item.ts:79

Resolves the contextual Link whose linked Object is represented by the visual BPMN endpoint.

Unlike BpmnEventEdgeEndpoint, this strategy does not require the user to select the linked row. The BPMN panel requests the matching Link from the one current Object supplied to the graph request. linkName identifies the technical Link type and reverse declares its direction.

Place this endpoint under request.source or request.target in a toolbar connector request. Replace <newConnectorLinkType> with the new connector type and <existingContextLinkType> with the existing Link type whose GUID the endpoint must store. See the complete English configuration or its Russian counterpart.

Example

Connector request with a contextual source

{
  "request": {
    "linkName": "<newConnectorLinkType>",
    "source": {
      "getGraphContextLink": {
        "linkName": "<existingContextLinkType>",
        "reverse": false
      }
    }
  }
}

Properties

Property	Type	Description
getGraphContextLink	{ linkName: string; reverse?: boolean; }	‐
getGraphContextLink.linkName	string	Technical Link type connecting the current graph-request Object and the Object represented by the visual endpoint.
getGraphContextLink.reverse?	boolean	Whether the Link points from the represented Object to the current graph-request Object.