What This Screen Does
This is your central hub for viewing all workflows in the system. Think of it like a task board that shows every automated process that has been set up — whether it is still running, waiting, or already finished. You can search for specific workflows, filter them by status, and click on any one to see its detailed step-by-step progress.
How to Get There
Open the dashboard.
In the left-hand menu, click Workflow.
You are now on the Workflow List screen.
Step-by-Step Guide
1. View the Workflow Table
When the page loads, you will see a table listing all workflows for your currently selected gym/location.
Each row in the table shows:
Column | What It Shows |
Name | The workflow’s name and a short description underneath it. |
Created date | The date and time the workflow was created. |
Status | A colored label showing the current state of the workflow (see section 2 below). |
The table is sorted by Created date (newest first) by default.
Click any column header to sort by that column. Click again to reverse the sort order (ascending / descending).
2. Understand Workflow Statuses
Each workflow has a status label with a color to help you spot its state at a glance:
Status | Color | Meaning |
Ready | Grey | The workflow has been created but has not started processing yet. |
Processing | Blue | The workflow is currently running through its steps. |
Waiting | Light blue | The workflow is paused, waiting for a delay or external event. |
Complete | Green | The workflow has finished all its steps successfully. |
Error | Red | Something went wrong. Hover over the label to see the error message. |
3. Filter by Status
At the top of the table you will see three tabs: All, Active, and Completed.
Each tab shows a count badge so you know how many workflows are in each category.
Tab | What It Shows |
All | Every workflow regardless of status. |
Active | Only workflows that are currently in progress (Ready, Processing, or Waiting). |
Completed | Only workflows that have finished running. |
Click a tab to filter the list. The table updates immediately.
4. Search for a Workflow
Above the table there is a Search field.
Start typing a workflow name and the table will filter to show only matching results.
To clear the search, delete the text in the search field or use the filter chips (see step 5).
5. View and Clear Active Filters
When you have a search term or a status filter other than “All” active, a filter summary bar appears below the search field.
It shows how many results were found and displays chips for each active filter.
Click the X on a chip to remove that specific filter.
Click the Clear button (with the trash icon) to remove all filters at once and return to the default view.
6. Change Pagination Settings
At the bottom of the table you will find pagination controls.
Control | What It Does |
Rows per page | Choose how many workflows to show per page (e.g. 5, 10, 25). |
Page arrows | Navigate between pages of results. |
Dense toggle | Switch between a compact (dense) view and a more spacious layout. |
7. View a Workflow’s Details
Click on any row in the table.
A Workflow Overview dialog will open showing:
The workflow’s name as the dialog title.
An error alert at the top if the workflow encountered a problem.
A step-by-step stepper showing each stage of the workflow:
Steps that have been triggered show the date and time they ran.
Steps with a delay show a chip indicating the wait time (e.g. “2 Days” or “08:30”).
The stepper highlights the current step and marks completed steps.
Steps that failed are shown with an error indicator.
Close the dialog by clicking outside of it or pressing the Escape key.
What Happens Behind the Scenes
You open the Workflow List page
|
v
URL query parameters are read (page, rowsPerPage, orderBy, order, status, search)
|
v
API call: getWorkflows({ pageSize, pageNumber, sortBy, direction, isActive, search })
|
v
Server returns the list of workflows, total count, and status statistics
|
v
Table renders with data; tabs show counts for All / Active / Completed
|
v
You change a filter, sort, or page
|
v
URL query parameters are updated (so you can bookmark or share the current view)
|
v
API call: getWorkflows({ ...updated parameters })
|
v
Table refreshes with new results
You click a workflow row
|
v
Workflow ID is stored and the detail dialog opens
|
v
API call: getWorkflow({ workflowId })
|
v
Server returns the full workflow with all steps, delays, and timestamps
|
v
Dialog displays the stepper with step status, trigger times, and delays
Troubleshooting
“The table is empty and I do not see any workflows”
Make sure you have the correct gym/location selected in the dashboard header. Workflows are tied to a specific gym, so switching locations changes what you see.
Check the status tab — you might be on “Completed” when all your workflows are still active, or vice versa.
Clear any text in the Search field. A search that matches nothing will show an empty table.
“I changed the gym but the list did not update”
The list should refresh automatically when you switch gyms. If it does not, try refreshing the page in your browser.
Check your internet connection — the page needs to reach the server to load new data.
“I cannot find a specific workflow”
Use the Search field and type part of the workflow name.
Make sure you are on the All tab so no status filter is hiding it.
The search matches by name only. If you are searching by description or date, you will need to scroll through the list manually.
“The status label is red and says there is an error”
Hover over the red status label to see the error message in a tooltip.
Click the row to open the Workflow Overview dialog for more details — the error message will appear in a red alert banner at the top.
Common causes include misconfigured workflow steps, missing data, or a temporary server issue. Contact your administrator if the error is unclear.
“The workflow dialog opened but it looks empty or is still loading”
The dialog fetches the workflow details from the server when it opens. If your connection is slow, wait a few seconds.
If it stays empty, close the dialog, refresh the page, and try clicking the row again.
If the problem persists, the workflow data may be corrupted — contact your administrator.
“My sort order or filters reset when I leave and come back”
The page saves your current filters, sort order, and pagination in the URL (as query parameters). If you use the browser’s back button or navigate away, the URL may not be preserved.
Tip: Bookmark the page after setting your preferred filters. The URL contains all your settings and will restore them when you return.
“I see a workflow stuck in ‘Processing’ for a long time”
Some workflows have built-in delays between steps (shown as a time chip in the detail dialog). The workflow may be waiting for a scheduled delay to pass.
If there is no delay and it has been stuck for an unusually long time, the workflow may have encountered a silent error. Contact your administrator to investigate.
“The page numbers seem wrong or I see blank rows”
This can happen if workflows were deleted or completed while you were viewing the list. Click refresh in your browser or change the page to force the table to reload.
If the row count at the bottom does not match what you see, navigating to another page and back will correct it.
