Onboarding Wizard Walkthrough
Seventeen waypoints from zero to active, with skip-condition rules.
Seventeen waypoints from zero to active
The system onboarding wizard follows a fixed chain of waypoints. A number of them are vendor-gated: they appear only when the catalog declares that the step is relevant for this vendor. The admin can always go ← Back within the backable range (everything from vendor onward).
The steps at a glance
| Waypoint | What it does | When it is skipped |
|---|---|---|
Approach (vendor vs protocol) system_type |
Choose between an out-of-the-box vendor template (Entra, Workday, …) or a generic protocol (REST, LDAP, SCIM). | Never — the entry point of the wizard. |
Vendor / protocol selection vendor |
Which specific vendor or which protocol? Coming-soon entries are visible but not selectable. | Never. |
Role system_role |
AUTHORITATIVE_SOURCE (HR-leading) / TARGET (write-only) / BIDIRECTIONAL. Drives the default account-type templates and write mappings. |
Never. |
Name + description name_desc |
How the system shows up across RapidValue: display name plus description. Pre-filled from the vendor label. | Never. |
Auth method auth_method |
Which authentication method can the system use? Pre-filtered per vendor against supported_auth_methods. |
For vendors with only one method (auto-selected). |
Connectivity connectivity |
How does the platform reach this system? Direct (cloud) versus through a proxy agent in the customer network (plus agent selection). Tunnel mode is only offered for tunnel-capable engines. | Never (default: direct). |
Credentials auth_credentials |
A per-field form based on auth_field_specs. Secrets go straight to the vault. |
For auth_method=NONE. |
Base URL base_url |
Pre-filled from the vendor catalog; often editable for sandbox / production splits. | For protocols without a fixed URL template. |
Sync strategy (vendor-gated) sync_strategy |
Asks: "Do you have an upstream identity source that syncs into this system?" If yes, the native filter is adjusted to avoid duplicate provisioning. | For vendors without a declared sync-strategy spec (Entra / Workday / SuccessFactors today). |
Objects review objects_review |
Which catalog objects to import? A checkbox per object. The default is training-wheels: write_enabled=true per object, with writes gated behind batch approval until the tenant removes the gate. Visibility-only is a per-object opt-in afterwards (Systems page), not a default. |
Never for vendor templates; protocols start with an empty list. |
Account types (vendor-gated) account_types_review |
Per account type: scope (governance / visibility_only / excluded) plus a native filter. Materializes the account-type records. | For vendors without account-type templates. |
Account rules (vendor-gated) account_rules_review |
Per type: pre-filled classification and ownership rules, with checkboxes to apply them. | When no active type declares a rule default. |
Attribute selection (vendor-gated) attribute_selection |
Per object: which source attributes to fetch? Multi-select with categories (required / recommended / optional / hr_premium / extension). | For objects without an available_attributes catalog. |
Test + mapping editor test_and_map |
A live test query runs per object; the admin reviews the response and edits the mappings (Jinja expressions). | When every enabled object is visibility-only (write_enabled=false), the admin gets a "confirm inventory" checkbox instead of the editor. |
Provisioning config (vendor-gated) provisioning_config_review |
Default write mappings and lookups from the vendor catalog. Per mapping: sync mode plus the account types it applies to. Pre-fill hints where an ownership rule mismatches. | For source-only configurations without a governance scope. |
Sync schedule sync_schedule |
Interval (in minutes) or a cron expression for periodic sync. Default from the vendor catalog. Minimum interval is 15 minutes (0 = manual-only remains valid). | Never. |
Confirm + activate confirm_and_activate |
Final review plus an activate button. Triggers the first sync immediately. | Never. |
Back-navigation boundary
The pre-draft chain (system_type → base_url) is always safe to step back through. From objects_review onward the platform has created a system record, so back-navigation re-emits the form with the current database state. Stepping back further than objects_review is NOT possible: that would require tearing down the draft.
💡 Tip
Want to start over completely? Cancel the wizard (close the session) and start a new one — the draft system is cleaned up neatly on cancel.
Further reading: