Keyboard Shortcuts
Power users can navigate and act faster using the following shortcuts. Shortcuts are ignored while typing in inputs and text areas.
Navigation
- ? Open shortcuts help
- S Toggle sidebar
- / Focus file filter
- C Focus comment box
File actions
- H Open history
- V Toggle viewer mode (APS/Open)
- L Lock / Unlock
- R Request edit
Boards
- T Open Tasks board
- D Open Reviews board
- X Open Changes board
Catalog
- P Open Parts
- B Open BOMs
Tip: You can also press Cmd+/ or Ctrl+/ to open shortcuts help.
Welcome
This guide walks you through ProductFlo Sync end‑to‑end. Follow the numbered steps to sign in, choose a workspace, upload and preview files (including CAD), collaborate via comments, manage locks, resolve conflicts, work with history, and use Tasks and Design Reviews.
1) Sign in and verify connection
- Open ProductFlo Sync. If you are not signed in, the Welcome card shows a Sign in button.
- Click Sign in and complete the flow. After success, the header shows an Account button and a status dot.
- Confirm the status dot turns green, indicating you are connected. Open Account to verify your name, email, and ID. Use Sign out to disconnect when needed.
Where to look: Header → Account menu and status dot.
2) Choose or create a workspace
- Click Workspace in the header to open the panel.
- Pick a workspace from Your Workspaces (Created by you or Invited). The app switches to the Workspace view.
- To create a new workspace, click New Workspace, enter a short name (e.g., team-alpha), then Create.
Tip: Use memorable, lowercase names with dashes for clarity.
3) Invite and manage members
- Open the Members menu in the header.
- Use the Filter, Group by, and Online only controls to browse members.
- Click Invite User, enter the email, choose a role (Owner, Manager, Engineer, Viewer), then Send Invitation.
Invites grant access to the current workspace only.
4) Upload files
- In the Workspace view, click Upload above the Files list and pick one or more files. Supported types include .step, .stl, .igs, .obj, .gltf, .glb, and other engineering formats.
- Review the Prepare Upload preflight. If you have a known base etag (previous version), it is displayed and used to prevent overwrites.
- If a warning appears (e.g., potential overwrite), read it carefully. Click Upload to confirm.
- Track progress in Uploading files. You can continue working while uploads complete.
Where to look: Left sidebar → Files → Upload. Preflight and queue appear as modals.
5) Browse, filter, and group files
- Use Filter files… to quickly narrow by name.
- Change Group to Owner, Type, or Updated for different views.
- Deleted items appear under Trash. Click Refresh to reload. Restore directly from the Trash list.
6) Preview files
- Click a file to load its preview. Large or 3D formats open in the embedded viewer; text files render an inline preview.
- Use Open in new tab to view in a dedicated tab.
- Use Delete to move the file to Trash. You can restore later.
Where to look: Main panel → viewer title, actions, and preview area.
7) Locks and edit requests
- Select a file and review the lock status pill near the viewer title.
- Choose a Lock duration (e.g., 10m) from the dropdown, then click Lock to claim the lock.
- When finished, click Unlock.
- If you need access to a locked file owned by someone else, click Unlock and then Request Edit.
Locks prevent conflicting edits and make ownership clear to teammates.
8) Comment and discuss
- Scroll below the viewer to the Comments section.
- Type your note and click Send.
- New comments appear in the thread and are associated with the selected file and version.
Use comments to capture review notes, decisions, and changes.
9) Version history, timeline, and graph
- Click History in the viewer header to open the panel.
- Browse Version History, then use Timeline filters for event types (create, delete, lock, unlock, conflict, version, revert, comment, review, task) and grouping (none, type, day).
- Review the Graph to visualize relationships and branches.
- Select a past version and choose Revert to roll back when necessary.
10) Resolve conflicts
- Open the Conflicts list in the left sidebar to see files with competing versions.
- Launch the Resolve Conflict wizard. Review Versions and preview in the embedded frame.
- Optionally inspect Hierarchy and Properties.
- Click Accept Selected Version, add an optional message, and close the wizard.
Conflicts typically arise from concurrent edits or mismatched base versions during upload.
11) Plan work with Tasks
- Click Tasks in the header to open the Task Board.
- Choose a view: Kanban or List. Use Search and filters as needed.
- Click Create to add a task. Provide a title (required), description, status (Backlog, In progress, Done, Canceled), due date, and owner.
- Use the modal actions Save or Cancel. The status pill shows the current state.
Tip: Filter owners by name or email to quickly assign tasks.
12) Run Design Reviews
- Click Reviews in the header to open the Design Reviews board.
- Pick a template from Templates and click Use, or create a new template.
- Click New Review to start a review. In the create modal, set reviewer email, due date, and a message, then Create.
Templates standardize review checklists and expectations across projects.
13) Manage Trash
- Open the Trash section in the left sidebar.
- Click Refresh if needed, then pick an item and restore it.
14) Troubleshooting
- Loading: The loading modal appears during long operations. Please wait until it closes.
- Errors: If an error modal appears, retry the action. If it persists, sign out and back in, or refresh the page.
- Connection: If the status dot is not green, your session may be disconnected. Check your network and sign in again.
15) Work with branches
- Select a file, then click Branch in the viewer header to open the branch panel.
- Pick an existing branch or type a new branch name and click Create. The app switches context to that branch.
- All actions (lock, upload, comments, history) apply to the current branch.
- To remove a branch, open the panel and click the delete button next to its name (not available for main).
Tip: The current branch is shown on the button label and inside Details.
16) Compare and merge
- Open History for a file. Use the branch selector at the top.
- Click Compare with main to launch the APS Diff Tool for the selected branch vs main.
- When ready to integrate, click Merge into main. A new version is recorded on main.
Merging respects locks and records a timeline event. You can add an optional merge message.
17) Switch viewer modes
- Use the Preview mode dropdown in the viewer header to switch between Native (APS) and Open (embedded CAD).
- The selection is remembered per browser.
18) Translate CAD for APS
- With a file selected, click Translate CAD File in the header to queue a translation.
- Translation status is shown in History next to each branch (e.g., translated, in progress).
Once translated, models open in the APS viewer and are available for branch-to-main comparisons.
19) Working with Bills of Materials (BOMs)
Create, edit, and manage engineering BOMs with full revision control and approval workflow.
Getting Started
- Press B or click BOMs in the header to open the BOM workspace.
- Click New BOM to create a BOM for an existing assembly part.
- Choose the assembly part, revision, BOM type (EBOM/MBOM), and initial revision.
- The BOM opens in the authoring interface with tree view and detail panels.
BOM Tree Navigation
- Arrow Keys: Navigate up/down; left/right collapse/expand
- Space: Select item (multi-select with Shift/Cmd/Ctrl)
- Enter: Edit first inline field (quantity)
- Delete/Backspace: Delete selected items with confirmation
- Drag and drop items to reparent; use ↑/↓ buttons to reorder
Adding Items
- Click Add Item to add components at the root level
- Select a parent item and click Add Child for sub-assemblies
- Use the Parts picker to select components by part number or name
- Set quantity, unit of measure, and reference designators (for electronics)
Item Details Panel
- Overview: Basic item info, quantity, notes
- Alternates: Approved substitute parts with rationale
- Effectivity: Date/serial/lot ranges for item applicability
- Attributes: Domain-specific technical attributes
20) BOM Import from CSV/XLSX
Import BOMs from existing spreadsheets with intelligent mapping and validation.
Import Process
- Upload: Drag and drop CSV/XLSX file or click to browse
- Map Columns: Auto-detected or manual mapping of required fields
- Validate: Dry-run shows errors, warnings, and normalization
- Review: Preview additions, updates, and potential conflicts
- Apply: Commit changes atomically to the BOM
Required Columns
- child_part_number (or aliases: part_number, pn, child_pn)
- qty (or quantity) - must be > 0
- uom (or unit) - defaults to "each"
Optional Columns
- refdes: Reference designators (electronics)
- notes: Assembly instructions or comments
- alternates: Pipe-separated alternate part numbers
- effectivity_*: Date/serial/lot effectivity ranges
Validation Features
- Unit of measure normalization (EA, pcs → each)
- Domain template validation for required attributes
- Compliance checking (RoHS/REACH) with warnings
- Duplicate detection and conflict resolution
- Download errors CSV for fixing issues offline
21) BOM Approval Workflow
Manage BOM changes through formal approval process with audit trail.
Status Progression
- Draft: Editable by engineers, not yet submitted
- Pending Approval: Submitted and awaiting manager review
- Approved: Frozen snapshot, cannot be edited
- Superseded: Replaced by newer approved revision
Role Permissions
- Engineers: Create, edit drafts, submit for approval
- Managers: Approve, reject, manage alternates
- Viewers: View approved BOMs, export data
- Owners: Configure domain templates and settings
Revision Compare
- Select two revisions and click Compare
- View added, removed, and changed items with highlighting
- Quantity changes shown with before/after values
- Export diff report for change documentation
Audit Trail
- All submissions, approvals, and rejections are logged
- Timestamps, responsible users, and reason codes captured
- Immutable approved snapshots prevent accidental changes
- Change history visible in BOM detail view
22) Advanced BOM Features
Effectivity Management
- Date Effectivity: Specify when parts are valid from/to dates
- Serial Effectivity: Apply parts only to specific serial number ranges
- Lot Effectivity: Control by manufacturing lot numbers
- Automatic conflict detection prevents overlapping ranges
- Visual indicators show current effectivity status
Compliance Tracking
- RoHS: Track lead-free and restricted substance compliance
- REACH: Monitor European chemical safety regulations
- Conflict Minerals: Document 3TG mineral sourcing
- Automatic warnings for non-compliant components
- Export compliance reports for auditing
Cost Management
- Enter unit costs and currency for each part
- Automatic cost rollup calculation for assemblies
- Top cost drivers highlighted in rollup view
- Cost-sensitive BOM export with totals
- Historical cost tracking through revisions
MBOM Derivation
- Generate Manufacturing BOM from Engineering BOM
- Add manufacturing-specific items (consumables, tooling)
- Adjust quantities for yield and process requirements
- Maintain traceability to source EBOM
Parts Catalog
Browse, filter, sort, and bulk‑edit parts. Use quick actions and the Attachments tab to manage images and barcodes.
Quick Actions
- Open Parts (keyboard: P). Search, filter by Domain/Lifecycle/Tag, and sort columns.
- Edit: opens the part edit form with fields prefilled.
- Copy PN: copies the part number to clipboard.
- Where‑Used: shows assemblies/BOMs that reference the part.
Attachments
- Image URL: paste an image URL and Save to update the part image; a preview appears below.
- Barcode: set value and type (Code128, EAN‑13, QR) to see a live preview; Save to persist.
- All changes respect permissions: lifecycle edits require Manager; other edits require Engineer.
Bulk Actions
- Select rows (checkbox or press A). Use the bulk bar to apply tags, set lifecycle (Manager), or export selection.
- Press Esc to clear selection. Exports respect current filters and sort.
23) BOM Troubleshooting
Import Issues
- Column mapping errors: Check CSV headers match expected formats; use aliases like 'pn' for part_number
- UoM normalization warnings: Common units like 'EA', 'pcs', 'Piece' auto-convert to 'each'
- Missing parts created: Enable "Create missing parts" toggle; new parts use domain 'other'
- Domain validation failures: Check workspace BOM settings for required attributes per domain
Permission Errors
- Cannot edit BOM: Check BOM status (only drafts editable) and your role (engineer+ required)
- Alternates approval blocked: Manager role required for alternate approval/rejection
- Lifecycle changes denied: Part lifecycle changes require manager+ permissions
- Settings access denied: BOM workspace settings require owner role
Performance Issues
- Large BOM loading slowly: Tree uses lazy loading; expand only needed levels
- Parts catalog pagination: Use filters to narrow results; sorts/filters persist in URL
- Export timeouts: Large exports may take time; smaller filtered exports recommended
- Search delays: Part search is debounced; wait for typing to complete
Data Issues
- Effectivity conflicts: Use validation endpoint to check for overlapping date/serial/lot ranges
- Cost rollup incorrect: Verify part unit_costs and currencies match; missing costs excluded
- Compliance warnings: Update part RoHS/REACH fields; warnings help identify issues
- Where-used not updating: Refresh browser or re-run query; database indexes may need time