VS Code からフローをデプロイ

フローのループに関する記事からスターターフローをコピーしましたね。ここでは、そのフローを VS Code と Salesforce CLI で Salesforce 組織に取り込む方法を説明します。これは開発者向けの方法です。コードエディターを使いたくない場合は 画面フロー (Screen Flow) ガイド の手順に従ってください: コンポーネントを画面に置いて Config Name(設定名) を設定するだけです。

何ができるか: コピーした XML は、MultiDatePick コンポーネントを組み込んだ、すぐに使える画面フローです。一般的なオブジェクトと項目にあらかじめ接続されています。一度デプロイしたら、いくつかの API 名を組織に合わせて変更するだけです。所要時間は初回で約 15 分、2 回目以降は数分です。

1. 必要なもの

無料のツールが 3 つ。一度インストールすれば、今後のデプロイにずっと使えます:

  • Visual Studio Code: コードエディター。
  • Salesforce Extension Pack: VS Code に SFDX コマンドを追加します。拡張機能パネルからインストールします (「Salesforce Extension Pack」で検索)。
  • Salesforce CLI (sf): デプロイを実行するコマンドラインツール。VS Code のターミナルで sf version を実行して、インストールされていることを確認します。

2. 初回のみの準備

組織に接続済みの SFDX プロジェクトで作業している場合は、このセクションを飛ばしてください。

A 組織を認証する

VS Code を Salesforce 組織に接続します。コマンドパレット (Ctrl/Cmd + Shift + P) を開いて SFDX: Authorize an Org を実行するか、ターミナルで次を実行します:

sf org login web --alias myorg

ブラウザーが開くので、ログインして承認します。本番組織ではなく、まず Sandbox か Developer 組織で試してください。

B プロジェクトを開くか作成する

SFDX プロジェクトがあれば、そのフォルダーを VS Code で開きます (File → Open Folder)。なければ作成します:

sf project generate --name multidatepick-flows
cd multidatepick-flows

次に、そのフォルダーを VS Code で開きます。エクスプローラーパネルに force-app/main/default/ の構成が表示されるはずです。

3. コピーした XML を取り込む

1 フローファイルを作成する

エクスプローラーで force-app/main/default/ を展開し、flows フォルダーを開きます (なければ作成します)。フロー名を付けた .flow-meta.xml で終わる新しいファイルを追加します。例: On_Call_Rotation.flow-meta.xml。この名前がフローの API 名になるため、英字、数字、アンダースコアだけを使ってください。

VS Code の統合ターミナルから直接作成することもできます:

# Windows (PowerShell)
New-Item force-app/main/default/flows/On_Call_Rotation.flow-meta.xml -ItemType File -Force
# macOS / Linux
mkdir -p force-app/main/default/flows && touch force-app/main/default/flows/On_Call_Rotation.flow-meta.xml

2 貼り付けて保存する

フローのループに関する記事からコピーしたスターターフローの XML を新しいファイルに貼り付け、保存します (Ctrl/Cmd + S)。

3 組織にデプロイする

エクスプローラーでファイルを右クリックして SFDX: Deploy Source to Org を選ぶか、ターミナルで次を実行します:

sf project deploy start --source-dir force-app/main/default/flows/On_Call_Rotation.flow-meta.xml

出力パネルに Deploy Succeeded と表示されるのを確認します。項目やオブジェクトのエラーが報告されても想定どおりです。次の手順で解決します。

4. Flow Builder で仕上げる

4 オブジェクト名と項目名を差し替える

組織で [設定] → [フロー] に移動し、デプロイしたフローを開きます。>>> UPDATE と書かれた要素とメモを探してください。サンプルが前提としているオブジェクトと項目の API 名 を示しています。それぞれを自社のオブジェクト、日付項目、参照項目に合わせて変更します。最後に 保存 して 有効化 します。

あとはフローをページやボタンに配置するか、直接実行すれば、ユーザーが日付を選べるようになります。

コマンドのまとめ:
sf org login web --alias myorg                 # authorize once
sf project generate --name multidatepick-flows  # only if you need a new project
sf project deploy start --source-dir force-app/main/default/flows/YOUR_FLOW.flow-meta.xml
CLI でつまずいたら、Salesforce の CLI セットアップガイド でインストールとログインの詳細を確認できます。

フローのデプロイ完了。次は?

ライブデモでコンポーネントの動作を確認したり、コード不要の Config Name による方法を学んだり、MultiDatePick が Salesforce AppExchange に登場した日に通知を受け取ったりできます。

原因のわからないデプロイエラーは Support@MultiDatePick.com まで