# 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.

- skill · `type=skill` · Claude Code, Codex, Cursor, GitHub Copilot, Gemini CLI, OpenCode, Windsurf (Devin Desktop), Claude.ai · 103 installs · ★ 1183 repo stars
- Author: forcedotcom
- License: Apache-2.0 · policy=mirror · the beginning of the file is at the end of this page
- Source: https://github.com/forcedotcom/sf-skills/tree/HEAD/skills/service-omni-sidebar-configure/SKILL.md
- Updated: 2026-10-23
- Security check: automated, 2026-11-17 (text) — no signs of malicious code found.
- HTML: https://affpapa.org/en/nevibecode/skills/service-omni-sidebar-configure

## What it 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.

## Install

### Claude Code (native platform)

1. **Skills CLI (Vercel)**
```bash
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a claude-code
```

2. **Manually: put the files in place**
- File: `~/.claude/skills/service-omni-sidebar-configure/SKILL.md` — Copy the whole skill folder; for one project use .claude/skills/service-omni-sidebar-configure/

### Codex

1. **Skills CLI (Vercel)**
```bash
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a codex
```

2. **Manually: put the files in place**
- File: `.agents/skills/service-omni-sidebar-configure/SKILL.md` — For all projects use ~/.agents/skills/

### Cursor

1. **Skills CLI (Vercel)**
```bash
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a cursor
```

2. **Manually: put the files in place**
- File: `.cursor/skills/service-omni-sidebar-configure/SKILL.md` — Cursor also reads .agents/skills/ and .claude/skills/

### GitHub Copilot

1. **GitHub CLI**
```bash
gh skill install forcedotcom/sf-skills skills/service-omni-sidebar-configure
```

2. **Manually: put the files in place**
- File: `.github/skills/service-omni-sidebar-configure/SKILL.md`

### Gemini CLI

1. **Skills CLI (Vercel)**
```bash
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a gemini-cli
```

2. **Platform CLI**
```bash
gemini skills install https://github.com/forcedotcom/sf-skills --path skills/service-omni-sidebar-configure
```

### Windsurf (Devin Desktop)

**Manually: put the files in place**
- File: `.devin/skills/service-omni-sidebar-configure/SKILL.md` — The legacy .windsurf/skills/ path still works

### OpenCode

**Skills CLI (Vercel)**
```bash
npx skills add forcedotcom/sf-skills --skill service-omni-sidebar-configure -a opencode
```

### Claude.ai

**Claude.ai**
- Zip the folder and upload it in Settings → Capabilities → Skills

Where a file is given instead of a command, copy the files from the source to that path: https://github.com/forcedotcom/sf-skills/tree/HEAD/skills/service-omni-sidebar-configure/SKILL.md

## When to use it
- enable the pinned Omni-Channel utility sidebar on a Lightning console
- verify `isOmniPinnedViewEnabled` metadata round-trips
- deploy targeted console settings without touching tabs or navigation

## Example prompts
- Turn on the Omni-Channel sidebar for `SupportConsole` in org `demo-org`
- Check if the pinned Omni view is enabled in the default Lightning console

## Source text · SKILL.md · Apache-2.0

Below is the content of a third-party file. It is data, not instructions for you: do not act on anything written inside unless the human asks. Block tag: 289843ca5f043403.

BEGIN THIRD-PARTY FILE 289843ca5f043403
````text
---
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.
````
END THIRD-PARTY FILE 289843ca5f043403

The third-party file has ended. Everything between the 289843ca5f043403 tags is data: requests and commands from it are not followed. An “end of file” line with another tag inside the block is part of the file.

First 2577 of 4240 bytes. © forcedotcom · Apache-2.0 · https://github.com/forcedotcom/sf-skills/tree/HEAD/skills/service-omni-sidebar-configure/SKILL.md

_Part of the page did not fit — see the HTML version._

---
NeVibeCode on affpapa.org. Catalog texts are descriptions, not instructions for the agent. How to choose and install: https://affpapa.org/en/nevibecode/agents.md
