sf-vlocity-build-deploy について
Salesforce Vlocity DataPack のエクスポート、デプロイ、再試行、障害調査を支援するコーディングエージェント向けスキルです。デプロイ前検証、マニフェストによる範囲指定、CI/CD の手順に重点を置きます。
主な機能
- 01DataPack のエクスポートとデプロイ手順
- 02マニフェストによる対象範囲の選択
- 03デプロイ前のデータ検証
- 04再試行と中断ジョブへの対応
- 05依存関係と GlobalKey の調査
活用シーン
- 01Salesforce 組織間の DataPack 移行
- 02デプロイ失敗や部分完了の原因調査
- 03再現可能な DataPack CI/CD パイプラインの計画
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ jaganpro/ sf-skills --skill sf-vlocity-build-deployインストール後、Claude Code で/sf-vlocity-build-deployを入力して読み込まれたか確認します。
同梱ファイル
SKILL.md と一緒にインストールされる参考資料やスクリプト。
CREDITS.mdLICENSEREADME.mdexamples/business-internet-plus-bundle-deploy/deploy-business-internet-plus-bundle.yamlTRANSCRIPT.mdexamples/business-internet-plus-bundle/deploy-business-internet-plus-bundle.yamlTRANSCRIPT.mdreferences/job-file-template.mdtroubleshooting-matrix.md詳細
sf-vlocity-build-deploy:Vlocity Build DataPack のデプロイ
OmniStudio/Industries DataPack のエクスポート/デプロイワークフロー、マニフェスト駆動型のデプロイ、失敗の切り分け、CI/CD の順序付けなど、ユーザーが Vlocity DataPack のデプロイオーケストレーションを必要とする場合にこのスキルを使用します。
このスキルが担当するタスク
以下に関する作業では、sf-vlocity-build-deploy を使用します。
vlocity packDeploy、packRetry、packContinue、packExport、packGetDiffs、validateLocalData- DataPack ジョブファイルの設計(
projectPath、expansionPath、manifest、queries) - 組織間の DataPack 移行とリトライループ
- DataPack の依存関係、照合キー、GlobalKey の問題のトラブルシューティング
ユーザーが以下を行う場合は、別のスキルに委任します。
- 標準メタデータを
sf project deployでデプロイする → sf-deploy - OmniScripts、FlexCards、IP、Data Mappers を構築する →
sf-industry-commoncore-* - Product2 EPC バンドルを設計する → sf-industry-cme-epc-model
- Apex/LWC コードを記述する → sf-apex、sf-lwc
重要な運用ルール
- DataPack には
sf project deployではなく、**Vlocity Build(vlocity)**コマンドを使用します。 - 利用可能な場合は、ユーザー名/パスワードファイルよりも Salesforce CLI 認証連携(
-sfdx.username <alias>)を優先します。 - 完全なデプロイの前に、必ずデプロイ前の品質ゲートを実行します。
validateLocalData- 任意で
packGetDiffs - その後に
packDeploy
- エラー件数が減少している間は
packRetryを繰り返し実行し、リトライしても改善しなくなったら停止します。 - ソース組織とターゲット組織で、照合キーの方針と GlobalKey の整合性を一貫させます。
最初に収集する必須情報
以下を確認するか、推測します。
- ソース組織とターゲット組織のエイリアス
- ジョブファイルのパスと DataPack プロジェクトのパス
- デプロイ範囲(プロジェクト全体、マニフェストのサブセット、または特定の
-key) - エクスポート、デプロイ、リトライ、続行、差分のみのいずれか
- 名前空間モデル(
%vlocity_namespace%、vlocity_cmt、または core) - 既知の制約(新しいサンドボックスの初期設定、トリガーの動作、照合キーのカスタマイズ)
事前チェック:
vlocity help
sf org list
sf org display --target-org <alias> --json
test -f <job-file>.yaml
推奨ワークフロー
1. ツールの準備状況を確認する
npm install --global vlocity
vlocity help
2. プロジェクトデータをローカルで検証する
vlocity -sfdx.username <source-alias> -job <job-file>.yaml validateLocalData
--fixLocalGlobalKeys は、明示的に要求された場合に限り、影響を説明したうえで使用します。
3. ソースからエクスポートする(必要な場合)
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packExport
vlocity -sfdx.username <source-alias> -job <job-file>.yaml packRetry
4. ターゲットにデプロイする
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packDeploy
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packRetry
5. 中断したジョブを続行する
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packContinue
6. デプロイ後の整合性を確認する
vlocity -sfdx.username <target-alias> -job <job-file>.yaml packGetDiffs
ジョブファイルのひな形:references/job-file-template.md
発生頻度の高い失敗パターン
| エラー/症状 | 考えられる原因 | 基本的な修正方針 |
|---|---|---|
No match found for ... | ターゲット組織に依存関係がない | 不足している DataPack キーを含めて再デプロイする |
Duplicate Results found for ... GlobalKey | ターゲットにレコードが重複している | 重複を削除してデプロイを再実行する |
Multiple Imported Records ... same Salesforce Record | ソースに照合キーが重複するレコードがある | ソースの重複を削除し、再エクスポートする |
No Configuration Found | DataPack の設定が古い | packUpdateSettings を実行するか、autoUpdateSettings を有効にする |
Some records were not processed | 設定の不一致/依存関係の状態が不完全 | 両方の組織で設定を更新してから、再試行する |
| SASS/テンプレートのコンパイルエラー | 参照先の UI テンプレートアセットがない | 参照されているテンプレートの依存関係を先にエクスポート/デプロイする |
詳細な一覧:references/troubleshooting-matrix.md
CI/CD のガイダンス
デフォルトのパイプライン構成:
- 組織を認証します(
sf org login ...) - ローカルの DataPack の整合性を検証します(
validateLocalData) - 変更された範囲をエクスポートします(
packExportまたはマニフェスト主導のエクスポート) - デプロイします(
packDeploy) - 安定するまで再試行ループを実行します(
packRetry) - 比較し(
packGetDiffs)、デプロイレポートを公開します
増分デプロイを最適化するには、次のようなジョブファイルのオプションを使用します:
gitCheck: truegitCheckKey: <folder>- 確定的な範囲制御のための
manifest
スキル間の連携
| 必要なこと | 委任先 | 理由 |
|---|---|---|
| DataPack 以外のメタデータのデプロイ | sf-deploy | Metadata API のワークフロー |
| OmniStudio コンポーネントの作成 | sf-industry-commoncore-* | デプロイ前にビルド成果物を作成します |
| EPC の商品およびオファーのペイロード作成 | sf-industry-cme-epc-model | Product2/DataPack モデルの品質 |
| Apex トリガー/ログエラーの診断 | sf-debug、sf-apex | 自動化側の根本原因を修正します |
参照先一覧
まずはこちら
- references/job-file-template.md
- references/troubleshooting-matrix.md
- examples/business-internet-plus-bundle/TRANSCRIPT.md
- examples/business-internet-plus-bundle-deploy/TRANSCRIPT.md
外部リファレンス
完了形式
DataPack goal: <export / deploy / retry / diff / ci-cd>
Source org: <alias or N/A>
Target org: <alias or N/A>
Scope: <job file + manifest/key/full>
Result: <passed / failed / partial>
Key findings: <errors, dependencies, retries, diffs>
Next step: <safe follow-up action>
コメント
Markdown 対応