|
| 1 | +--- |
| 2 | +id: aldashboard_overview |
| 3 | +title: ALDashboard overview |
| 4 | +sidebar_label: Overview |
| 5 | +slug: /components/ALDashboard/overview |
| 6 | +--- |
| 7 | + |
| 8 | +ALDashboard is a collection of tools to help administer a Docassemble server and debug interviews. It provides utilities for package management, server maintenance, translation workflows, and debugging tools specifically designed for the Document Assembly Line ecosystem. |
| 9 | + |
| 10 | +## Key Features |
| 11 | + |
| 12 | +ALDashboard provides several categories of functionality: |
| 13 | + |
| 14 | +### Package Management |
| 15 | +- Create and manage Docassemble packages |
| 16 | +- Scan and analyze package contents |
| 17 | +- Automated package building and deployment tools |
| 18 | + |
| 19 | +### Translation and Internationalization |
| 20 | +- Translation workflow management |
| 21 | +- Multi-language support for interviews |
| 22 | +- Translation validation and quality assurance |
| 23 | + |
| 24 | +### Server Administration |
| 25 | +- Server maintenance utilities |
| 26 | +- Package installation and updates |
| 27 | +- System diagnostics and monitoring |
| 28 | + |
| 29 | +### Document Processing |
| 30 | +- DOCX file validation and processing |
| 31 | +- Attachment validation tools |
| 32 | +- Document template analysis |
| 33 | + |
| 34 | +## Main Modules |
| 35 | + |
| 36 | +ALDashboard consists of several Python modules, each providing specific functionality: |
| 37 | + |
| 38 | +- **aldashboard.py** - Core dashboard functionality and server management |
| 39 | +- **create_package.py** - Package creation and management utilities |
| 40 | +- **translation.py** - Translation workflow and management tools |
| 41 | +- **project_maintenance.py** - Project maintenance and update utilities |
| 42 | +- **docx_wrangling.py** - DOCX document processing and validation |
| 43 | +- **package_scanner.py** - Package analysis and scanning tools |
| 44 | +- **validate_docx.py** - DOCX validation utilities |
| 45 | +- **validate_attachment.py** - Attachment validation tools |
| 46 | + |
| 47 | +## Installation |
| 48 | + |
| 49 | +ALDashboard is typically installed as part of the Document Assembly Line setup: |
| 50 | + |
| 51 | +```bash |
| 52 | +pip install docassemble-ALDashboard |
| 53 | +``` |
| 54 | + |
| 55 | +Or install from the Docassemble package management interface by searching for "ALDashboard". |
| 56 | + |
| 57 | +## Usage |
| 58 | + |
| 59 | +ALDashboard provides both programmatic APIs and interview-based interfaces for server administration. Most functionality is accessed through the Docassemble web interface after installation. |
| 60 | + |
| 61 | +## Related Documentation |
| 62 | + |
| 63 | +- [Assembly Line Project Architecture](/docs/get_started/al_project_architecture) |
| 64 | +- [Installation Guide](/docs/get_started/installation) |
| 65 | + |
| 66 | +## Repository |
| 67 | + |
| 68 | +The ALDashboard source code is available at: https://github.com/SuffolkLITLab/docassemble-ALDashboard |
0 commit comments