Skip to main content

Office Suite

info

Enterprise Plan — This module is available on the Enterprise plan.

Office Suite gives your CRM the ability to produce professional, branded documents at scale. You define templates once, bind data to them, and the render engine produces output files in your chosen format — PDF, DOCX, ODT, XLSX, ODS, PPTX, or ODP. A built-in job queue tracks every render request, and a runtime health probe lets you confirm the document engine is available before submitting work.

What's Included​

  • Office templates — versioned, reusable document templates with published and draft states
  • Template bindings — data field mappings that connect CRM records to template placeholders
  • Render jobs — queued document generation requests with status tracking and artifact storage
  • Failed job management — view failed renders with attempt logs and diagnostic details
  • Runtime health probe — real-time check of the document render worker's availability
  • Tenant settings — branding, localization, output format defaults, retention rules, and notification preferences

Working with Templates​

Templates are the reusable blueprints for your documents. Each template has a published version (served to end users) and a latest version (your work in progress).

  1. Navigate to Office Suite > Templates to see all templates with their published status.
  2. Templates are created, updated, and published programmatically via the Office Suite API. The API accepts the template definition, bindings, and publish instructions. The Templates page is a read-only view of what the API has registered.
  3. Bindings map CRM data fields (for example, contact.first_name, invoice.total) to placeholder variables in the template. Bindings are managed through the API alongside the template definition.
  4. Once a template version is published via the API, it becomes available for render jobs.

Templates remain in draft state until explicitly published. You can update a draft without affecting ongoing jobs that reference the published version.

Render Jobs​

A render job takes a template, merges in data, and produces one or more output files (artifacts).

  1. Go to Office Suite > Jobs to see all render jobs — queued, running, completed, and failed.
  2. Each job shows the template used, the current status, and links to any generated artifacts.
  3. New jobs are submitted programmatically via the Office Suite API, which accepts the template ID, data payload, and desired output format.

The default output formats are configured in your tenant settings, but you can override the format per job through the API.

Failed Jobs​

When a render job fails, it moves to the failed jobs list along with a full attempt log so you can diagnose the issue.

  1. Navigate to Office Suite > Failed Jobs.
  2. Click a failed job to see the template it used, the number of attempts, and the error details from each attempt.
  3. Common causes include missing template bindings, invalid data payloads, or a temporarily unavailable render worker.
  4. Fix the underlying issue — update the template binding or data — then resubmit the job via the API.

The failed job count is displayed on the Office Suite dashboard so you notice problems immediately.

Runtime Health​

The runtime health view shows whether the document render worker is online and accepting jobs.

  1. Go to Office Suite > Runtime to see the current health probe result.
  2. The probe checks worker availability and returns a status for each component of the render pipeline.
  3. If the worker is unavailable, new render jobs queue but do not process until the worker recovers.

You can also see a summary of runtime health on the main Office Suite dashboard. The dashboard displays the current health status prominently — statuses include healthy, degraded, and critical. A critical status means the render worker is not accepting new jobs.

Tenant Settings​

The settings page lets you configure branding, localization, output format defaults, retention periods, and notifications for your tenant.

  1. Navigate to Office Suite > Settings.
  2. Under Branding, set a document title prefix, sender name, footer note, and whether to include your logo on rendered output.
  3. Under Localization, set the locale, timezone, currency, and date format applied to all rendered documents.
  4. Under Output Formats, choose which formats are available by default: pdf, docx, odt, xlsx, ods, pptx, odp.
  5. Under Retention, override how long job records, artifact files, and security events are kept (in days).
  6. Under Notifications, enable failed-job alerts and a daily digest email.
  7. Click Save Settings to apply.

For programmatic template management, job submission, artifact retrieval, and runtime status, see the Office Suite API Reference.