Select the correct rendering path for a document-generation job.
Overview
Select the correct rendering path for a document-generation job. 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
- Use DOCX rendering when the result must remain editable.
- Use PDF document rendering for XSLT-produced page-ready content.
- Use PDF forms when an existing fillable PDF must be populated.
- Use DOCX-to-PDF only when no template transformation is required.
- Use the XML endpoint for controlled XSLT transformation without document packaging.
Recommended procedure
- Confirm that you have the correct instance and permission.
- Identify the input data and required output format.
- Use a non-production template and representative sample data for the first test.
- 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
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.