Question 1

How to add alternative text to signature images in docassemble DOCX output?

Accepted Answer

Starting with docassemble version 1.9.10, alt text of images is automatically passed through to the DOCX. To set alt text on a signature, assign to the `alt_text` attribute of the `DAFile` object. For example, in the `validation code` of a signature block: `user_signature.alt_text = user.name.full()`. The `.show()` method also accepts an `alt_text` parameter. For PDF output, ensure the 'tagged pdf' feature is enabled so that alt text transfers to the PDF.

Question 2

Why can't I add new items to a DADict table when 'show incomplete' is true in docassemble?

Accepted Answer

The `add_action()` button fails because docassemble doesn't know which attributes are required for a new item to be considered complete. Add `complete_attribute='complete'` to your `DADict` definition: `objects:
  - income: DADict.using(object_type=DAObject, complete_attribute='complete')`. Then, after defining required attributes (e.g., `income[i].a`, `income[i].b`), explicitly set `income[i].complete = True`. This ensures `add_action()` can prompt for the missing attributes and the new item appears in the table even with `show incomplete: true`.

Question 3

Why does list collect prevent adding more items when required fields are conditionally shown?

Accepted Answer

This occurs when a field inside a list collect is marked required but only shown under certain conditions, causing hidden fields to fail validation. Upgrade to Docassemble 1.7.5 or later where this bug is resolved. If upgrading is not possible, a workaround is to remove required: True from the conditional field and enforce the requirement using custom validation code.

Question 4

Why does my Docassemble interview break when a checkbox option like 'Others' is missing from the server-provided options?

Accepted Answer

When you use `show if: applicant.concern['Others']`, Docassemble expects the key `'Others'` to always exist in the checkboxes dictionary. If the server does not include that option, the key is missing entirely, and a `KeyError` stops the interview. To safely check for an optional key, use the `.get()` method: `show if: applicant.concern.get('Others')`. This returns `None` (falsy) instead of raising an error, allowing the interview to proceed. If you need to combine this check with another condition, compute the combined result in a code block and reference the boolean variable in `show if`, like:

```yaml
---
code: |
  show_extra = applicant.concern.get('Others') and applicant.other_concerns1
---
show if: show_extra
```
This avoids any limitations with `and` in direct `show if` expressions.

Question 5

Why does Docassemble ask for 'there_is_another' when using a DADict in a table?

Accepted Answer

Docassemble automatically adds a 'there_is_another' prompt for DADict objects to allow adding more items, similar to DAList. To prevent this prompt, explicitly set `income.there_is_another = False` in a code block before the table is displayed. This is expected behavior, not a bug.

docassemble

Core Features

What It Can't Do

Use Cases

Tags

Getting Started

Similar Projects