Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The New Wizard page at /fw/wizards/new presents a creation form for multi-step wizard templates. After creation the browser redirects automatically to the Wizard Builder (/fw/wizards/:id/edit) so steps and fields can be configured.

​
Overview

The New Wizard page collects the minimum metadata required to create a wizard template record: name, optional description, module, and wizard type. The new template is created with is_active: false and an empty steps array, then the user is sent to the builder to configure steps. No workflow execution or PHI processing occurs on this page.

​
Who it’s for

Requires pf.wizards.create permission (PERMISSIONS.PF.WIZARDS_CREATE), enforced by RequirePermission wrapping the page content.

​
Before you start

  • You must have the pf.wizards.create permission.
  • Choose the target Module that this wizard will serve (e.g., Recovery Housing, Human Resources, Clinical).
  • Choose a Wizard Type that reflects the wizard’s purpose (e.g., Onboarding, Admission, Configuration, Setup, Workflow, Custom).
  • The wizard name must be at least 3 characters long.

​
Steps

  1. Navigate to /fw/wizards/new or select “New Wizard” from the Wizard Templates page.
  2. Enter a Wizard Name (required, minimum 3 characters).
  3. Optionally enter a Description.
  4. Select a Module from the dropdown (defaults to fw — Forms & Workflows).
  5. Select a Wizard Type from the dropdown (defaults to custom).
  6. Select Create & Configure. The wizard template record is saved and the browser redirects to /fw/wizards/:id/edit for step configuration.

​
Key concepts

  • Module — Associates the wizard with a platform core (e.g., rh, hr, fa, cl). Determines where the wizard appears and which data contexts are available.
  • Wizard type — Classifies the wizard’s purpose: onboarding, admission, configuration, setup, workflow, or custom.
  • is_active — Wizards start inactive. Activation is configured in the builder after steps are defined.
  • DEFAULT_WIZARD_CONFIG — Applied at creation; SME should confirm which defaults are set.

Forms & Workflow

Forms & Workflow core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/fw.tsx
  • src/platform/wizards/pages/WizardCreatePage.tsx
  • src/platform/wizards/hooks/useWizardTemplateMutation.ts
  • src/platform/permissions/constants.ts