Graphic

The Symbio-Graphic-Service combines a layouter and a renderer for the generation of BPMN and process flow graphics.
The Symbio-Graphic-Service is intended to be callable from Symbio.Manager as well as from any other application, that supports HTTP requests.
In order to support a wide range of requestors, the Symbio-Graphic-Service is designed to be as open as possible.
The Symbio-Graphic-Service expects the data to layout (and render) as a JSON (a.k.a. Request JSON, prowided through the HTTP request body) and the functionality of the Symbio-Graphic-Service can be controlled by the configurations section at the top of the Request JSON (see chapter "The Request JSON" below).

Endpoints

Currently the Symbio-Graphic-Service provides two endpoints:

GET or POST on CheckConnection with one parameter name or with a simple request JSON.
POST on CalculateLayout with a request JSON (see chapter The request JSON below).

Check the HTTP connection

Sample request 1: GET or POST on <base-url>:<port>/api/CheckConnection?name=Steffen
Sample request 2: GET or POST on <base-url>:<port>/api/CheckConnection with a body, containing a simple JSON like {"name": "Steffen"}
Sample result on success: Status: 200 (OK); Body: {\"date\":\" 09.01.2022 08:14:51\", \"greetings\":\"Hello, Steffen!\", \"system\":\"Microsoft Windows 10.0.19043\", \"platform\":\"Win32NT\", \"folder\":\"C:\\WINDOWS\", \"width\":\"64 bit\"}
Sample result on missing/wrong parameter name or body JSON: Status: 400 (Bad Request); Body: 09.01.2022 08:20:38: Please pass a name on the query string or in the request body!
Sample result on wrong <base-url> or <port>: Status: ECONNREFUSED

Calculate a layout

POST on <base-url>:<port>/api/CalculateLayout with a body, containing a request JSON (see chapter The request JSON below).
Sample result on success: Status: 200 (OK); Body: calculation type 'cxn' and result type 'esvg' (embedded enriched SVG) ```html

``` * Sample result on wrong body JSON property calculation: Status: 400 (Bad Request); Body: Currently the calculation type '' is not supported! * Sample result on wrong body JSON property result: Status: 400 (Bad Request); Body: Currently the result type '' is not supported for calculation type 'cxn'! * Sample result on wrong <base-url> or <port>: Status: ECONNREFUSED

The service expects the request as a JSON file and delivers the graphic as an HTML or SVG file.

The Request JSON

The request to calculate a layout (and render a graphic) is provided as a JSON (within the request body).
The currently suported calculation types are cxn (route for a single connection path from a source node to a target node) and flow (directed graph with any number of nodes and edges).
The currently suported result types are json (JSON, the recommended result type), ejson (JSON, enhanced with additional information), esvg (embedded SVG, enhanced with additional information), svg (embedded SVG, without additional information), sesvg (stand-alone SVG, enhanced with additional information) and ssvg (stand-alone SVG, without additional information).

For details (internal structure of the Request JSON) see Request JSON.

The result

According to the requested calculation type (cxn or flow) the result can be * the route for a single connection path or * the layout (and rendering) of a directed graph

The resulting connection path

The connection path represents a single route from a source node to a target node. This route hast at least a start point (2D coordinates) and an end point (2D coordinates) and can have up to four additional interpolation points (each with 2D coordinates). The sections of the path are always orthogonal (either exact vertical or exact horizontal).

The result graph

The layed out (and rendered) graphic (directed graph), that is returned as a result of the service request, may contain several nodes (similar/comparable to BPMN elements), that can be of type:

Activity: It is used to define an atomic or non-atomic piece of work within a business process. The graphical representation of an Activity can be bealized by:
Sub-Process and Call Activity as non-atomic pieces of work within a business process.
Task as atomic piece of work within a business process.
Event: It represents something that happens during the course of a business process. It affects the flow of the business process and usually has a cause or an impact and in general requires or allows for a reaction.
Gateway: It provides the graphical representation of execution semantics, used to control how pieces of work within a business process interact as they converge and diverge within a business process.
Pool: It provides the graphical representation of participants (either a partner entity like a company, or a partner role like a buyer, a seller, or a manufacturer) in a collaboration. A Pool may or may not reference a business process - it can also serve as a black box.
Lane: It is a sub-partition within a business process (often within a Pool) and will extend the entire length of the business process. A Lane is used to organize and categorize Activities within a Pool. The meaning of the Lane is up to the modeler.

Graphic

Table of contents

Endpoints

Check the HTTP connection

Calculate a layout

The Request JSON

The result

The resulting connection path

The result graph

BPMN sub-process and call activity

BPMN tasks

BPMN events

BPMN gateways

BPMN pools and lanes