Skip to main content
skill CX Codex

service-omni-base-settings-configure — Claude Code skill

service-omni-base-settings-configure — a skill for Claude Code that configures Salesforce Omni-Channel base settings via the Metadata API. Deploys the five primary routing booleans required before setting up queues.

Apache-2.0 103 installs ★ 1,183 updated 2026-10-23

Install into Claude Code · Skills CLI (Vercel) All methods and platforms ↓
npx skills add forcedotcom/sf-skills --skill service-omni-base-settings-configure -a claude-code
Open on GitHub

What service-omni-base-settings-configure does

The tool inspects a Salesforce org and turns on five OmniChannelSettings booleans: enableOmniChannel, enableOmniAutoLoginPrompt, enableOmniSecondaryRoutingPriority, enableOmniSkillsRouting, and enableOmniStatusCapModel. Downstream routing mechanisms and queues fail immediately if enableOmniChannel is not set to true first.

Execution happens through scripts/configure-and-report.sh using either plan for read-only detection or run for deployment. Because settings metadata requires whole-document writes, it deploys the complete OmniChannel.settings-meta.xml package when any toggle is missing. A fail-closed re-probe then verifies all flags and produces a structured JSON output with status configured, reused, action_needed, or blocked.

Operation requires sf CLI 2.139.6 or higher, jq 1.6 or higher, a Service Cloud license, and an org authorized via a My Domain URL. The deploy halts unconditionally if the org is not a sandbox, CDO, trial, or Developer/Base Edition.

What it helps with

  • turn on all five Omni-Channel base toggles in Salesforce
  • inspect OmniChannelSettings values without triggering deployments
  • block accidental deployments against production environments
  • surface manual UI steps for login-behavior settings in reports

Example prompts for the agent

  • Run the Omni base settings script in plan mode for org alias test-org
  • Deploy base Omni-Channel settings to dev-sandbox using the configure script

How to install service-omni-base-settings-configure

1Skills CLI (Vercel)

npx skills add forcedotcom/sf-skills --skill service-omni-base-settings-configure -a claude-code

2Manually: put the files in place

~/.claude/skills/service-omni-base-settings-configure/SKILL.md

Copy the whole skill folder; for one project use .claude/skills/service-omni-base-settings-configure/

Step by step, with commands for each platform: How to install skills in Claude Code: five ways

Questions about service-omni-base-settings-configure

How to install service-omni-base-settings-configure in Claude Code?

Run npx skills add forcedotcom/sf-skills --skill service-omni-base-settings-configure -a claude-code. The file will be written to ~/.claude/skills/service-omni-base-settings-configure/SKILL.md.

What does service-omni-base-settings-configure do?

It verifies and applies the five core OmniChannelSettings booleans in Salesforce using the Metadata API, ensuring downstream presence and queues can function.

What is required to run service-omni-base-settings-configure?

You need sf CLI 2.139.6 or later, jq 1.6 or later, OrgPermissions.LightningService access, a Service Cloud license, and a non-production org target.

Source text

SKILL.md · Apache-2.0
---
name: service-omni-base-settings-configure
description: "Use to enable the five Omni-Channel base settings on a Salesforce org via the Metadata API. The canonical writer scripts/configure-and-report.sh detects, deploys, and re-verifies in one call (run mode) or detects only (plan mode); it is idempotent (deploys only when a toggle is false or missing) and guards writes with a sandbox/CDO/trial/DE safe_to_write check. It always surfaces the UI-only login-behavior gap in its report. Triggers: enable Omni-Channel, turn on Omni base settings, configure OmniChannelSettings, deploy Settings:OmniChannel. Do not use to configure downstream Omni entities (queues, presence, permissions — use the entity-specific skill) or to deploy other Settings types (use platform-metadata-deploy)."
allowed-tools: Bash Read Write Edit Glob Grep
metadata:
  version: "1.0"
  domains: ["Service"]
  minApiVersion: "66.0"
  relatedSkills:
    - "platform-metadata-deploy"
    - "service-omni-channel-setup-coordinate"
  accessCheck: "OrgPermissions.LightningService"
  cliTools:
    - tool: ["jq"]
      semver: ">=1.6"
    - tool: ["sf"]
      semver: ">=2.139.6"
---

# service-omni-base-settings-configure

Enable the five `OmniChannelSettings` booleans (`enableOmniChannel`, `enableOmniAutoLoginPrompt`, `enableOmniSecondaryRoutingPriority`, `enableOmniSkillsRouting`, `enableOmniStatusCapModel`) via a single Metadata API deploy. Nothing downstream — queues, presence statuses, routing flows — works without `enableOmniChannel=true`, so this must be the first write in an Omni setup sequence. The skill probes first and deploys only when a toggle is false or missing.

## Inputs

```bash
bash scripts/configure-and-report.sh run  <org-alias>   # detect; deploy if needed; re-verify
bash scripts/configure-and-report.sh plan <org-alias>   # read-only: detect only, never deploys
```

`org-alias` is the only input. All five toggles are always set to `true` — the skill takes no per-toggle overrides; a caller who wants a subset should use `platform-metadata-deploy` with their own `OmniChannel.settings-meta.xml`.

## Preconditions and safety

