Workflow

Many of you will already have experience in dealing with profiles and will appreciate the advantages of this simple form of data processing. However, these days more and more business areas are being incorporated into the digital sphere. On the one hand, of course, this is an advantage because it offers opportunities to increase efficiency. On the other hand, it also increases the complexity of the processes that you have to model digitally. To accompany you on this journey and make it as simple as usual, we offer a further abstraction level of data processing with the add-on module Workflow. With this module, you can graphically model complex digital processes (without necessarily knowing technical details) and then fill them with technical life afterwards. These two steps can be performed by different people, providing a communication tool between your business departments and IT. This allows you to make existing processes clearer, but of course also to design new processes in a simple way, whereby you can easily integrate already existing and proven profiles, for example, but also more.

Abstract view


What is a workflow? You can certainly dive deep into theories and definitions here, but we will try to look at the topic as simply as possible from the application perspective. A workflow simply describes a chronological sequence of steps that, taken together, describing an overall process. We call those steps actions.



images/download/attachments/137302608/1-version-1-modificationdate-1732860165976-api-v2.png


In real life, however, it is not always that simple. Often you have several possibilities for the next action. This can generally depend on the state of the system in which you are operating, or simply on how the previous action played out. So we need a way to control the sequence of actions in a net of possible actions.

See sections Workflow designer and Automated workflows (examples).



images/download/attachments/137302608/2-version-1-modificationdate-1732860165978-api-v2.png


We call this additional component a state. This state is reached when the action before it is completed. In the simplest variant, this state then only decides which action will be executed next.

Ideally, you can run through your workflow automatically until it is completed. However, it is often necessary or desirable for manual intervention to take place at a certain point in the workflow. For this purpose, there is another variant that allows human interaction via forms. A user enters data and/or sets options and, based on these entries, either the next action is selected automatically or the user selects the next action manually.

See sections Workflow designer and Interactive workflows (examples).



images/download/attachments/137302608/3-version-1-modificationdate-1732860165980-api-v2.png


Of course, both variants can also be mixed. That is, your workflow has fully automated sections and then sections that require manual interaction by a user. We call such workflows hybrid .

In addition, you can create two variants for any state. One that can be run through automatically and one that forces human interaction in case of error or doubt or by design. This way, semi-automated workflows can step by step be converted into more or fully automated workflows if you manage to make the automated variant of a state stable enough so that human interaction is no longer necessary.

See sections Workflow designer and Hybrid workflows (examples).



images/download/attachments/137302608/4-version-1-modificationdate-1732860165983-api-v2.png


For advanced users, we recommend sections Cyclical Workflows, Sub Workflows and Profiles as Workflow Master.

User rights/permissions


To be able to work with the Workflow module as a Lobster Integration user, the user right "Workflow" or "Workflow administration" has to be set.

To be able to work with the Workflow module as a DataCockpit user, the permission "May see workflow" has to be set.

Workflow overview and creating workflows


See sections Workflow overview and Creating and editing workflows.

Workflow jobs and workflow logs


See section Workflow jobs and logs.

Workflow files


You can assign files to a workflow job. Details can be found in section Workflow files.

Workflow functions and REST

A number of special workflow functions are available. These allow the manipulation of workflows, e.g. from profiles.

In addition, workflows can be controlled via REST (HTTP).

Direct links to active workflow jobs


In open forms of active workflow jobs, you get a link (bottom left) to this form. The structure of the link is as follows, e.g. to send it by email within profiles or workflows. Note: See system workflow variable VAR_SYS_WF_ID .

_data

http(s)://<IP or URL of Integration Server>:9000/_data/cc.jobs.workflow/form:<Workflow ID>

DataCockpit

http(s)://<IP or URL of Integration Server>:9000/DataCockpit/workflows?id=<Workflow ID>

Profile error handling, Content Inspection and Response

A workflow can be started via the error handling of a profile.

The add-on module Content Inspection can send files to workflows.

A workflow can be started with the Response classes WorkflowResponse and WorkflowResponseWithoutAttachment.

DataCockpit


Workflows can also be used in the add-on module DataCockpit.

Why DataCockpit?

DataCockpit has the great advantage that you can give certain persons a very simplified view of your workflows. Only workflows that this person is allowed to start or that are in a state that has a form intended for this person are displayed. No access or view of the entire workflow is allowed, only what is necessary for certain work steps is made available. Also, no workflow jobs can be cancelled unless this option is explicitly enabled in the design of the workflow. In addition, the complete system behind it and the workflow framework are hidden. This creates clarity, prevents unnecessary confusion and ensures security. An optimal processing tool for your employees or externals agents. Your integrated and automatic dispatcher.