Knowledge Hub Guide
Turn your documentation into instant answers with Max AI.
Overview
Knowledge Hub is your centralized library for manuals, SOPs, and process documentation inside the MachineMetrics platform.
It transforms your company's tribal knowledge into a living source of truth—making it instantly searchable through Max AI.
Located under Assets → Knowledge Hub, this feature lets you upload documents once and receive AI-driven answers directly from your own files. Whether it's a machine setup guide, a maintenance checklist, or a process SOP, Max AI retrieves the exact step-by-step information your team needs.
Knowledge Hub also holds Job Docs: documents you link to part operations so operators can open them in ShopPulse while they run the job. Max AI doesn't use Job Docs. See Job Docs.
Why Use Knowledge Hub
| Benefit | Description |
|---|---|
| Central Source of Truth | Store all critical documentation in one searchable location |
| AI-Powered Answers | Ask Max AI natural-language questions and receive instant, accurate guidance |
| Easy Maintenance | Replace outdated files anytime; Max AI automatically references the latest version |
| Context-Aware Search | Max AI understands meaning across your documents and shows the sources used in its answers |
| Preserve Expertise | Capture tribal knowledge before experienced operators retire or move on |
| Make Everyone an Expert | New operators access veteran knowledge instantly |
Accessing Knowledge Hub
Knowledge Hub is on a gradual rollout by invitation. Your account needs Max AI enabled, and only IT Admins can upload or manage documents — all other users can ask Max AI questions and receive answers drawn from the documents already uploaded. If you do not see Knowledge Hub, contact your Solution Delivery Manager (SDM) or Account Executive to request access.
Job Docs have their own permissions — see Who Can Manage Job Docs.
- In the MachineMetrics app, go to Assets → Knowledge Hub
- The Knowledge Hub dashboard shows:
- Tabs for your company's documents, MachineMetrics documents shared with all accounts, and Job Docs
- Uploaded documents
- Processing status
- Search functionality
Uploading Documents
How to Upload
- In the MachineMetrics app, go to Assets → Knowledge Hub
- Click Upload
- Select your file(s) from your device
Supported File Formats
| Format | Extension |
|---|---|
.pdf | |
| Word | .docx |
| Plain Text | .txt |
| Markdown | .md |
| HTML | .html |
| CSV | .csv |
| JSON | .json |
Job Docs also support MP4 video (.mp4).
Processing Status
Once uploaded, files automatically progress through:
| Status | Description |
|---|---|
| Uploading | File is being transferred |
| Processing | Content is being indexed for Max AI |
| Processed | Ready for Max AI queries |
| Uploaded | Job Docs only: stored and ready to link to part operations. Job Docs aren't indexed for Max AI, so they skip Processing |
| Failed | Upload or processing error — re-upload after correcting |
Tip: You can replace a file at any time. Replacing automatically re-processes and updates Max AI's knowledge.
Structuring Content for Max AI
Max AI performs best when documents are text-based, well-structured, and focused on a single topic. Documents structured this way consistently yield more accurate answers than very long or complex manuals because Max AI can interpret and index them more reliably.
Best Practices
| Do | Why |
|---|---|
Use clear headings (## Section Title) | Helps Max AI navigate document structure |
| Write in short paragraphs or bullet lists | Easier for AI to extract specific answers |
| Include checklists or tables when relevant | Structured data is more searchable |
| Keep each document centered on one procedure, machine, or process | Focused content = better answers |
Name files descriptively (e.g., GX-400_Setup_Guide.pdf) | Helps with organization and search |
What to Avoid
| Avoid | Why |
|---|---|
| Scanned images or screenshots without text | AI cannot read images |
| Overly complex tables or nested formatting | Formatting may be lost during processing |
| Multi-topic or lengthy mixed documents | Makes it difficult for AI to isolate relevant information |
| Generic, non-manufacturing information | Will be deprioritized in search results |
What Max AI Uses (and Ignores)
To ensure relevant answers, Max AI focuses on manufacturing and operational documentation.
Ideal Content
- Setup guides and SOPs
- Maintenance and troubleshooting procedures
- Operator reference materials
- Process or quality documentation
- Machine manuals and specifications
- Integration or API documentation
Ignored or Unsupported
- HR policies or internal admin docs
- Sales or financial content
- Image-only files (without readable text)
- Generic, non-manufacturing information
What Gets Lost During Processing
Understanding processing limitations helps you create better documents:
| Content Type | What Happens |
|---|---|
| Images | Replaced with <image> placeholders — not searchable |
| Scanned documents | OCR activates but may not perfectly capture all text |
| Charts and diagrams | Visual elements are not searchable |
| Embedded visuals | Not captured in the index |
| Complex tables | May lose formatting fidelity |
Important: Information embedded within images, complex layouts, or inconsistent formatting may not be captured cleanly during processing and can reduce answer accuracy.
Using Max AI with Your Knowledge
Once documents are processed, you can start asking Max AI questions.
Example Questions
"How do I calibrate the coolant pump on the GX-400?"
"What's the shutdown procedure for the VF-2?"
"What torque should I use for the fixture bolts?"
"How do I clear alarm 1234 on the Mazak?"
"What's the first-piece inspection process for part 7890?"
How Max AI Responds
Max AI searches your Knowledge Hub and returns clear, contextual answers—always citing which document(s) were used. This transparency helps users:
- Verify guidance against the original source
- Trace answers back to official documentation
- Build confidence in AI-provided information
Common Use Cases
| Use Case | Example |
|---|---|
| On-demand SOP guidance | "What are the steps to change tooling on Machine 5?" |
| Troubleshooting help | "Why is the spindle overheating?" |
| Maintenance procedures | "What's the PM checklist for the horizontal mill?" |
| Explaining alerts and metrics | "What does alarm 567 mean?" |
| Manufacturing terms | "What's the difference between roughing and finishing?" |
| Integration questions | "How do I configure the ERP connector?" |
Managing Documents
From the Knowledge Hub interface, you can:
| Action | Description |
|---|---|
| View file details | See processing status, upload date, file size |
| Rename files | Update file names for clarity |
| Replace outdated versions | Upload new version to reprocess automatically |
| Verify content | Check that content displays properly after processing |
| Delete files | Remove obsolete documentation |
Best Practice: Regularly review your library to ensure your team always has the most accurate and up-to-date information.
Job Docs are managed differently — see View, Download, or Delete a Job Doc.
Job Docs
Job Docs put the right document in front of the operator for the job they're running. Link a document to one or more part operations, and operators can open it in ShopPulse while that operation is running. Max AI doesn't use Job Docs.
You can manage Job Docs in two places — Knowledge Hub and ERP Data Studio. Both work on the same documents, so a change made in one shows up in the other.
Who Can Manage Job Docs
Users with an Admin, Manager, Executive, or IT Admin role can upload, link, set the activity of, download, and delete Job Docs. Anyone using ShopPulse can view Job Docs but can't change them.
Open Job Docs
- Go to Assets → Knowledge Hub
- Click the Job Docs tab
The table lists each document's Name, Status, Type, Linked Operations, Linked Activity, Size, Uploaded by, and Updated date.
Use Sort by to reorder the list, and the column button next to it to show, hide, or reorder columns.
[job-docs-table.png placeholder]
Upload a Job Doc
From Knowledge Hub
- On the Job Docs tab, click Upload
- Select your file
New Job Docs start with no linked operations and the All activities setting.
From ERP Data Studio
- Go to Apps → ERP Data Studio → Part Ops
- Click a part operation
- In the Documents section, click Manage
- Click Upload and select your file
The file is linked to that part operation automatically, with the All activities setting.
Link a Job Doc to Part Operations
From Knowledge Hub
- On the Job Docs tab, click the document's Linked Operations cell (it shows None if the document has no links). Or click the document's name, then click Link Operation in its side panel.
- Find operations: type a part number or operation in the search box, click Show all to browse, or use the All parts filter.
- Check the operations you want. In search results, Select all checks every match.
- Click Save
[job-docs-link-picker.png placeholder]
From ERP Data Studio
- Go to Apps → ERP Data Studio → Part Ops and click a part operation
- In the Documents section, click Manage
- Click Link, check the documents you want, and click Save
[erp-data-studio-documents.png placeholder]
[erp-data-studio-link-documents.png placeholder]
Set the Activity
The activity setting controls when operators see a document:
| Activity | Operators see it |
|---|---|
| All activities (default) | In Setup mode and Production mode |
| Setup | Only while the machine is in Setup mode |
| Production | Only while the machine is in Production mode |
- In Knowledge Hub: use the Linked Activity menu in the table, or the All activities / Setup / Production buttons in the document's side panel
- In ERP Data Studio: use the Activity Mode menu in a part operation's document list. To change several documents at once, check them and choose Select activity
Activity changes save as soon as you pick one. There's no Save button.
[job-docs-activity-menu.png placeholder]
[erp-data-studio-bulk-actions.png placeholder]
Remove a Link
- In Knowledge Hub: in the document's side panel, click × on the link. Or open the link picker, uncheck the operation, and click Save
- In ERP Data Studio: in Manage, check the documents and click Unlink
× and Unlink remove links right away, without asking you to confirm.
Preview a Document
Click a document's name to open its side panel. It shows the document's links, a preview (page through PDFs with the arrows; Markdown scrolls; videos play), and its status, date, format, and size. Click Full Screen for a larger view with page arrows and zoom.
[job-docs-side-panel.png placeholder]
[job-docs-full-screen.png placeholder]
View, Download, or Delete a Job Doc
- On the Job Docs tab, scroll the table to the right
- Click ⋮ at the end of the document's row
- Choose View, Download, or Delete
- If you chose Delete, click OK to confirm
Deleting removes the document and all its links, so operators can no longer see it. It can't be undone. You can delete Job Docs only in Knowledge Hub.
[job-docs-row-menu.png placeholder]
Part Operations With No Documents
In ERP Data Studio, a part operation with no linked documents shows No linked documents under Manage, with a prompt to link documents for the ShopPulse operator dashboard.
[erp-data-studio-no-documents.png placeholder]
Troubleshooting
Upload Failed
| Check | Solution |
|---|---|
| File format | Confirm format is supported (.pdf, .docx, .txt, .md, .html, .csv, .json) |
| File content | Ensure the document contains readable text |
| Formatting issues | Correct any formatting problems and re-upload |
File Stuck on "Processing"
| Check | Solution |
|---|---|
| Wait time | Refresh the page after a few minutes |
| Still stuck | Note the file name and contact support |
Max AI Gave Wrong or No Answer
| Check | Solution |
|---|---|
| Search terms | Ask using terms that appear in your document (machine name, part number, process step) |
| Processing status | Verify the document shows as "Processed" |
| Document content | Confirm the document contains the expected information |
| Document structure | Reformat with clearer sections and re-upload |
Tip: If answers seem incomplete, try simplifying the structure of the document or splitting large manuals into smaller, topic-focused files before re-uploading.
Operators Can't See a Job Doc
| Check | Solution |
|---|---|
| Linked operation | In ERP Data Studio, open the part operation the machine is running and check Documents → Manage |
| Activity setting | A Setup document is hidden during production, and a Production document during setup. Use All activities to show it in both |
| Job details | Job Docs appear only when the running job has a part number and operation |
| Still missing | In ShopPulse, operators can turn off Current operation only to browse every Job Doc |
Best Practices for Knowledge Management
Document Organization
| Practice | Example |
|---|---|
| Organize by machine | Mazak/, Haas/, DMG Mori/ |
| Organize by process | Setup/, Maintenance/, Quality/ |
| Organize by operation type | Turning/, Milling/, Inspection/ |
File Naming Convention
Use consistent, descriptive file names:
Machine_Model_Procedure.pdf
Examples:
- Mazak_VCN-530C_Setup_Guide.pdf
- Haas_VF-2_Maintenance_Checklist.pdf
- DMG_NLX-2500_Alarm_Reference.pdf
Content Maintenance
| Frequency | Action |
|---|---|
| As needed | Replace files immediately when procedures change |
| Monthly | Review recently accessed documents for accuracy |
| Quarterly | Audit for outdated content |
| Annually | Comprehensive review and cleanup |
Writing for AI
Recommended document structure:
1. Purpose / Overview
2. Safety Requirements
3. Tools and Materials Needed
4. Step-by-Step Procedure
5. Quality Checks
6. Troubleshooting Tips
7. Related Documents
Keep important details as plain text, not embedded in images.
FAQs
Can Max AI read images or screenshots?
No. Image areas are replaced with <image> placeholders. OCR may extract text from scanned pages, but accuracy depends on image quality.
How can I see which document Max AI used?
Each AI answer includes a reference link showing the exact document(s) used.
Do I need to re-upload when I edit a file?
Yes. Any time you update or replace a file, it's reprocessed and automatically indexed for Max AI.
Can I use Knowledge Hub for non-technical content?
It's designed for manufacturing and process documentation. Non-technical content may be ignored or deprioritized.
What's the maximum file size?
Contact your MachineMetrics administrator for current file size limits.
How long does processing take?
Most documents process within a few minutes. Large or complex documents may take longer.
Can multiple people upload documents?
Yes, based on your permission settings. Contact your administrator to verify your access level.
Related Articles
- Max AI Guide — Complete guide to Max AI capabilities
- MES Operator Guide — Viewing Job Docs — How operators open Job Docs in ShopPulse
- ERP Data Studio — Manage Job Docs on a Part Operation — Managing Job Docs from a part operation
- Automations & Workflows Guide — Triggering document delivery
Getting Help
- In-App: Click the help icon in Knowledge Hub
- Max AI: Ask "How do I upload a document to Knowledge Hub?"