Learn the terms used throughout FeraRender.

Overview

Learn the terms used throughout FeraRender. Use this article before changing production templates or writing an integration. It establishes the expected workflow and the terms used by the rest of the library.

Key points

• A template is a tenant-owned or global render definition.
• A resource is supporting content attached to a template.
• A component is a reusable preamble, body, postamble, or base package.
• A dataset describes expected data.
• A field mapping connects a friendly placeholder to XPath.
• Compilation produces a validated composite package.

Recommended procedure

1. Confirm that you have the correct instance and permission.
2. Identify the input data and required output format.
3. Use a non-production template and representative sample data for the first test.
4. Record the template UUID, output mode, and any validation result.

Troubleshooting

The result format is wrong

Confirm the workflow and template output setting, then verify any asPdf, metadata, or content-type option.

The template cannot be found

Confirm the instance, owner, UUID or exact name, and whether a global template must first be imported.

The request is unauthorized

Check the token, instance header, and required view, edit, native-XSLT, or render permission.

Related documentation

• Supported Inputs and Outputs
• FeraRender Access and Permissions
• Render Your First Document

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.