Documents
XBuddy Documents is the central repository for all company files — proposals, policies, SOPs, templates, and contracts. Every document is versioned, permission-controlled, and linked to the business processes that need it.
Key Entities
| Entity | Description |
|---|---|
| Document | Any file (PDF, DOCX, XLSX, image) stored with metadata, tags, and version history |
| Folder | Hierarchical container; inherits permissions from parent unless overridden |
| Version | Each upload or edit creates a new version; previous versions remain accessible |
| Template | Reusable document skeleton with variable placeholders (e.g., {{client_name}}) |
| Comment | Inline annotation on a specific page or selection within a document |
| Approval Request | Formal review chain attached to a document; integrates with the Approvals module |
Getting Started
You need the documents:write permission to upload files and create folders. The documents:manage permission is required to set folder-level access rules.
- Create your folder hierarchy — Go to Documents → My Library. Click New Folder and build a structure that reflects your org (e.g.,
Finance / Invoices / 2026,HR / Policies,Sales / Proposals). - Set folder permissions — Right-click a folder → Manage Access. Assign view/edit/manage rights to roles or specific users. Child folders inherit parent permissions by default.
- Upload your first document — Click Upload or drag files into a folder. Supports PDF, DOCX, XLSX, PNG, JPG, and ZIP up to 500 MB.
- Add metadata — After upload, fill in Tags, Category, and optionally link to an entity (e.g., a Contact, Project, or Contract).
- Share or collaborate — Click Share on any document to generate a view-only link or invite specific users with edit access.
- Create a template — Go to Templates → New Template. Upload a base file and mark variable fields with
{{variable_name}}syntax. Templates can be used from any module’s document picker. - Trigger an approval — On any document, click Request Approval. Choose an approval workflow (or create one) and notify reviewers. Track status in the Approvals module.
Core Workflows
1. Document Lifecycle: Draft → Review → Published
Upload / Create Draft
↓
Internal Review (comments, suggestions)
↓
Approval Request (optional — see Approvals module)
↓
Published (marked as current version)
↓
Archived (superseded by newer version or manually archived)How to manage versions:
- Open a document → Version History tab → see every version with uploader, timestamp, and size.
- Click Restore on any version to make it the current one (creates a new version entry, never overwrites history).
- Add a version note when uploading to describe what changed (e.g., “Updated payment terms per legal review”).
2. Template-Based Document Generation
- Go to Templates and select the desired template.
- Click Generate Document.
- Fill in the variable fields in the popup form (e.g.,
client_name,contract_date,value). - XBuddy generates the file and saves it to your selected folder.
- The generated document is automatically linked to any entity you specified (e.g., a Deal in CRM or a Project).
3. Cross-Module Document Attachment
Documents can be attached directly from other modules:
- CRM / Sales — Attach proposals and NDAs to Deals
- HR — Attach offer letters, contracts, and policies to Employee records
- Projects — Attach SOWs and deliverables to Project records
- Finance — Attach supporting invoices and receipts to Transactions
- Contracts — Contracts module auto-stores signed documents here
When you open any attached document, you land directly in Documents with full version and approval history.
4. Bulk Upload & Folder Migration
- Bulk Upload: Drag a folder from your desktop into the Documents panel — XBuddy preserves the sub-folder structure automatically.
- Move: Select multiple files with ⌘/Ctrl + click → Move → pick destination folder.
- Bulk Tag: Select files → Edit Tags → apply shared tags in one action.
Configuration
| Setting | Where | Default |
|---|---|---|
| Max file size | Admin → Settings → Documents | 500 MB |
| Allowed file types | Admin → Settings → Documents | All types |
| Default folder for new uploads | User Preferences → Documents | Root library |
| Auto-archive after (days) | Folder settings → Advanced | Disabled |
| Require version notes on upload | Admin → Settings → Documents | Off |
| Public link expiry | Per-document → Share → Expiry | Never |
Permissions
| Permission Key | What it allows | Default Roles |
|---|---|---|
documents:read | View documents and folders | All staff |
documents:write | Upload, edit, move, tag documents | Staff, Manager, Admin |
documents:delete | Permanently delete documents | Manager, Admin |
documents:manage | Set folder permissions, manage templates | Admin |
documents:share | Generate public/external share links | Manager, Admin |
documents:approve | Approve documents in approval workflows | Reviewer, Manager, Admin |
Integration Map
| Module | How Documents connects |
|---|---|
| Approvals | Any document can trigger an approval workflow; status syncs back |
| E-Signatures | Send documents for signing directly from Documents; signed copy auto-saved |
| Contract Management | Contracts module stores all versions of contracts here |
| HR | Offer letters, employment contracts, policies attached to employee records |
| CRM / Sales | Proposals, NDAs, presentations linked to Deals and Accounts |
| Projects | SOWs, deliverables, meeting notes attached to Project records |
| Finance | Receipts, invoices, audit documents attached to financial records |
AI Agents
| Agent | Schedule | What it does | Output |
|---|---|---|---|
| Document Expiry Watcher | Daily | Scans documents with expiry dates (contracts, certifications) and flags those expiring within 30/60/90 days | Notification + expiry report |
| Duplicate Detector | Weekly | Identifies near-duplicate files based on filename and content hash | Dedup suggestions list |
| Stale Document Cleanup | Weekly | Flags documents not accessed or updated in 180+ days for archival | Archive candidates report |
| Template Usage Analyzer | Monthly | Reports which templates are used most and which have variables frequently left empty | Template optimization suggestions |
FAQ
Q: How many versions of a document are kept? All versions are kept indefinitely by default. You can enable auto-purge of versions older than N days in Admin → Settings → Documents → Version Retention.
Q: Can external users (clients, vendors) access documents? Yes — use Share → External Link to generate a view-only or comment-enabled link. Links can be password-protected and set to expire. External users do not need an XBuddy account.
Q: What happens if two people edit the same document at the same time? XBuddy uses optimistic locking: the second save creates a new version. Both versions are preserved. Use the Version History to merge changes manually if needed.
Q: Can I recover a deleted document? Yes — deleted documents go to Trash and are held for 30 days before permanent deletion. Go to Documents → Trash to restore.
Q: How do I restrict a subfolder from being visible to a role that has access to the parent? Open the subfolder → Manage Access → toggle off Inherit parent permissions → set explicit access rules. The parent folder’s permissions no longer cascade into this subfolder.
Q: Can I link a document to multiple entities (e.g., both a Deal and a Contact)? Yes — open the document → Links tab → Add Link → search for any entity type. Documents support multiple entity links simultaneously.
Common Scenarios
Scenario 1: Onboarding Document Pack for New Hire
- Create folder
HR / Onboarding / [Employee Name]. - Generate offer letter from template → fill employee details → save to folder.
- Attach employment contract → send for e-signature via E-Signatures module.
- Upload signed contract → link to HR employee record.
- Add policies (handbook, NDA) → set as required reading → notify employee via Communications.
Scenario 2: Proposal-to-Contract Flow for a Sales Deal
- In CRM, open a Deal → Documents tab → Generate from Template → select Proposal template.
- Fill in deal-specific variables → save to
Sales / Proposals / [Deal Name]. - Share with prospect via external link.
- Once accepted, generate Contract → route through approval workflow.
- Send approved contract for e-signature → signed PDF auto-archived under the Deal.
Scenario 3: Policy Update with Audit Trail
- Upload new version of a policy document to
HR / Policies. - Add version note: “Updated leave policy per 2026 labor law amendment”.
- Create approval request → assign to Legal and HR Director.
- After approval, mark as Published → notify all staff via Communications.
- Previous version remains in Version History for compliance auditing.