Process status change

To change the status of one or more processes manually, a central function for changing the status is available in the process action menu.

The user should first select the process/processes whose status they want to change (with a single mouse click). Right-click to open the context menu, which contains the "Actions" button. The "Change status" button can be seen in the submenu (see screenshot).

After clicking on this menu item, a new window for editing the status of the previously selected processes opens. The processes for which a status change is to be carried out manually are listed with their process ID.

The user can now specify the new status for the selected processes via pull-down menus.
It is also possible to enter the necessary information on the status change as a comment in the field for remarks, notes or similar.
The status change must be carried out with the process engine used (e.g. IGUASU). IGUASU or INUBIT).

Access rights

For a user to be able to use process status changes, they need the right bpcmonitor_changeprocessstate.

To give a user the right for selected components, they need specified rights with the ID of the component: bpcmonitor_changeprocessstate_{MONITORID}.

If the system that processes the status change is accessed via a Backend Connection, the right loadModule_backendconnection is required for all users of the function.

General setting

The following settings are made for each monitor:

Active: (function_changeState)
(boolean; default: true)
Enables the use of the manual status change function.
Endpoint or processor: (changeStateEndpointProcessor)
(string; default: "")
Selection of the REST endpoint (Backend Connection) or processor (Flow) for executing a process status change.
Settings (function_changeStateConfig)
(json)
Settings of the function parameters for the status change See Configuration.

Default:

[
    {
        "dataIndex": "STATUS",
        "useDistinctValues": true
    }
]

Configuration

This section describes the options for configuring the process status changes.

Syntax

dataIndex
(string)
The dataIndex of the column in which the status is to be changed.
useDistinctValues
(boolean, default: true)
If true, all different values from the column are automatically offered as selection options. If false, the selection options can be defined via the states attribute.
states
(array)
Defines the selection options for the new status (only used if useDistinctValues and useRendererValues are false). Each element in the array is an object with the following attributes:
- settable
  (boolean, default: true)
  Specifies whether the status is offered as a selection option.
- state
  (string)
  The value that is set as the new status.

Example

{
    "dataIndex": "STATUS",
    "states": [
        {
            "state": "Offen"
        },
        {
            "state": "In Arbeit"
        },
        {
            "state": "Archiviert",
            "settable": false
        }
    ],
    "useDistinctValues": false
}

useRendererValue
(boolean, default: false)
If true, the rendered values of the column are used (instead of the raw values).
preselectState
(string)
Enables the preselection of a specific status in the selection menu.
"preselectState": "<Suchwert>": Selects the first entry that contains the specified text (case-sensitive). Both raw values and display names (from Custom Renderer) can be used.
"preselectState": "_first": Always selects the first available value from the dropdown.
metadata
(object)
Additional metadata that is passed to the endpoint or processor to add additional configuration values or context information.

Expected return format

The client expects a JSON response from the server.

It should be ensured that the Content-Type header is set accordingly in order to correctly transmit the data format to the client:

JSON responses require Content-Type: application/json.

Response to sending the process

Example error

{
    "success": "false",
    "msg": "Fehlermeldung"
}

Example OK

{
    "success": "true",
    "msg": "Status wurde erfolgreich geändert"
}

OpenAPI specification

A detailed description of all endpoints can be found in our OpenAPI Specification.

Keywords: