1. xmartusermanagement (quick recap)
What it does: Handles who you are, not what you can do in each app.
Authorization (permissions) lives inside each backend (Form, Workflow), not in UserManagement.
2. xmartflow — The “Form & Data Engine”
In simple words: xmartflow is the backbone that stores form designs, submitted data, contracts, and templates. It also has an Admin UI for building forms.
Two main parts
What xmartflow actually manages
- Form designer — Create forms, sections, and fields (dynamic, metadata-driven)
- Documents — Saved form submissions (e.g. a valuator registration record)
- Contracts — Generated from templates + form data
- Templates — HTML contract templates with placeholders
- Compliance, pools, departments, locations — Supporting master data
- Roles & permissions — App-level RBAC for the Form module
Typical API responsibilities
Form/*— Get form structure by ID or keyDocument/Save— Save a filled form (this is the main submission endpoint)Contract/CreateContract— Create a contract from a documentContract/SetContractSentToWorkflow— Mark that approval has startedDocument/UpdateWorkflowCompletedStatus— Mark approval as finished (called by workflow)
Admin UI routes (examples)
/admin/form/create— Design a new form/admin/formvalue/create/:id— Fill a form/admin/contractList— View contracts
Gateway role
xmart-spa-gateway exposes one URL and routes by path:
/admin/→ Form Admin UI/workflow/→ Workflow UI/legal/→ Legal UI
So users open http://host:8088/admin/, .../workflow/, etc., instead of many ports.
3. xmartworkflow — The “Approval Engine”
In simple words: Once a document/contract is submitted, xmartworkflow runs the multi-step approval process — who approves, in what order, approve/reject/query, and history.
Two main parts
Core concepts
What approvers can do
- Approve — Move to next step
- Reject — Send back / mark rejected
- Query — Ask for clarification, send back to previous step or initiator
- Reassign — Vacation / handoff to another user
Workflow UI — main screens
| Screen | Purpose |
|---|---|
| Home | Documents waiting to start workflow |
| My Task | Items needing your action |
| In Progress | Items you started but not at your step yet |
| Completed / Rejected | History |
| Task Approval | Main screen to approve/reject/view contract |
| Settings | Create workflows, manage pools and roles |
4. xmartflowapp / ValuatorEnlistment — The “Valuator Business App”
In simple words: This is a domain-specific frontend for managing property valuators (people/companies who do property valuations for a bank). It does not replace xmartflow or xmartworkflow — it uses them.
It is one of several clients under xmartflowapp (alongside Legal, Bottlers, etc.). ValuatorEnlistment is tailored for valuator enlistment and lifecycle management.
What business problems it solves
From CompanyData.json, the main modules are:
Post-enrollment actions (from completed valuator list)
- Suspension — Temporary hold with reason
- Renewal — Re-register / extend
- Delistment / Blacklist — As above
How forms work here
Forms are not hardcoded. The UI loads form structure from xmartflow and renders it dynamically (FormRenderer). Admins design forms in the Admin UI; ValuatorEnlistment just displays and submits them.
Form keys (examples):
form_person_valuator_registrationform_company_valuator_registrationform_valuator_suspensionform_valuator_delistmentform_valuator_blacklist
Main user journeys
A. New valuator registration
- User logs in → JWT from xmartusermanagement
- Lands on
/Valuator/std/cov(hub) - Chooses “Person Valuator” or “Company Valuator”
- Fills dynamic form (loaded from xmartflow)
- Submits →
POST Document/Saveon xmartflow - Clicks Start Workflow → creates contract + workflow entity
- Approvers work in Workflow UI (
/workflow/) - When done → valuator appears in “Completed Records”
B. Delistment / Blacklist
- User goes to Delistment or Blacklist
- Enters valuator document ID (e.g.
NSD_000220) - App looks up the record in xmartflow
- Opens the action form linked to the parent valuator
- Submits → new document linked via
RelatedDocumentIds - Goes through workflow again
C. Suspension
- From completed valuator list → Actions → Suspension
- Shows read-only valuator profile
- User enters reason and submits
- Creates a child document linked to the original valuator
D. Change in limit / Area update (bulk)
- User picks multiple valuators from a searchable list
- Sets new category (limit) or new geographic area
- Submits one form with repeatable sections
- Each section links back to a valuator via
RelatedDocumentIds
Which backends ValuatorEnlistment calls
Cross-app navigation (SSO-style)
The navbar encrypts the JWT and passes it as ?myToken=... when opening Workflow or Form Admin in a new tab, so users don’t log in again.
Responsibility split
6. End-to-End Example: “Register a New Valuator”
- Admin designs “Person Valuator Registration” form in xmartflow Admin (
/admin/) - Bank staff opens ValuatorEnlistment, logs in via UserManagement
- Staff fills the form; data saves to xmartflow as a Document
- Staff clicks Start Workflow:
- Contract created in xmartflow
- Workflow entity created in xmartworkflow
- First approver gets email from UserManagement
- Approver opens Workflow UI (
/workflow/myTask), reviews, approves step by step - On final approval, workflow calls xmartflow → document marked
IsWorkflowComplete = true - Valuator shows in Completed Records in ValuatorEnlistment