USER_GUIDE.md is a production file → must be ENGLISH ONLY. Complete translation covering: - PWA mobile installation - Authentication (JWT tokens, LDAP, 8h token expiry) - Scanning modes (barcode, AI OCR) - Inventory organization - Offline operation & auto-sync - Activity/audit log - Admin functions (users, LDAP, settings) - Security notices - Troubleshooting guide - Version info Follows mandatory rule: All production documentation in English ONLY. (Only AI-user discussion can be in Romanian) Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
5.3 KiB
TFM aInventory - User Guide
Welcome to TFM aInventory, the unified inventory management system. This guide explains how to use the application for managing your inventory.
📱 Installing on Mobile (PWA)
The application is a Progressive Web App, which means you don't need to download it from the App Store or Google Play.
- Open the application URL in your browser (e.g., Safari on iOS or Chrome on Android).
- Tap the Share button (iOS) or the three dots menu (Android).
- Select "Add to Home Screen".
- The application will now appear as an icon on your home screen and run in immersive mode (without browser chrome).
🔐 Authentication
- Default User: On first installation, use
Admin/<initial-password>(check your system administrator for the initial password). - Change Password: We recommend changing your password immediately from the Admin settings.
- LDAP/Enterprise Login: If your administrator has configured LDAP integration, you can log in with your company/domain account. The application will cache your password locally to allow offline access (e.g., in areas without signal like basements).
- JWT Tokens: Your login session is secured with JWT bearer tokens that expire after 8 hours. You will be automatically logged out when your token expires.
🔍 Scanning and Adding Items
The application supports two scanning modes:
Manual / Barcode Scanning
Scan an existing barcode to locate or update an item in your inventory.
AI Label Extraction (OCR)
Use your device's camera to photograph a product label. The AI engine automatically extracts:
- Product name (Model/Series)
- Manufacturer (Brand)
- Technical specifications
- Barcode number
The application will suggest matching items from your inventory or allow you to create a new item with the extracted data.
📂 Inventory Organization
The inventory is organized in a hierarchical structure:
- Categories: Broad groupings (e.g., Connectors, Spare Parts, Tools, Consumables).
- Items: Individual products within categories, identified by barcode.
- Item Properties: Name, part number, color, technical specifications, and quantity.
📶 Offline Operation
The application is designed to work even when you don't have internet connectivity in your warehouse or field location:
- Offline Data: All item data, categories, and your pending operations are stored locally on your device using IndexedDB.
- Automatic Sync: When you return to an area with internet connectivity, pending check-ins, check-outs, and other operations are automatically synchronized with the server.
- UUID Tracking: Each offline operation is tagged with a unique ID to prevent duplicates during synchronization.
📜 Activity Log (Audit Trail)
All actions (additions, modifications, deletions) are recorded in real-time with your user ID and timestamp. You can review the activity history in the Logs section to see:
- Who performed the action
- What action was performed (Check-in, Check-out, Item creation, etc.)
- When the action occurred
- The item affected and quantity changed
⚙️ Admin Functions
User Management
Administrators can:
- View all system users
- Create new users (local or LDAP-integrated)
- Modify user roles (admin or standard user)
- Delete users (except the default Admin account)
LDAP Configuration
If your organization uses LDAP/Active Directory, administrators can:
- Configure LDAP server connection details
- Set up role mapping (group membership → admin/user roles)
- Test LDAP connectivity
Settings
Access application settings from the Admin panel.
🚨 Security Notices
- Do not share your login credentials with other users. Each user should have their own account.
- Logout when done: Always log out when finished to protect your account.
- Report suspicious activity: If you notice unauthorized changes in the audit log, contact your system administrator immediately.
- API Security: The application uses JWT (JSON Web Tokens) for API authentication. Tokens are valid for 8 hours.
❓ Troubleshooting
"Insufficient Stock" Error
You attempted to check out more items than are currently in inventory. Check the current stock level and try again with a valid quantity.
Offline Mode Not Syncing
Ensure you have internet connectivity and wait a moment. Synchronization happens automatically when the connection is re-established. You can manually refresh the page to trigger an immediate sync.
Login Failed
- Verify your username and password are correct.
- If using LDAP, ensure your domain credentials are correct and the server is reachable.
- Check with your system administrator if you cannot reset your password.
AI Label Extraction Not Working
- Ensure adequate lighting when photographing the label.
- The label image must be clear and not blurry.
- The image size must not exceed 10 MB.
- The application supports JPEG, PNG, WebP, and GIF formats.
- If the AI service is unavailable, try again later or contact your administrator.
📞 Technical Support
For technical assistance, contact your system administrator or email: support@example.com
For detailed technical documentation, see the Project Architecture guide.
Version: v1.3.5 Last Updated: 2026-04-11