Skip to main content

Reports and Templates

Overview​

To generate a report, you need to select the Election Event in the Admin Portal and add an entry for a specific report type.

Creating a Report​

  1. Go to the REPORTS tab and click the Create Report or ADD button.
  2. Select the type (see special notes for specific types below).
  3. Optional: Select Election for reporting only a specific election.
  4. Optional: Choose a template. You must have created one earlier (see more about creating templates). If none is selected, the system's default will be used.
  5. Click Save.

Generating Reports​

After creating a report entry, you will see it in the list. Click on the actions menu (3 dots on the right side) and choose:

  • Generate: Create a report based on real data
  • Preview: Generate an example of that report template based on mock data

Report Types​

Voters Turnout​

Note: To display male and female percentages, the sex attribute must have been added. Check out how to add the sex attribute.

Other Report Types​

Additional report types will be documented here as they become available.

Secret Voter Fields in Reports​

Secret voter fields are available only to reports that render one identified voter at a time. Current examples are voter information letters and manual verification reports. Aggregate reports such as turnout, election activity, tally, and results do not receive a voter object and cannot use secret fields.

The assigned template must both reference and declare every secret field it uses. For example:

{
  "secret_attribute_names": ["customerReference"],
  "document": "<p>Reference: {{user.customerReference}}</p>"
}

At generation time, Step validates the declaration against the election event's current Keycloak User Profile and decrypts only the declared names for the report's voter. The operator needs voter-secret-attribute-read in addition to the normal report permission. An undeclared, removed, or unreadable secret causes generation to fail rather than exposing its stored representation.

See Secret Voter Variables for variable shapes and declaration rules.

Downloading Secret-Bearing or Encrypted Reports​

Secret-bearing files use private storage. Downloading one requires voter-secret-attribute-read as well as the ordinary document permissions, even when the file was generated by another administrator.

Secret classification and password encryption are separate: declaring a secret does not force every report to be encrypted. Reports retain their configured encryption policy; voter information letters retain their existing password-protected PDF behavior.

For a newly generated password-encrypted report, download it from Reports or the completed entry in Tasks. The Admin Portal opens the existing report-password dialog; retrieving the password requires document-password-read and, for a secret-bearing document, voter-secret-attribute-read. The password belongs to that generated document, so changing the report configuration later does not change an earlier file's password. Older encrypted files without a stored document password still show decryption instructions; use the password supplied when they were generated.

Email and SMS are delivery messages, not password-encrypted report files. Their bodies remain readable by the recipient, including declared secret fields. See test-only Console delivery before testing a template containing credentials.