Troubleshooting Common WollMux Errors and FixesWollMux is a widely used extension for LibreOffice that helps organizations automate document templates, forms, and mailing lists. While powerful, WollMux can be confusing to configure and may produce errors that block user workflows. This article walks through the most common WollMux problems, explains why they occur, and provides step-by-step fixes and preventative measures.
Table of contents
- Getting started: prerequisites and environment checks
- Installation and update issues
- Configuration file (wollmux.cfg) parsing and syntax errors
- Mail-merge and template rendering problems
- Data source (address book, LDAP, CSV) connection failures
- Macro security, permissions, and sandboxing issues
- Performance problems and memory errors
- Debugging tools, logs, and diagnostics
- Best practices and maintenance checklist
1. Getting started: prerequisites and environment checks
Before troubleshooting, confirm the basics:
- LibreOffice version compatibility: WollMux supports specific LibreOffice versions. Verify your WollMux version matches your LibreOffice release.
- Operating system compatibility: Ensure OS and file-permission settings allow WollMux to read config and extension files.
- User permissions: The user running LibreOffice needs read access to WollMux files and any data sources.
- Backup: Back up your configuration files (wollmux.cfg and any include files) before making changes.
2. Installation and update issues
Symptoms
- WollMux doesn’t appear in LibreOffice menus.
- Errors during extension installation.
- WollMux works on one machine but not another.
Common causes & fixes
- Corrupt extension file (.oxt): Re-download WollMux from a trusted source and reinstall via Tools → Extension Manager.
- Wrong installation scope: If installed for “only me”, other users won’t see it. Reinstall as “All users” if needed.
- Conflicting extensions: Disable other extensions (especially those that modify templates or menus) to check for conflicts.
- LibreOffice profile corruption: Reset the LibreOffice user profile (rename the user profile directory) and restart to see if WollMux loads properly.
Preventative tips
- Standardize the WollMux and LibreOffice versions across your organization.
- Use centralized deployment tools (SCCM/Group Policy) for consistent installation.
3. Configuration file (wollmux.cfg) parsing and syntax errors
Symptoms
- WollMux fails to load with parsing errors or silent failures.
- Template behavior changes unexpectedly after editing wollmux.cfg.
Common causes
- Syntax mistakes: missing brackets, incorrect key names, wrong line endings.
- Character encoding issues (UTF-8 vs ANSI).
- Invalid include paths or circular includes.
- Tabs vs spaces in places that expect a specific format.
Fixes
- Validate syntax: Use WollMux’s built-in parser tool where available or run WollMux in debug mode to see parsing errors in the logs.
- Check encoding: Save wollmux.cfg as UTF-8 without BOM.
- Verify include paths: Use absolute or correct relative paths; ensure included files exist and are readable.
- Revert to a known-good config from backup and reapply changes incrementally.
Example: common error pattern
- If a block like
Formular "myform" PROPERTY "name" = "EmployeeForm" END
yields a parse error, confirm quotes and keywords, and that END matches the opening keyword.
4. Mail-merge and template rendering problems
Symptoms
- Fields display placeholders instead of data.
- Layout breaks after merging (wrong pagination, missing images).
- Generated PDF looks different from preview.
Causes & fixes
- Incorrect field identifiers: Ensure data source column names exactly match field references in the template. Case sensitivity matters in some setups.
- Missing images/resources: Use accessible file paths (preferably relative to the template or packaged in the extension). Ensure images are embedded if documents will be used offline.
- Template corruption: Try opening the template, using Save As to create a clean copy, and reattach WollMux controls.
- Format differences: Export to PDF from LibreOffice directly to check rendering; if differences persist in programmatic merges, examine the merge pipeline (scripts or services) for missing export parameters.
Advanced: conditional fields and macros
- WollMux supports conditional constructs. Syntax errors in these conditions can silently fail; test conditions with sample data and consult logs for evaluation errors.
5. Data source (address book, LDAP, CSV) connection failures
Symptoms
- No records found during merge.
- Timeouts or errors when accessing LDAP.
- Incorrect or garbled data pulled into fields.
Causes & resolutions
- CSV issues: Ensure proper delimiter, correct quoting, and consistent column count. Save CSV as UTF-8 to avoid encoding problems. Use LibreOffice’s “Register” feature to add the CSV as a data source.
- LDAP misconfiguration: Verify server address, base DN, search filters, and authentication credentials. Use ldapsearch or an LDAP client to validate queries outside LibreOffice.
- Permission or network issues: Check firewall rules, port accessibility (usually ⁄636), and service availability.
- Data type mismatches: Dates or special formats may need conversion—preprocess CSV or adjust template formatting.
Quick checks
- Open the data source directly in LibreOffice Base or Calc to confirm connectors and credentials work.
- For LDAP, enable verbose logging in WollMux and test incremental queries to isolate failing filters.
6. Macro security, permissions, and sandboxing issues
Symptoms
- WollMux macros blocked on startup.
- Prompts about unsigned macros or disabled content.
Causes & mitigations
- Macro security level too high: Lower the macro security (Tools → Options → LibreOffice → Security → Macro Security) only if organizational policy allows.
- Unsigned scripts: Sign macros with a trusted certificate or deploy signed templates via trusted distribution.
- Protected mode/sandboxing: Some environments restrict macros via OS policies or LibreOffice’s protected mode. Coordinate with IT to whitelist WollMux-related macros.
Safe deployment tips
- Use digitally signed macros and distribute the signing certificate via group policy.
- Reduce macro usage where possible by leveraging WollMux’s declarative features.
7. Performance problems and memory errors
Symptoms
- Slow template load or merge operation.
- Out-of-memory crashes during large merges.
- Unresponsive LibreOffice when WollMux is active.
Causes & fixes
- Large datasets: Implement pagination or process merges in batches rather than all records at once.
- Complex templates: Simplify templates, reduce number of fields, or split large documents into smaller parts.
- Java components: If WollMux uses Java-based connectors, ensure appropriate JVM memory settings. Adjust LibreOffice JVM heap (Tools → Options → LibreOffice → Advanced).
- System resources: Ensure machines running heavy merges have sufficient RAM and CPU; consider running merges on a server with more resources.
Optimization techniques
- Pre-generate portions of documents or cache repeated content.
- Use CSV or database indexing to speed queries rather than on-the-fly full scans.
8. Debugging tools, logs, and diagnostics
Where to find logs
- LibreOffice user logs and WollMux debug output are primary sources. Enable WollMux debug logging in wollmux.cfg or via environment variables if supported.
Useful commands and tools
- LibreOffice safe mode: Launch to test if profile or extensions are causing the issue.
- ldapsearch / CSV viewers: Validate data sources outside LibreOffice.
- System monitors (top, Task Manager): Observe resource usage during merges.
Interpreting logs
- Look for “Parse error”, “Connection refused”, “NullPointerException”, or “OutOfMemoryError” messages—these usually indicate the problem area. Trace back to recent config or environment changes.
9. Best practices and maintenance checklist
- Keep WollMux and LibreOffice versions aligned across your environment.
- Version-control wollmux.cfg and include files; maintain clear change logs.
- Test configuration changes on a staging profile before rolling out to users.
- Use backups and maintain rollback procedures.
- Limit template complexity; document data source schemas and field names.
- Sign macros and follow organizational security policies.
- Schedule heavy merge jobs during off-hours or on dedicated servers.
If you want, I can:
- Review your wollmux.cfg for syntax issues (paste it here).
- Suggest a minimal, validated example config for a common mail-merge scenario.
Leave a Reply