Configuration Packs
Paste a configuration pack, review which settings it changes, decide on its packaged workflows, and apply it to your organization in one step.
A configuration pack sets up an organization in one step. It can carry
the workspace's navigation and vocabulary, the same settings as
UI configuration, and a Pipeline Pack with pipelines,
stages, custom fields, views and workflows. Open the Apply Configuration
Pack page at route /settings/configuration-packs; it has no entry in the
Settings menu. It's a Full mode page: in Simple mode, the route opens Settings
instead. Only owners and admins can apply a pack.
What a pack contains
A pack is JSON with up to four parts. It needs uiConfig, pipelinePack, or
both; anything else at the top level is rejected.
nameandversion(optional): the name appears in the review.uiConfig: navigation and vocabulary for the whole organization.pipelinePack: a Pipeline Pack with its ownpackKey, at least one pipeline (each needs a won and a lost stage), and optional custom fields, default views and workflows.
Review and apply a pack
-
Paste the pack's JSON into the Pack JSON box. If it isn't valid, the reason appears under the box and Apply to this organization stays unavailable.
-
Check the Review card. It shows what the pack changes in this organization only:
- Navigation: the navigation mode the pack sets, or Unchanged.
- Vocabulary: how many record types the pack renames.
- Pipelines / stages: how many pipelines and stages it adds.
- Fields / views: how many custom fields and views it adds.
The review shows counts. To see the exact names, read the JSON.
-
Decide on Include packaged workflows (see below).
-
Select Apply to this organization. When it finishes, the page says Configuration applied to this organization.
Packaged workflows
Include packaged workflows is off by default. It's unavailable when the pack has no workflows, and otherwise shows how many workflow declarations the pack has.
- Off: the pack's workflows are left out. Its pipelines, stages, custom fields and views are still applied.
- On: the pack's workflows are created and published along with the rest of the pack. Turn it on only after you've read each workflow in the JSON.
To add workflows later, build them in Workflows.
What Apply changes
- Navigation and vocabulary replace your organization's published UI configuration. Changes you made earlier in UI configuration are not merged in, so note anything you want to keep before you apply. Publishing also switches off Preview there.
- Pipeline Pack: Vertiqa checks it first; if the check fails, nothing is
changed. Then it adds the pipelines with their stages, the custom fields and
any views. A new pipeline doesn't become your default. If a pack with the
same
packKeyis already installed, Apply updates that installation instead.
If Apply stops partway, the page says what happened:
- Stopped before changes were applied: nothing changed. Fix the pack and apply it again.
- Stopped before pipeline changes were applied: the navigation and vocabulary are saved as an unpublished draft in UI configuration.
- Pipeline configuration was applied, but UI publishing stopped: select Apply to this organization again to publish the saved draft.
Check the result
- Pipelines lists the new pipelines with their stages.
- Custom fields shows the pack's fields.
- UI configuration shows the published navigation and vocabulary.
There's no one-step undo. Change navigation and vocabulary in UI configuration, and delete a pipeline you don't want in Pipelines, as long as no records use it.