How can we help you?

Advanced documentation search

Dataset and Field Mapping Reference

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

Reference the dataset-definition and field-mapping schemas.

Audience: Template authors and developers
Recommended visibility: Public

Overview

Reference the dataset-definition and field-mapping schemas. 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

  • Datasets store root path, schema, sample data, version, and active state.
  • Mappings store placeholder, normalized placeholder, XPath, type, format, scope, source, confidence, verification, and creator.
  • Mappings can be dataset-specific.
  • Use UUIDs and tenant ownership consistently.

Fields

Field Type or value Purpose
dataset.rootPath string Normally /data.
dataset.schema JSON text Stored field tree or schema.
dataset.sampleData JSON text Representative sample.
dataset.version integer Incremented on update.
dataset.active boolean Availability.
mapping.placeholder string Author-facing friendly name.
mapping.normalizedPlaceholder string Comparison key.
mapping.xpath text XML selection expression.
mapping.valueType string Optional data type.
mapping.format string Optional output format.
mapping.scopeType string Mapping scope.
mapping.scopeUuid UUID Optional scope object.
mapping.source string USER or another source.
mapping.confidence decimal Optional suggestion confidence.
mapping.verified boolean Human verification state.

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.