mcpField
S
service-omni-sidebar-configure

service-omni-sidebar-configure

github.com/forcedotcomその他1.1k87 回インストール1 日前に更新
リポジトリ

service-omni-sidebar-configure について

Lightning コンソールアプリで固定 Omni-Channel サイドバーを有効にし、設定を検証する Salesforce スキルです。コンソール環境を整える管理者向けで、必要なメタデータフラグだけを変更します。

主な機能

  1. 01固定 Omni-Channel サイドバーの有効化
  2. 02コンソールアプリが1つの場合の自動検出
  3. 03デプロイ後の設定検証
  4. 04無関係なアプリ設定の非変更

活用シーン

  1. 01コンソールレコード横への Omni-Channel 固定
  2. 02サイドバー設定の有効状態の確認
  3. 031回につき1つのコンソールアプリを設定

インストール

コマンドをコピーしてターミナルで実行します。

$npx skills add https://github.com/forcedotcom/sf-skills --skill service-omni-sidebar-configure

インストール後、Claude Code で/service-omni-sidebar-configureを入力して読み込まれたか確認します。

同梱ファイル

SKILL.md と一緒にインストールされる参考資料やスクリプト。

references/
api-notes.md
scripts/
enable-and-report.sh
scripts/tests/
_bootstrap.py
test_sidebar_contracts.py

詳細

service-omni-sidebar-configure

Lightning コンソールアプリの横にドッキングする固定表示の Omni ユーティリティ領域である Omni-Channel サイドバーを有効にするには、そのアプリの CustomApplication メタデータで isOmniPinnedViewEnabled=true を設定し、フラグが往復して保持されることを確認します。これは、コンソール／デモ用の組織に推奨される Omni の表示領域です。担当者は、折りたたみ可能なユーティリティバーだけでなく、レコードの横にドッキングされた状態で、着信作業、プレゼンス、作業リストを確認できます。コンソールアプリごとに一度実行され、担当者のエクスペリエンスを整える最後の手順として service-omni-channel-setup-coordinate から呼び出されます。

入力

bash scripts/enable-and-report.sh <org-alias> [app_developer_name]
  • org-alias（必須）。
  • app_developer_name（任意）。Lightning コンソールアプリの CustomApplication の DeveloperName です。省略した場合、スキルは AppDefinition を検索して Lightning コンソールアプリを特定します。該当がちょうど 1 つの場合はそれを採用し、0 件または複数の場合は blocked となります（アプリ名を明示してください）。

前提条件と安全性

  • 対象組織が sf CLI で認証済みであること、Service Cloud ライセンスがあること、sf CLI が 2.139.6 以上であること。
  • Omni-Channel の基本設定が有効であること（service-omni-base-settings-configure）。
  • 対象は CustomApplication メタデータとしてデプロイできる Lightning コンソールアプリである必要があります。標準アプリと Aura アプリは対象外です。
  • 3 段階の safe_to_write 本番環境ガードが適用されます。

実行

enable-and-report.sh は対象アプリを特定し、その CustomApplication を取得して、現在の isOmniPinnedViewEnabled の値を読み取ります。

  • すでに true → reused（デプロイなし）。
  • false または値がない → true に設定し、単一の Metadata API 呼び出しでその CustomApplication のみをデプロイします。その後、再取得してフラグが true であることを確認してから成功を報告します。

デプロイには明示的な --metadata "CustomApplication:<name>" を使用し（--source-dir は使用しません）、単独で実行します。Metadata のデプロイはアトミックなため、失敗してもアプリは変更されません。

動作

冪等かつ非破壊的です。 このスキルは単一のブール値のみを切り替えます。タブ、ブランド、ナビゲーション設定を書き換えることはありません。フィールドがない場合は、XSD で定められた順序の位置（<label> の直前）に挿入します。フィールドがある場合は、その値をその場で置き換えます。

自動検出は慎重に行います。 Lightning コンソールアプリがちょうど 1 つ存在する場合に限り自動で採用するため、複数のアプリがある組織で誤ったアプリが知らないうちに固定表示されることはありません。

出力仕様

単一の JSON オブジェクトです。status は enabled、reused、blocked のいずれか、app_developer_name、app_label、before（ブール値）、after（ブール値）、deploy_id、manual_actions、blocking_issue を含みます。

  • enabled — フラグが false または未設定で、現在は true であることを確認済みです。
  • reused — フラグはすでに true でした。
  • blocked — コンソールアプリが見つからない、または複数見つかった場合、取得／デプロイに失敗した場合、あるいは事後確認で true を確認できなかった場合です。blocking_issue に理由を示し、manual_actions に修正方法または前提となるスキルを示します。

制限事項

  • 1 回の実行につき 1 つのアプリが対象です。サイドバーが必要なコンソールアプリごとに再実行してください。
  • 対象は Lightning コンソールの CustomApplication のみです。Aura アプリ、標準アプリ、ユーティリティバーの Omni ウィジェットは対象外です。
  • コンソールアプリ、そのタブ、Omni ユーティリティ項目の作成やレイアウト設定は行いません。

参照

ファイル読むタイミング
references/api-notes.mdCustomApplication の isOmniPinnedViewEnabled のスキーマ／順序、AppDefinition の検出クエリ、取得／デプロイに関する注意事項

コメント

Markdown 対応