Skip to main content

Custom DOCX Templates

aprity supports custom DOCX templates that allow you to brand generated documentation with your organization's logo, colors, fonts, and layout preferences. Custom templates control the visual presentation of the document while aprity fills in the content.

info

Custom DOCX templates are available on Enterprise plans only. All plans include access to the aprity system template.

What templates control

A custom template defines the visual and structural elements of the generated Word document:

ElementCustomizable
Cover pageLogo, title layout, subtitle, date placement
Headers and footersCompany logo, document title, page numbers, confidentiality notices
Fonts and colorsHeading styles, body text, accent colors
Page layoutMargins, orientation, column layout
StylesHeading levels (H1-H4), body text, tables, code blocks, callouts

Templates do not control the content itself. aprity generates the text, tables, and structure based on the scan results. The template determines how that content is presented visually.

System template vs. custom template

System template

The default aprity system template is a professionally designed document layout with aprity branding. It is available on all plans and requires no configuration.

  • Clean, modern design.
  • aprity logo and color scheme.
  • Suitable for internal documentation or proof-of-concept usage.

Custom template

A custom template replaces the system template's visual elements with your organization's branding. Use a custom template when:

  • You need to match your company's document standards.
  • Documentation will be shared with external stakeholders or clients.
  • Compliance requirements mandate specific document formatting.

Template specification

Custom templates must follow the aprity template specification to ensure content is placed correctly. The key requirements are:

Required styles

Your template must define the following Word styles. aprity uses these style names to apply formatting to generated content:

Style nameUsage
Heading 1Top-level section headings (object names, process titles)
Heading 2Subsection headings (automation, dependencies, rules)
Heading 3Detail headings (individual triggers, flows, validations)
Heading 4Sub-detail headings
NormalBody text and descriptions
Table GridData tables (field lists, dependency matrices)

Cover page

The cover page is defined as the first section of the template. It can include:

  • Your company logo as an image.
  • A title placeholder (aprity replaces this with the scan title).
  • A subtitle or date placeholder.

Headers and footers

Define headers and footers in your template as you would in any Word document. aprity preserves your header and footer definitions and applies them to all pages of the generated document.

Content controls (optional)

For advanced templates, you can use Word content controls to mark specific regions where aprity should insert content. Contact support for guidance on content control placement.

Creating a custom template

  1. Download the aprity system template from the app (Settings > Templates > Download System Template).
  2. Open it in Microsoft Word.
  3. Replace the aprity logo with your company logo.
  4. Modify the styles (fonts, colors, spacing) to match your brand.
  5. Update headers and footers.
  6. Save the file.
tip

Starting from the system template ensures all required styles and structural elements are present. Building a template from scratch requires careful attention to the specification.

Option 2: Build from scratch

  1. Create a new Word document.
  2. Define all required styles listed above.
  3. Set up your cover page, headers, and footers.
  4. Contact support to validate the template before uploading.

Uploading a custom template

  1. In the aprity Salesforce app, go to Settings > Templates.
  2. Click Upload Template and select your DOCX file.
  3. aprity validates the template structure and reports any missing styles or issues.
  4. If validation passes, the template is saved and becomes available for use.
  5. Select the uploaded template as your Active Template.

All subsequent DOCX exports will use the active template.

Switching templates

You can switch between the system template and custom templates at any time:

  1. Go to Settings > Templates.
  2. Select the template you want to use as the active template.
  3. The change takes effect on the next DOCX export. Previously generated documents are not affected.

Troubleshooting

Template validation fails

If your template fails validation during upload:

  • Ensure all required styles are defined (see the table above).
  • Check that the document is in DOCX format (not DOC or DOTX).
  • Verify the file is not password-protected or corrupted.

Formatting looks wrong in generated documents

  • Confirm your styles are correctly named (exact names as listed in the specification).
  • Verify that style formatting (font, size, color, spacing) is set on the styles themselves, not applied as direct formatting.
  • Download the system template and compare its style definitions with yours.

See DOCX Formatting Issues for additional troubleshooting.

Still not working?

If you need help with template creation or encounter issues:

  1. Send your template file to support@aprity.ai.
  2. Include a description of the issue and screenshots of the formatting problem.
  3. The support team can review your template and provide specific guidance.