# Flow Module

This module enables the communication between the FLOW stream nodes and FLOW (Editshare).

The module is easy to set up and requires the following informations:

* IP address of the FLOW server / endpoint
* Username of the FLOW Admin user
* Password of the FLOW Admin user
* Flow Version

Helmut4 currently supports Flow v3 and 4.

Via the button "Test" the input can be checked for correctness by connecting to FLOW. If the connection is working, a respond will be shown.

Example Respond: ***OK - 7 objects have been found***

7 object is a reference to the users which have been found and can be imported via the [users tab](https://docs.helmut.de/helmut4-releases/v4.10.1/helmut4-components/users#import-users). 

<figure><img src="https://content.gitbook.com/content/ttnkf7qEIoqtmdv6485i/blobs/oml9h2oBTJ30s0rY1Rud/image.png" alt=""><figcaption><p>Flow Module</p></figcaption></figure>

If you are coming from an earlier Helmut4 release (4.0.7 and below), you might see these options in the Flow Version dropdown. To fix this issue, expand the guideline below.

<figure><img src="https://content.gitbook.com/content/ttnkf7qEIoqtmdv6485i/blobs/gj8JCp3fmfZ5hgnP9scV/image.png" alt="" width="375"><figcaption><p>Broken Flow Version dropdown</p></figcaption></figure>

<details>

<summary>Patch wrong Flow Version dropdown</summary>

The issue for the wrong format of the version is coming from a change, which has been introduced in Helmut 4.0.7.

\
To address this issue, a connection to the mongodb is required - if you need helpt to apply the changes, reach out to the support team.

### mcc\_preferences/preferenceDBO

Wrong / not working yaml-configuration

```yaml
{
    "_id": ObjectId("5e21eddba2d56a0001e52e43"),
    "name": "Flow Version",
    "type": "SELECT",
    "allowedValues": [
        "version3:Version 3",
        "version4:Version 4"
    ],
    "_public": true,
    "value": "version4",
    "key": "MODULE_FLOW_VERSION",
    "description": "Flow Version",
    "category": "Modules",
    "tags": [
        "FX",
        "IO",
        "CO",
        "HK"
    ],
    "_class": "preferences.model.PreferenceDBO"
}
```

#### Working yaml-configuration

```yaml
{
    "_id": ObjectId("5e21eddba2d56a0001e52e43"),
    "name": "Flow Version",
    "type": "SELECT",
    "allowedValues": [
        "version3:::Version 3",
        "version4:::Version 4"
    ],
    "_public": true,
    "value": "version4",
    "key": "MODULE_FLOW_VERSION",
    "description": "Flow Version",
    "category": "Modules",
    "tags": [
        "FX",
        "IO",
        "CO",
        "HK"
    ],
    "_class": "preferences.model.PreferenceDBO"
}
```

</details>