Skip to content
ブログに戻る

CPQ DevKit™ for Salesforce を始める(VS Code での QCP 開発)

CPQ DevKit™ for Salesforce は、Salesforce CPQ Quote Calculator Plugin(QCP) 開発に特化した VS Code 拡張機能です。ブラウザーでの編集ループを、ローカルワークフローに置き換えます。src/ で編集し、SBQQ__CustomScript__c に同期し、通常のコードのように変更を差分比較します。

前提条件

  • VS Code と拡張機能のインストール(CPQConsultant.cpq-devkit-sf
  • Salesforce CPQ がインストールされた Salesforce 組織
  • CPQ パッケージ設定で QCP が有効化されていること(カスタムスクリプトレコードが使用されるようにするため)

主要なフォルダーとファイル

  • src/*.ts — ローカルの QCP スクリプト(エディター支援のために .ts として保存されますが、TypeScript ではなく有効な JavaScript を書く必要があります)
  • .cpqdevkit/sfcpq/qcp-config.json — 暗号化された組織の認証情報とファイル/レコードのマッピング(Git には含めないでください)
  • .cpqdevkit/sfcpq/qcp-log.json — 任意の同期ログ

1) プロジェクトを初期化して認証する

  1. VS Code で空のフォルダー(または既存のリポジトリ)を開きます。
  2. CPQ DevKit™ for Salesforce: Initialize Project を実行します。
  3. 組織のタイプ(Sandbox / Dev / Prod / Custom)を選択し、OAuth ログインフローを完了します。

認証が完了すると、拡張機能は認証情報を暗号化して .cpqdevkit/sfcpq/ 配下に保存し、誤ってコミットしないよう .gitignore を更新します。

2) QCP スクリプトを作成またはプルする

初期化後、スクリプトをワークスペースに取り込みます。

  • CPQ DevKit™ for Salesforce: Pull QCP records from Salesforce(すべてのスクリプトをプル)
  • CPQ DevKit™ for Salesforce: Create example QCP files in your project(サンプルを src/ に追加)

3) 簡単な動作確認

CPQ DevKit™ for Salesforce: Validate org credentials are valid を実行して、組織への接続とクエリが可能であることを確認します。

「TypeScript」に関する重要な注意

ファイルは .ts として保存されますが、Salesforce にプッシュされる前にコンパイルされません。TypeScript 固有の構文(型、enum、interface、as、デコレーターなど)は避け、ES6 互換の JavaScript を維持してください。