PlentyONE Flow Tracker

Disclaimer

The full name of the tool is PlentyONE Flow Tracker. For simplicity’s sake, the tool is also referred to as Flow Tracker throughout this manual.

In PlentyONE Flow Tracker (hereinafter also referred to as Flow Tracker), you monitor and manage flow runs.

Each instance in which a flow is executed is referred to as a flow run.

You create the corresponding Flows in the tool Flow Studio.

1. The Flow Tracker overview

To access Flow Tracker, open the menu Automation » Flow Tracker. The following overview of flow runs in progress appears:

Automation Flow tracker overview
2. Toolbar: Explanation of the blue-highlighted area

The following functions are available in the toolbar of the Tracker overview:

  • Configuring the columns in the main window (settings)

  • Searching for a Flow and displaying it in the overview (search)

  • Setting filters for the search (bookmarks)

  • Saving and applying filters (bookmarks)

3. Main window: Explanation of the red-highlighted area

When the overview (manage_search) is selected in the navigation and you perform a search (search), you will see the list of found flows runs in the main window.

  • Use the context menu (more_vert on the right of a flow run row) to end a flow run or run it again. You can also use it to open the respective flow in Flow Studio.

  • Use Select all (material:check_box_outline_blank in the top row) to select all found flow runs, and Select flow (check_box_outline_blank in the respective flow row) to select individual flow runs.

2. The canvas view in Flow Tracker

The canvas view appears after you open one of the flow runs listed in the Flow Tracker overview. It is structured as follows:

Automation Flow tracker canvas
1. Navigation: Explanation of the yellow-highlighted area

Here, you navigate between the flow run overviews (manage_search) and the individual flow runs (description): The currently selected area (highlighted in grey) is displayed in the main window on the right. Click on menu to expand or collapse the navigation bar.

2. Toolbar: Explanation of the blue-highlighted area

The following functions are available in the toolbar of the Tracker canvas view:

  • Zoom in/out on the canvas (zoom_in and zoom_out)

  • Centre canvas (filter_center_focus)

  • Restart run (repeat)

  • Go to Flow Studio (edit)

  • Refresh data (*)

  • Messages about any manual steps required to continue the flow run
    Note: On the canvas, flow steps requiring manual input are marked with an orange bar.

3. Canvas: Explanation of the red-highlighted area

When a flow run is selected in the navigation, the steps of that flow run are displayed on the canvas.

The following elements can appear on the canvas:

4. Configuration: Explanation of the yellow-highlighted area

Click on a specific flow step, and the input fields and configuration details for the step will appear in this column.

  • The name of the flow step

  • Various information types, accessible through the tabs in the scroll bar. These are as follows:

Tab Explanation

Status

  • The status of the flow step (Green: Completed; Blue: Pending; Orange: Waiting for user input; Red: Error).

  • The step’s progress, displayed as a number of completed steps.
    *_Note: Many actions consist of only one step, so this field usually displays 1/0 or 0/1. Click on the trigger at the top to view the progress of the entire flow run here.

  • The duration of the flow step.

  • The starting time of the flow step.

  • The end time of the flow step.

  • An input field with a message (only for steps that require manual input).

Outputs

  • Information about the orders that have flowed out of the selected flow step.
    Note: This tab appears appears only for actions and controls, not for triggers.

Inputs

  • Information about the orders that have flowed out of the selected flow step.
    Note: This tab appears appears only for actions and controls, not for triggers.

Configuration

Information on the configuration of the selected flow step.

3. Instructions for the functions in the overview and canvas view of the Flow Tracker.

In this section, you will find instructions for the functions outlined in Section 1 and Section 2.

3.1. Configuring the columns in the Flow Tracker overview

In all three overviews in Flow Tracker, you can determine which columns are displayed and in what order.

Configuring columns in an overview

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select an overview.

  3. At the top right, click on Configure columns (settings).
    → The Column configuration window will open.

  4. Select (check_box) the columns to be displayed. Refer to the Explanations of the columns in the Flow Tracker overviews for more details.

  5. Move (drag_indicator) the columns via drag-and-drop to the desired position until they are displayed in the desired order.

  6. Add (check_box) or remove (check_box_outline_blank) columns as needed.

  7. Click on Confirm.
    → The settings are saved.

Explanations of the columns in the Flow Tracker overviews
Column Explanation

Columns in the overviews Flow runs in progress (hourglass_bottom) and Finished flow runs (flaky):

Selection

Enables the selection of individual or multiple Flows.

Status

