Flow Page – Complete Visual Explanation, Purpose, Process, and Internal Working
This document explains the Flow page in biz1 in full depth:
what it is, how the screen looks, what actions users perform, how data moves behind the scenes, and how it connects to other modules.
1. What the Flow Page Is (Conceptual View)
The Flow page is a customer journey board.
Think of it like this:
-
Each Flow = one business process
(for example: Sales pipeline, Loan processing, Hiring, Customer onboarding)
-
Each Column = one stage of that process
(for example: TO DO → TEST → PATIDAR → FINAL)
-
Each Card = one customer
(from thecontactustable)
The Flow page lets you:
-
See where every customer is right now
-
Move customers between stages using drag & drop
-
Filter customers by date, team, or name
-
Track progress visually instead of reading lists
2. How You Enter the Flow Page
You reach the Flow page when:
-
You click “Flow” in the left sidebar
-
The URL becomes:
-
dashboard/flow -
or
dashboard/admin/#customerwhen Flow is active
-
Access depends on:
-
Organization module: Customer Flow enabled
-
User permission:
module_sidebarmenu_flow
If the module or permission is disabled, the Flow menu is hidden.
3. Full Visual Description of the Screen
3.1 Top Header (Global)
At the very top, you see the standard biz1 header:
-
Main navigation (Customers, Projects, Products, Expenses, Articles, User, Advance)
-
User profile and notifications
-
Time clock / “Start Work”
This header is global and not specific to Flow logic.
3.2 Left Sidebar (Navigation)
-
Flow is highlighted when this page is active
-
Other sidebar items remain visible:
Customer, Missions, Calendar, Tickets, Email, WhatsApp, Files, Reports, etc.
The sidebar simply determines which module is active.
3.3 Left Panel – Flow Management Area
This panel controls which flow you are viewing.
You will see:
-
A title like “Flows”
-
A search input to filter flow names
-
Tabs such as:
-
Loans Customers
-
Job Openings
-
Workers
These tabs switch flow context/type, not customers themselves.
-
-
Informational text such as:
“Create your flow and monitor your progress” -
An Add Flow button
This opens a modal where you define a new flow.
This panel is only about:
-
Creating flows
-
Selecting flows
-
Switching between flow categories
3.4 Main Content Area – The Actual Flow Board
This is where most work happens.
At the top of the main area, you see:
-
Flow title (example: “Loans Customers”)
-
Export button
-
Import button
-
Add product / Add record
-
Help icon
-
Search input (searches customers, not flows)
-
Filters button
-
Field selector
-
Refresh button
-
Flow selector dropdown
-
Start Date / End Date filters
-
Team member filter
-
Info icon
Everything here controls what customers are shown and how.
4. The Heart of the Page: Columns and Cards
4.1 Columns
Each flow is divided into vertical columns.
Examples of column names:
-
TO DO
-
1
-
PATIDAR
-
TEST
-
HELLO_TEST
-
EMKKK
-
CXSDFC
Important points:
-
Columns are defined per flow
-
Each column has:
-
A name
-
A color underline
-
An order (left to right)
-
-
Column order matters and is configurable
When you switch flows, the entire column structure changes.
4.2 Customer Cards
Inside each column, you see customer cards.
Each card represents:
-
One row from
contactus -
Assigned to:
-
A specific flow
-
A specific column
-
Cards typically show:
-
Customer name
-
Basic identifiers
-
Action icons (call, message, open profile)
4.3 Drag and Drop Behavior
This is the most important interaction.
When you:
-
Click a customer card
-
Drag it to another column
-
Drop it
The system immediately:
-
Saves the new column
-
Saves who moved it
-
Saves the date and time
Visually:
-
The card jumps to the new column
-
No page reload is needed
Conceptually:
“This customer has moved to the next stage”
5. Alternative View: Table Mode
Some flows support or display a table layout .
In this mode:
-
Customers are shown in rows
-
Columns are fixed fields such as:
-
Client Name
-
ID
-
Team
-
Data Collection
-
Bank Data
-
Personal Data
-
Property Data
-
Documents
-
Deal
-
Final Step
-
Action icons
-
This view is useful for:
-
Data-heavy processes
-
Compliance workflows
-
Reporting scenarios
The same underlying data is used for both views.
6. Step-by-Step: What Happens When the Page Loads
-
User clicks Flow in the sidebar.
-
Flow::index()runs. -
Permission
module_sidebarmenu_flowis checked. -
The view
flow_page.phpis loaded. -
JavaScript triggers AJAX calls to load:
-
Available flows
-
Default flow (if set)
-
-
Columns for the selected flow are loaded.
-
Customers are fetched and grouped by column.
-
The Kanban board is rendered.
At this point, the user can interact.
7. Step-by-Step: Loading a Flow and Its Customers
When a flow is selected:
-
Backend loads flow definition from
customer_flow_setting. -
Columns are loaded from
customer_flow_column, ordered bycolumn_order. -
Customer positions are loaded from
customer_flow. -
Customer details come from
contactus. -
Filters are applied:
-
Search text
-
Date range
-
Team member
-
-
HTML is generated and returned.
-
Frontend paints the columns and cards.
8. Step-by-Step: Dragging a Customer
When a customer is dragged:
-
Frontend captures:
-
Customer ID
-
Flow ID
-
Target column ID
-
-
AJAX request is sent.
-
Backend inserts or updates
customer_flow.
-
Fields like
moved_byanddate_changedare updated.
-
Frontend updates UI instantly.
This action does not duplicate customers.
It only updates their position in the flow.
9. What the Flow Page Does
The Flow page allows you to:
-
Create multiple business workflows
-
Define stages for each workflow
-
Place customers into those stages
-
Move customers as work progresses
-
See progress visually instead of reading lists
-
Filter customers dynamically
-
Manage workload by team member
It is a visual process control system.
10. How It Works Internally (Logic Overview)
-
Flows define which customers belong
-
Columns define where customers are
-
customer_flow defines current position
-
contactus stores customer identity
-
Dragging updates only relationships, not customer data
Nothing is deleted automatically.
Everything is traceable.
11. Relationship With Other Modules
-
Customers page
Uses the samecontactusdata.
-
Folders, Tags, Status
Flow definitions can filter customers using these.
-
Team Members
Flow page can filter or track who moved customers.
-
Campaigns & Automations
Flow start/stop events can trigger automations.
-
Bots
Bots may create or update customers, but do not control Flow directly.
12. Settings That Affect the Flow Page
-
Customer Flow module on/off
-
Flow definitions (name, filters)
-
Column definitions (name, color, order)
-
Default flow per user
-
User permissions
All configuration happens in Settings → Customer Flow.
13. Mental Model (Easy to Remember)
You can think of the Flow page like this:
-
Flow = One process
-
Column = One stage
-
Card = One customer
-
Drag = Progress
-
Filters = Focus
-
Team = Responsibility
14. Final Summary
The Flow page is:
-
A visual customer management system
-
Built for process tracking
-
Powered by Kanban logic
-
Fully connected to customer data
-
Designed for clarity and speed
It helps teams see work, move work, and finish work.
