Skip to content

A frontend to a few common administrative backend functions that aren't built-in to Docassemble

License

Notifications You must be signed in to change notification settings

SuffolkLITLab/docassemble-ALDashboard

Repository files navigation

ALDashboard: a docassemble Admin and Configuration Tool

PyPI version

A single tool and interview to centralize some tedious Docassemble admin configuration tasks.

A screenshot of the ALDashboard menu with choices: "Admin only - manage users", "Admin only - stats", "Install assembly line", "Verify API Keys", "Install packages", "update packages", "Package scanner", "View Answer files", "generate review screen draft", "validate docx template", "validation translation files", "prepare translation files", "validate an attachment fields block", "PDF tools", and "Compile Bootstrap theme"

  1. Install the Document Assembly Line packages (support files for Court Forms Online)
  2. Searchable user management - reset passwords and change privileges.
  3. Installing or updating several packages at once.
  4. Listing and viewing the contents of an (unencrypted) interview to facilitate debugging errors on production servers.
  5. View analytics/stats captured with store_variable_snapshot.
  6. List the files inside a particular package installed on the server.
  7. Gather files from a user who left the organization/unknown username and password.
  8. Review screen generator
  9. validate DOCX Jinja2 templates
  10. Generate a custom bootstrap theme for your interviews.

Ideas:

  1. Add a link to the dispatch directive for an existing file in an existing package.
  2. Generate translation files [TBD].

To use, you must create a docassemble API key and add it to your configuration, like this:

install packages api key: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

If you want the ALDashboard to be a dropdown option for admins and developers, add the following to the configuration before your install packages api key:

administrative interviews:
  - interview: docassemble.ALDashboard:data/questions/menu.yml
    title: Dashboard
    required privileges:
      - admin
      - developer

Some screenshots

Main page

A screenshot of the ALDashboard menu with choices: "Admin only - manage users", "Admin only - stats", "Install assembly line", "Verify API Keys", "Install packages", "update packages", "Package scanner", "View Answer files", "generate review screen draft", "validate docx template", "validation translation files", "prepare translation files", "validate an attachment fields block", "PDF tools", and "Compile Bootstrap theme"

Manage users

A screenshot that says "Manage users" with the fields "User", "What do you want want to do? Reset password or Change user permissions", "New Password", and "Verify new Password"

Bulk install packages from GitHub

A screenshot that says "What packages do you want to install?" The fields are for "Github URL", "YAML filename", and "Short name or alias (no spaces)"

Bulk update packages

A screenshot that says "What packages do you want to update?" followed by a list of packages. For example, "docassemble.209aPlaintiffMotionToModify", "docassemble.ALAffidavitOfIndigency", and more.

View answer files

View / search sessions by user and interview name

A screenshot that says "What interview do you want to view sessions for?" The fields are "File name" and "User (leave blank to view all sessions)"

A screenshot that says "Recently generated sessions for docassemble.MA209AProtectiveOrder:data/questions/209a_package.yml" with 5 sessions below.

View interview stats captured with store_variables_snapshot()

A screenshot with the title "Stats for Eviction Moratorium: 9". Below is the text "Total submissions: 9", "Group by: zip | state | modtime", and "Excel Download" followed by a map that can be filtered by state or by date.

Generate a bootstrap theme

A screenshot with the title "Your file is compiled!", below is the text "You can view and copy your file, or download it directly by right clicking the link to save it as a CSS file". Below that are examples of Bootstrap components like buttons and nav bars.

About

A frontend to a few common administrative backend functions that aren't built-in to Docassemble

Resources

License

Stars

Watchers

Forks

Packages

No packages published