Displays the status of the flow run
(Possible status: Green: Finished; Blue: Pending; Orange: Waiting for user input; Red: Error).

Name

Displays the name of the flow run

Trigger type

Displays the trigger type of the flow run
(Possible trigger types: Event-based, time-based, manual).

Object type

Displays the object type.
(Possible flow types: Order).

Starting time

Displays the date and time at which the flow run started.

Run time

Displays the duration of the flow run.

Actions

Displays the context menu (more_vert), behind which a selection of steps for the flow-run can be found.

Flow value

For flow runs that process one order at a time (stream processing, as in event-based flows), this displays the identifying value of the order processed by the flow run. For orders, the flow value is the order ID.

*Note:*Clicking on the flow value opens the respective order in the order UI (in a new tab).

Columns in the overview Scheduled flow runs (schedule):

Status

Displays the status of the flow run (Possible statuses: Green: Finished; Blue: Pending; Orange: Waiting for user input; Red: Error).

Name

Displays the name of the flow run

Frequency

Displays the frequency with which the flow runs occur (for time-based flow runs only), e.g. Hourly.

Recurrence:*

Displays the intervals at which the flow runs occur (for time-based flow runs only), e.g. Every 4 hours.

Next run

Displays the date and time at which the next flow run will take place.

Last run

Displays the date and time of the last flow run.

Actions

Displays the context menu (more_vert), behind which a selection of steps for the flow-run can be found.

3.2. Search for flow run

Use the search in Flow Tracker to list all existing flow runs or search for specific flow runs using keywords or filter settings.

Search for flow run:

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select an overview.

    1. Option 1: Click on search to see a list of all flow runs.

    2. Option 2: Enter a search term into the search field and click on search to list all flow runs containing the search term in their name.

    3. Option 3: Click on tune to narrow down the search results with filters. Refer to the Explanations of the filters in the Flow Tracker overviews for more details.

3.3. Saving the current filter

If you have using filter settings or a search term to narrowed down a search in a flow tracker overview, you can save the search settings you used and create your own reusable filter. This way, you can perform the same search quickly and easily in future.

Saving the current filter:

  1. Adjust the settings accordingly and click on Search (search).

  2. Click on Saved filters (bookmarks).

  3. Click on bookmark_border Save current filter.

  4. Enter a name and toggle the optional settings as needed (toggle_on).

  5. Click on Save.
    → The new custom filter now appears under Saved filters. (bookmarks).

3.4. Applying saved filters

  1. Click on Saved filters (bookmarks).

  2. Click one of the custom filters saved.
    → The search results appear and the filter settings are displayed in the top section of the overview as chips.

3.5. Stop a flow run in progress

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select an overview.

  3. Carry out a search (search) to display flow runs.

  4. Click on the context menu (more_vert) in the row of the flow run you want to end.

  5. Click on Stop flow run.
    → The flow run is stopped.

Restart a flow run in progress or a finished flow run

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select Flow run in progress (hourglass_bottom) or a Finished flow run (flaky).

  3. Carry out a search (search) to display flow runs.

  4. Click on the context menu (more_vert) in the row of the flow run you want to restart. (more_vert).

  5. Click on Restart run (repeat).
    → The flow run restarts.

3.6. Pause scheduled flow runs

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select Scheduled flow runs (schedule).

  3. Carry out a search (search) to display flow runs.

  4. Click on the context menu (more_vert) in the row of the flow run you want to pause. (pause).

  5. Click on Pause run.
    → The flow run is paused.

3.7. Start a scheduled flow run manually

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select Scheduled flow runs (schedule).

  3. Carry out a search (search) to display flow runs.

  4. Click on the context menu (more_vert) in the row of the flow run you want to manually start. (play_circle).

  5. Click on Start flow run.
    → The flow run starts.

3.8. Switch to Flow Studio

From a flow run in Flow Tracker, you can switch directly to the corresponding flow in Flow Studio.

Switch to Flow Studio:

  1. Go to Automation » Flow Tracker.

  2. In the Flow Tracker navigation, select an overview.

  3. Carry out a search (search) to display flow runs.

    1. Alternative 1:

      1. Click on the context menu (more_vert) on the far right side of the flow run.

      2. Click on Go to Flow Studio.

    2. Alternative 2:

      1. Open a flow run in the overview Flow runs in progress ( (hourglass_bottom) or

        • Finished flow runs (flaky).

      2. In the toolbar of the canvas view, click on Edit in Flow Studio (edit).
        → The corresponding Flow opens in Flow Studio.
        Note: If you use the Edit in Flow Studio function, Flow Studio opens in a new tab.