User Manual — Forma3D.Connect (Admin Dashboard)¶
This manual explains how to use the Forma3D.Connect web app (Admin Dashboard) to monitor orders, manage product mappings, and review activity logs.
Access & Sign In¶
- URL:
https://staging-connect.forma3d.be/(staging) - Authentication: you sign in using an API key (entered on the login page).
Login Page¶
- Open the web app.
- Enter your API key in the “API Key” field.
- Click Sign In.
If the API key is missing, the app will show “API key is required”.
Navigation¶
After signing in, use the navigation to switch between pages:
- Dashboard
- Orders
- Product Mappings
- Activity Logs
- Settings
Dashboard¶
Use the dashboard to get a quick overview of:
- System Health (API/database status, uptime, version)
- Order statistics (pending / processing)
- Active print jobs
- Needs attention (failed or stuck items)
- Recent Orders and quick links into specific orders
Orders¶
Use Orders to browse and monitor all orders.
- Search: use the search input to narrow down the list.
- Status filter: filter by order status (e.g. Pending, Processing, Completed).
- Pagination: move through pages of results.
- Open an order: click an order row or View to open the order detail page.
Order Detail¶
The Order Detail page shows:
- Customer information and order metadata
- Line items and progress indicators
- Print job status (if present for the order)
Use the “Back” navigation to return to the orders list.
Product Mappings¶
Use Product Mappings to configure how Shopify products map to SimplyPrint files.
- Status filter: show active/inactive mappings.
- Search: filter by SKU or product name.
- Toggle active: click the status badge to activate/deactivate a mapping.
- Edit: use the edit action to update a mapping.
- Delete: remove a mapping (requires confirmation).
New Product Mapping¶
Use Add Mapping to create a new mapping.
- Required fields: SKU, Product Name, Shopify Product ID
- Use existing: copy a part from an existing mapping (searchable + paginated) to quickly reuse a SimplyPrint File ID
- Parts: add one or more parts with:
- Part name
- SimplyPrint File ID
- Optional file name
- Quantity per product
Copy a part from an existing mapping (Part Library)¶
Click Use existing to open Add part from existing:
- Search by SKU, product name, part name, file name, or file ID
- Select a result to copy its SimplyPrint file details into a new part row
- Use pagination to browse large libraries
Click Create Mapping to save, or Cancel to discard.
Edit Product Mapping¶
Use the Edit action from the mappings list to update an existing mapping. The form is the same as “New Product Mapping”, pre-filled with existing values.
Activity Logs¶
Use Activity Logs to review system events and activity history.
- Severity filter: Info / Warning / Error
- Event type filter: free-text filter for event categories
- Date range: filter by start/end date, with quick presets (Today / Yesterday / Last 7 days)
- Export CSV: download the currently loaded log rows (disabled if there are no rows)
Some log entries include a link to the related Order.
Settings¶
Use Settings for system configuration and status:
- Appearance: Light / Dark / System theme
- Connection Status: WebSocket, API server, database status
- System Information: versions, environment, API URL, uptime
- Notifications: push notification preferences
- App Installation: install the PWA (if supported by your browser)
- Authentication: view session status and Sign Out
- Help & Support: links to API documentation and repository
Page Not Found (404)¶
If you open an unknown URL, the app shows a 404 page with a button back to the dashboard.
Maintaining this Manual (Generating Screenshots)¶
Screenshots are stored in docs/assets/user-manual/.
To regenerate them against staging (headless Chromium):
INTERNAL_API_KEY="<your api key>" STAGING_WEB_URL="https://staging-connect.forma3d.be" STAGING_API_URL="https://staging-connect-api.forma3d.be" pnpm ts-node --compiler-options '{"module":"CommonJS"}' scripts/capture-user-manual-screenshots.ts