Skip to content

OnboardingBuilder developer reference

Tour definitions and supported targets are the customization boundary. RecordProgress tracks the caller; an integration must not attempt to submit progress as another user. Revalidate targets after form changes.

Validates a saved tour without starting it. Replace the GUID with a saved tour ID.

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
{
"tourId": "11111111-1111-1111-1111-111111111111"
}

tourId: saved tour GUID. Alternatively, tour supplies a tour object or its JSON text. Findings include path and message.

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

The schema requires Write privilege on pfx_OnboardingTour. 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
Onboarding: tour created Create · pfx_onboardingtour Not specified in schema / Sync
Onboarding: tour changed Update · pfx_onboardingtour Not specified in schema / Sync
Onboarding: tour deleted Delete · pfx_onboardingtour Not specified in schema / 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