service-omni-sidebar-configure — Claude Code skill: setup guide
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.
Apache-2.0 103 installs ★ 1,183 updated 2026-10-23
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a claude-codeWhat service-omni-sidebar-configure does
Enables the Omni-Channel docked sidebar by setting isOmniPinnedViewEnabled=true inside CustomApplication metadata. The tool first checks the existing setting; if it is active, deployment is skipped. When false or missing, it updates the record through Metadata API and reads it back to confirm application.
Execution requires sf CLI 2.139.6 or newer with an authenticated org, python3 3.8+, jq 1.6+, and a Service Cloud license. It handles one Lightning console app at a time. If the developer name is omitted, it auto-adopts the app only when exactly one console exists, stopping with a blocked status if multiple are found.
What it helps with
- enable the pinned Omni-Channel utility sidebar on a Lightning console
- verify
isOmniPinnedViewEnabledmetadata round-trips - deploy targeted console settings without touching tabs or navigation
Example prompts for the agent
- Turn on the Omni-Channel sidebar for
SupportConsolein orgdemo-org - Check if the pinned Omni view is enabled in the default Lightning console
How to install service-omni-sidebar-configure
1Skills CLI (Vercel)
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a claude-code2Manually: put the files in place
~/.claude/skills/service-omni-sidebar-configure/SKILL.mdCopy the whole skill folder; for one project use .claude/skills/service-omni-sidebar-configure/
1Skills CLI (Vercel)
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a codex2Manually: put the files in place
.agents/skills/service-omni-sidebar-configure/SKILL.mdFor all projects use ~/.agents/skills/
1Skills CLI (Vercel)
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a cursor2Manually: put the files in place
.cursor/skills/service-omni-sidebar-configure/SKILL.mdCursor also reads .agents/skills/ and .claude/skills/
1GitHub CLI
gh skill install forcedotcom/sf-skills skills/service-omni-sidebar-configure2Manually: put the files in place
.github/skills/service-omni-sidebar-configure/SKILL.md1Skills CLI (Vercel)
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a gemini-cli2Platform CLI
gemini skills install https://github.com/forcedotcom/sf-skills --path skills/service-omni-sidebar-configureManually: put the files in place
.devin/skills/service-omni-sidebar-configure/SKILL.mdThe legacy .windsurf/skills/ path still works
Skills CLI (Vercel)
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a opencodeClaude.ai
Zip the folder and upload it in Settings → Capabilities → Skills
Step by step, with commands for each platform: How to install skills in Claude Code: five ways
Questions about service-omni-sidebar-configure
How to install service-omni-sidebar-configure in Claude Code?
Run npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a claude-code.
What does service-omni-sidebar-configure do?
It toggles isOmniPinnedViewEnabled to true in CustomApplication metadata and validates the change via round-trip retrieval.
What is required to run service-omni-sidebar-configure?
It needs an authenticated Salesforce org, Service Cloud license, sf CLI >= 2.139.6, python3 >= 3.8, jq >= 1.6, and completed base Omni-Channel configuration.
Source text
SKILL.md · Apache-2.0
---
name: service-omni-sidebar-configure
description: "Use to enable or verify the Omni-Channel sidebar on a Lightning console app. Triggers: enable the Omni sidebar, pin Omni-Channel in a console app, configure the Omni sidebar, turn on the Omni-Channel utility region, verify the pinned Omni widget. Do not use for Aura apps, standard apps, utility-bar-only Omni widgets, or to create a console app."
allowed-tools: Bash Read Write Edit Glob Grep
metadata:
version: "1.0"
domains: ["Service"]
minApiVersion: "66.0"
relatedSkills:
- "service-omni-base-settings-configure"
- "service-omni-channel-setup-coordinate"
accessCheck: "OrgPermissions.LightningService"
cliTools:
- tool: ["jq"]
semver: ">=1.6"
- tool: ["python3"]
semver: ">=3.8"
- tool: ["sf"]
semver: ">=2.139.6"
---
# service-omni-sidebar-configure
Enable the Omni-Channel **sidebar** — the pinned Omni utility region that docks to the side of a Lightning console app — by setting `isOmniPinnedViewEnabled=true` on that app's `CustomApplication` metadata and confirming the flag round-trips. This is the recommended Omni surface for console/demo orgs: reps see incoming work, presence, and the work list docked beside the record, rather than only in the collapsible utility bar. It runs once per console app and is invoked by `service-omni-channel-setup-coordinate` as the final rep-experience step.
## Inputs
```bash
bash scripts/enable-and-report.sh <org-alias> [app_developer_name]
```
- `org-alias` (required).
- `app_developer_name` (optional). The `CustomApplication` DeveloperName of the Lightning console app. When omitted, the skill queries `AppDefinition` for Lightning console apps: exactly one → adopt it; zero or many → `blocked` (name it explicitly).
## Preconditions and safety
- Target org authenticated via `sf` CLI, Service Cloud license, `sf` CLI ≥ 2.139.6.
- Omni-Channel base settings enabled (`service-omni-base-settings-configure`).
- The target must be a **Lightning console** app that is deployable as `CustomApplication` metadata. Standard apps and Aura apps are out of scope.
- The three-way `safe_to_write` production guard applies.
## Run
`enable-and-report.sh` resolves the target app, retrieves its `CustomApplication`, and reads the current `isOmniPinnedViewEnabled` value:
- already `true` → `reused` (no deploy).
- `false` or absent → sets it to `true` and deploys the single `CustomApplication` in one atomic Metadata API call, then **re-retrieves** to confirm the flag is `true` before reporting success.
The deploy uses explicit `--metadata "CustomApplication:<name>"` (never `--source-dir`) and is done on its own — Metadata deploys are atomic, so the app is left unchanged on any failure.
## Behavior
**Idempotent + non-destructive.** The skill only flips the single boolean; it never rewrites tabs, brand, or nav config. When the field is missing it is inserted in its XSD-ordered position (immediately before `<label>`); when present its value is replaced in place.
**Auto-detect is conservative.** It adopts an app automatically only when exactly one Lightning console app exists, so it can never silently pin the wrong app on an org with several.
## Output contract
A single JSON object: `status` ∈ `enabled` | `reused` | `blocked`, `app_developer_name`, `app_label`, `before` (bool), `after` (bool), `deploy_id`, `manual_actions`, `blocking_issue`.
- `enabled` — the flag was `false`/absent and is now verified `true`.
- `reused` — the flag was already `true`.
- `blocked` — no/many console apps found, retrieve/deploy failure, or the post-verify did not confirm `true`; `blocking_issue` explains and `manual_actions` names the fix or prerequisite skill.
## Limitations
- One app per invocation; run again for each console app that needs the sidebar.
- Lightning console `CustomApplication` only — not Aura, not standard apps, not the utility-bar Omni widget.
- Does not create or lay out the console app, its tabs, or the Omni utility item.
## References
| File | When to read |
|---|---|
| `references/api-notes.md` | CustomApplication `isOmniPinnedViewEnabled` schema/order, AppDefinition detection query, and retrieve/deploy notes |
© forcedotcom · Apache-2.0 · forcedotcom/sf-skills