How can we help you?

Advanced documentation search

Component and Assignment Reference

Product: FeraRender Topic: Reference Versions: Applies to all documented versions Current
Written by user
Updated

Reference component and assignment object fields, enums, and lifecycle.

Audience: Template authors and developers
Recommended visibility: Public

Overview

Reference component and assignment object fields, enums, and lifecycle. Use this article as a field and behavior reference. Verify release-specific values against the current service before publishing exact versions or product limits.

Key points

  • Components store type, name, content format, content, editor source, declarations, metadata, dataset, active state, and version.
  • Assignments store template, component, placement, order, enabled state, and condition.
  • Component names are unique by owner and type.
  • Assignment deletion or component change can invalidate compiled templates.

Fields

Field Type or value Purpose
component.type string PREAMBLE, BODY, POSTAMBLE, or BASE_PACKAGE.
component.name string Owner/type-unique name.
component.contentFormat string Editor, fragment, XSLT, DOCX, or package format.
component.content long text Renderable or compilable source.
component.editorJson JSON text Editor representation.
component.declarations JSON/text Extracted declarations.
component.meta JSON text Mappings and other metadata.
component.datasetUuid UUID Optional dataset.
component.active boolean Availability.
component.version integer Incremented on update.
assignment.placement string PREAMBLE or POSTAMBLE in current compiler.
assignment.sortOrder integer Placement order.
assignment.enabled boolean Whether included in compilation.
assignment.condition long text Stored but not currently compiled.

Recommended procedure

  1. Locate the relevant object, status, permission, or code.
  2. Confirm tenant and version context.
  3. Apply the documented rule consistently.
  4. Escalate conflicts between this reference and current API behavior for documentation review.

Troubleshooting

The documented value differs from a response

Record the service version and route, then update the draft or implementation before publication.

A field appears unused

Check legacy routes, UI clients, imports, and migration code before removing it.

A status persists unexpectedly

Inspect validationJson, compiled resources, assignments, and recent source changes.

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.