LB

Documentation

Letter Builder

Browse documentation pages
Theme aware
Start Getting Started

Quick Start

First-run setup and your first successful workflow.

Readable guides Practical edge cases Feature-by-feature navigation

The fastest successful workflow

If you want confidence that the system is set up correctly, do not start by importing hundreds of employees or authoring dozens of templates. Start with one company, one employee, one external template, one request, and one approved letter. That first closed loop tells you far more than bulk setup does.

Recommended mindset: prove the whole workflow with a tiny but realistic dataset first. It is easier to trust imports and scale after you have already seen one complete end-to-end success.

Step-by-step setup

  1. Create a company. Fill the company name, contact details, active status, date format, timezone, and reference number settings.
  2. Add branding. Upload a logo and check that the company looks correct in the company table and template tools.
  3. Create a multilingual external template. Attach English and one secondary language, then write a real subject and body in both.
  4. Use placeholders carefully. Add placeholders such as [[employee_name]], [[position]], [[purpose]], and [[reference]].
  5. Review validation feedback. Make sure the template does not show placeholder mismatch errors across languages.
  6. Create one employee. Enter realistic HR data so placeholder auto-resolution has something meaningful to work with.
  7. Add one user translation. This confirms your multilingual employee workflow works before bulk imports begin.
  8. Open the employee panel. Create a request using the new external template.
  9. Approve the request as an admin. Confirm the approval modal shows the expected values.
  10. Print the final letter. Open the employee's approved letter and print it in the desired language.

Why this order works

  • You verify the company-to-template relationship first.
  • You catch placeholder problems before employees ever see the feature.
  • You test whether reference numbers, languages, and approval flows all connect correctly.
  • You avoid importing bad assumptions into the system at scale.

Checklist before inviting real users

  • At least one active company exists.
  • At least one active external template exists for that company.
  • The template content is valid in every language.
  • The employee belongs to the same company as the template.
  • Approval creates a real letter successfully.
  • Printing works through the language-specific route.
Do not skip validation: if you invite employees before testing at least one multilingual request and one print flow, the first production request often becomes your debugging session.

Edge cases to test on purpose

  • Missing requester fields: confirm approval is blocked.
  • Duplicate user translation language: confirm the UI prevents it.
  • Inactive template: confirm the employee cannot request it.
  • Inactive company: confirm downstream generation behavior matches your expectations.
  • Two-language template: confirm both versions use the same placeholder keys.

Useful entry points

  • Application root: /
  • Employee portal: /employee
  • Docs landing page: /help/docs/overview