Skip to content

Report Template

A Report Template defines the structure and content of a report that can be rendered to PDF, DOCX, or HTML. Templates are composed of an ordered list of Report Blocks (title page, table of contents, rich text, saved views, Jinja templates, etc.) and act as the source of truth used by the Reports app to generate documents — such as network status reports, security reviews, or upgrade summaries — from data in Nautobot. Each rendering produces a Published Report snapshot.

The ReportTemplate model for nautobot_reports provides the following fields:

  • name (string): Unique, human-readable name for the template. Used as the natural key and shown throughout the UI.
  • description (string): Optional short description explaining the purpose or contents of the report.
  • tenant (Tenant reference): Optional tenant that owns this template. Used for tenancy-based scoping and filtering.
  • owner (User reference): The user who created the template. Determines visibility when is_shared is disabled.
  • is_shared (boolean): When enabled, the template is visible to all users with the appropriate view permission. When disabled, only the owner can see it. Defaults to enabled.