Skip to content

FileCraft developer reference

Use template/data-model authoring and documented generation operations. Confirm the installed output formats. Private writers and storage implementation are not public extension interfaces.

Validates a snippet without publishing or generating a stored file. Optional shape details are omitted.

Transport: unbound Dataverse action; JSON string Request in, JSON string Response out. pfx_ is a prefix token, not a literal deployment name. Read the calling conventions first.

Inner Request — illustrative
{
"kind": "snippet",
"snippetKey": "greeting",
"body": "Hello.",
"formatFamily": "text"
}

kind selects template, dataModel or snippet. This snippet branch takes body and formatFamily; snippetKey identifies the draft context.

Inner Response — illustrative excerpt
{
"ok": true,
"errors": [],
"warnings": []
}

The schema requires Write privilege on pfx_FileTemplate. Prefix tokens in table names resolve with the installed publisher. Record access, module role checks and input validation can further restrict the call. Do not interpret a missing execute privilege as anonymous or unrestricted access.

Handle a Dataverse fault separately from validation findings in the response. Test invalid input and the intended non-administrator role. Do not treat an empty result as a grant of access or a guarantee that no configuration exists.

Selected schema-declared registrations are shown for troubleshooting context. This is not a complete installed registration inventory. Preserve module-owned registrations; do not duplicate or disable them.

Owned registration Message / table Declared stage / mode
FileCraft: guard generation create Create · pfx_filegeneration PreValidation / Sync
FileCraft: guard generation update Update · pfx_filegeneration PreValidation / Sync
FileCraft: guard version create Create · pfx_filetemplateversion PreValidation / Sync

The full execution path may also include dynamically maintained registrations. Inspect the installed solution for exact stage, mode, filters and images before investigating interactions with your own plugins.

Confirm the installed operation name and permissions. Test representative data, empty results and denied access. Keep your integration in its own solution, and review contract changes before upgrading.

Administrator guide · Extension boundaries