How can we help you?

Template Properties Reference

Product: FeraRender Topic: Template Management Versions: Applies to all documented versions Current

Understand each editable template property.

Audience: Template managers and developers
Recommended visibility: Public

Overview

Understand each editable template property. Template-management changes can affect every application that renders by template name or UUID. Make changes in a controlled environment and keep a source copy of production templates.

Key points

  • name is the tenant-unique lookup key.
  • caption is the user-facing label.
  • fileName can control downstream naming behavior.
  • output selects the intended result path.
  • content stores the full package or transform.
  • mode and compile fields describe composite lifecycle.

Fields

Field Type or value Purpose
uuid UUID Primary template identifier.
ownerUuid UUID Tenant or global owner.
category string Grouping label.
name string Unique within an owner.
caption string User-facing label.
fileName string Optional output-name metadata.
output string Requested output behavior.
content long text XSLT or OpenXML package manifest.
mode FULL or COMPOSITE Template architecture.
datasetUuid UUID Associated dataset.
basePackageUuid UUID Selected base package reference.
bodyComponentUuid UUID Selected body component reference.
compileStatus string DRAFT, READY, STALE, and related states.
compiledChecksum string SHA-256 checksum of compiled content.
compiledAt datetime Most recent successful compile time.
compilerVersion string Compiler identifier.
validationJson JSON text Stored validation result.

Recommended procedure

  1. Open or retrieve the intended tenant-owned template.
  2. Review its mode, output, resources, and compilation status.
  3. Make the smallest necessary change and save it.
  4. Validate, compile when required, and perform a sample render before use.

Troubleshooting

A saved template no longer renders

Check whether the edit made a composite template STALE and compile it again.

An imported template has a different name

The importer creates a unique tenant name when a collision exists.

A resource does not appear

Confirm the resource name, encoding, template UUID, and whether the downstream renderer supports that resource type.

Related documentation


Documentation source: feradelinc/feradel.render.api, reviewed against repository revision b2c3a710. Verify behavior against the deployed release before publishing exact routes, limits, or version requirements.