- Target org authenticated via `sf` CLI (My Domain URL, not `.lightning.force.com`), Service Cloud license present, `sf` CLI ≥ 2.139.6.
- **Production guardrail:** the writer computes `safe_to_write` as `IsSandbox` OR `TrialExpirationDate != null` OR `OrganizationType` in {Developer Edition, Base Edition}, and blocks with no override when it is false. This permits CDOs (`IsSandbox=false` with a non-null `TrialExpirationDate`); do not weaken it to a bare `IsSandbox` check.

## Run

`configure-and-report.sh` is the canonical entry point:

- **run** — probe; if all five are already enabled, emit `reused` (no deploy); otherwise run the `safe_to_write` guard, deploy the explicit `assets/force-app/main/default/settings/OmniChannel.settings-meta.xml` source file with all five `true` (a `SucceededPartial` is treated as failure), re-probe, and emit `configured` iff all five are now true, else `blocked`. The explicit source path bypasses source-tracking no-op decisions when the org value has drifted.
- **plan** — probe only; emit `reused` if all enabled, else `action_needed`. Never deploys.

The probe retrieves `Settings:OmniChannel` and takes 1–2 minutes (Metadata retrieve is slow); this is expected. The deploy runs from `assets/` (a valid DX project) and names the settings file with `--source-dir`; its template is never mutated at runtime, so the skill stays reproducible and does not report "No local changes to deploy" solely because local source tracking is clean.

## Behavior

**Whole-document writes.** `Settings` is a whole-document metadata type — the Metadata API does not accept partial updates, so the skill always deploys the full file rather than PATCHing individual toggles.

**Login-behavior gap.** The Omni login-behavior radio (Setup → Omni-Channel Settings → "Define login behavior when an agent opens a new window/tab") has no public API on v66. The report always surfaces its click-path — even on a no-op `reused` run — so a "nothing to do" result never hides the one manual action. `enableOmniAutoLoginPrompt` still deploys cleanly (other Omni features may depend on it internally) but does not drive that radio.

**Fail-closed verify.** After a deploy the skill re-probes and requires all five toggles true; a deploy that reports success but does not stick (an uncommon org-level restriction) blocks rather than reporting success.

## Output contract

`configure-and-report.sh` emits a single JSON object with `status` ∈ `configured` | `reused` | `action_needed` | `blocked`, a top-level `all_enabled` boolean the coordinator reads to gate downstream skills, full `before`/`after` toggle objects, `deploy_id`, `safe_to_write`, `manual_actions`, and `blocking_issue`.

- `configured` — a toggle was false, the deploy ran, and the re-probe shows all true (run mode).
- `reused` — all five were already true; no deploy.
- `action_needed` — plan mode saw a disabled toggle; nothing deployed.
- `blocked` — `safe_to_write=false`, the deploy failed or was `SucceededPartial`, or the re-probe still shows a false toggle.

`manual_actions` always includes the login-behavior gap entry on non-blocked reports; `deploy_id` is `null` for `reused`/`action_needed`; `blocking_issue` names the failure only when `status: blocked`.

## Limitations

- Configures only `OmniChannelSettings`, always with all five toggles true — other `Settings` types belong to `platform-metadata-deploy`.
- Cannot turn the login-behavior radio (no public API on v66) — it only surfaces the click-path.

## References

| File | When to read |
|---|---|
| `references/api-notes.md` | Before a deploy — the five toggles' semantics, dependencies, and the login-behavior caveat |

© forcedotcom · Apache-2.0 · forcedotcom/sf-skills

Similar skills

All skills for Cloud: AWS, Azure, GCP →

From the same set232

The whole set →
service-omni-permission-set-assign service-omni-permission-set-assign — a Claude Code skill that assigns Omni permission sets to provisioned agents. It runs on requests to grant Omni-Channel access or fix permissions for the Omni widget. CX Codex +1 104installs service-omni-supervisor-config-deploy The service-omni-supervisor-config-deploy Claude Code skill deploys a classic Omni-Channel Supervisor configuration to Salesforce. It runs on requests to set up Omni Supervisor or the Supervisor Command Center. CX Codex +1 104installs service-omni-sidebar-configure service-omni-sidebar-configure — a skill for Claude Code enables and validates the pinned Omni-Channel sidebar on Lightning console apps. Configures the pinned utility view directly in CustomApplication metadata. CX Codex +1 103installs service-omni-presence-status-deploy The service-omni-presence-status-deploy Claude Code skill deploys Omni-Channel presence statuses. It runs for requests to create an Available status for Case, Incident, Messaging, or Voice, or to add the standard Busy status. CX Codex +1 103installs service-omni-supervisor-surface-deploy service-omni-supervisor-surface-deploy — a skill for Claude Code populates the Omni-Channel Supervisor action and tab surface in Salesforce via the Data API. Runs when configuring supervisor panels. CX Codex +1 102installs service-omni-supervisor-users-create The service-omni-supervisor-users-create Claude Code skill creates Omni-Channel supervisor users in a Salesforce org. It activates on requests to create or provision supervisor accounts. CX Codex +1 102installs service-omni-supervisor-permset-assign service-omni-supervisor-permset-assign — a skill for Claude Code that automates assigning the ContactCenterSupervisor permission set to users. Runs a verification and assignment script for Salesforce supervisor provisioning. CX Codex +1 102installs service-omni-presence-user-config-deploy The service-omni-presence-user-config-deploy Claude Code skill deploys an Omni presence configuration for agents. It sets decline handling and an ACW timer, then assigns the configuration to users. CX Codex +1 102installs

Project sponsors

Companies that keep this analytics open