（プレリリース）Spring '23 から Flow Builderの要素には説明をちゃんと書こう

# はじめに

Spring ’23のリリースノートが公開されましたね！その中でも Flow Builderの要素の説明が見やすくなるアップデートがあったのでどういう表示になるのか？を確認します。
今までより説明が見やすくなったことで説明の重要性が上がると思います。

https://help.salesforce.com/s/articleView?id=release-notes.rn_automate_flow_builder_see_element_descriptions_on_the_flow_canvas.htm&type=5&release=242

:::note warn
2022年12月現在Spring '23は、プレリリース組織での提供となってます。
:::

# なんで説明必要なの？

:::note
説明を書くことで、Spring '23 から Flow Builder全体の**可読性**があがるから
:::

Flow Builderとても便利ですよね？しかし一方でノーコードであるが故に**レビューや完成後のドキュメントが疎かになっていませんか？**
作ったFlowによっては〇〇さんに聞かないとわからなかったりエラー通知メールから障害箇所、原因を特定が遅くなってしまったり。

もちろん理想はドキュメントで仕様を管理することですが、ドキュメントを作るや更新をする仕組みや文化を作ろうと思うとなかなか大変です。
でも、Flowの一つの要素に説明をつけるくらいなら**簡単**じゃないですか？？
説明をつけると障害時に"なんでこのロジックでこの項目を更新するのか？"等もある程度わかると思います。

説明ではなく、要素名を詳しく書くというのもありだと思いますが
長文を書くと画像のように省略されてしまうため説明の方が適している場合が多いと思います。

![スクリーンショット 2022-12-25 2.39.53.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/0afd72f4-1362-37ed-2765-40b61209ee5a.png)

自分が作った業務の中心のFlowを**自分だけが管理していくわけではない**のでちゃんとみんなで書いていきましょう！！

# プレリリース組織へのサインアップ

sandboxのプレビュー組織がまだ公開されていないので
プレリリース組織を利用します。

https://admin.salesforce.com/blog/2022/admin-spring-23-release-dates-countdown

[こちら](https://www.salesforce.com/form/signup/prerelease-spring23/?_ga=2.2157040.1341412708.1671865956-1546668006.1603647587&_gl=1*lp0si*_ga*MTU0NjY2ODAwNi4xNjAzNjQ3NTg3*_ga_EE9XB9ZV8F*MTY3MTg2NzI4MS4xOC4xLjE2NzE4NjcyOTMuMC4wLjA.)からサインアップ

登録完了後、メール度届きますのでリンクをクリックしてログインできればOKです。

![ホーム _ Salesforce.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/57360059-96a4-b7de-4f8b-f20e07f4e4b5.png)

# Spring '23と以前とで比較するFlow

ハンズオン組織等にも入ってるサンプルの`ケースを作成`を使用します。

![ケースを作成 - V1.png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/fa5ad303-22a9-66a4-49f0-7f982a31052e.png)

## 説明を書く

![ケースを作成 - V1 (1).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/55272ede-c365-f521-3646-1a41162af810.png)

以下の内容をレコード取得要素の説明に書きました。

```text
入力した姓名・電話から取引先責任者を取得
```

理想は、ある程度決まったフォーマットでチームで書けているといいと思いますが。
今回はそこまではしません。

# 説明の見え方比較

|新|旧|
|---|---|
|![ケースを作成 - V1 (5).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/97457659-15eb-11d4-074e-2d43cf0862db.png)|![ケースを作成 - V1 (3).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/c4ab6a61-37f4-1556-98fb-fa371a946205.png)|

# 現在のFlow Builder上で説明を見る方法

## 1. Flow Builderを開く

![ケースを作成 - V1 (2).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/cc8bf273-1870-45e5-7bda-b8b1f06eacdc.png)

## 2. 確認したい要素をダブルクリックで開く

![ケースを作成 - V1 (3).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/c4ab6a61-37f4-1556-98fb-fa371a946205.png)

## よくないなと思うところ

自分が現状の説明要素のよくないなと思うところは以下です。

- 説明が**要素の中**にあることで、Flow Builder全体でみると説明の重要度が下がってしまう
    - 結果、書く人が減る

- 説明を見ながら周辺の要素を見ることが**できない**

# Spring '23のFlow Builder上で説明を見る方法

## 1. Flow Builderを開く

![ケースを作成 - V1 (4).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/73e6ebe6-3073-3a6d-1501-1c7f88e412e5.png)

## 2. 見たい要素の説明アイコンにカーソルを当てる

![ケースを作成 - V1 (5).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/97457659-15eb-11d4-074e-2d43cf0862db.png)

## いいなと思うところ

自分がSpring '23での説明要素のいいなと思うところは以下です。

- 説明が**要素の外**にあることで、Flow Builder全体でみると説明の重要度が以前より上がる
- 説明を見ながら周辺の要素を見ることが**できる**

## よくないなと思うところ

自分がSpring '23での説明要素のよくないなと思うところは以下です。

まだ、プレリリース段階なので今後のアップデートに期待ですが以下が気になりました。

- 説明アイコンにカーソルを当てあとに、他の箇所をクリックすると説明が消える
    - クリックで固定とかしてくれるとFlow Builder全体のコメントを見ながら実装ができる

- 説明のテキストに改行が反映されない
    - ある程度説明に記載するフォーマットを作ったとしても改行が反映されなければ逆に見辛くなってしまいますね

![ケースを作成 - V1 (7).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/8c27e56c-501c-ce43-a466-446d2d7d25cf.png)
![ケースを作成 - V1 (6).png](https://qiita-image-store.s3.ap-northeast-1.amazonaws.com/0/445600/6c8867d0-7f20-fe95-5022-096d9c2dc116.png)

# 最後に

いかがだったでしょうか？Spring '23からFlow Builderの**可読性**が上がったと思いませんか？
まだまだリリース前の新機能なのでFlow Builderの進化に期待ですね。
説明要素もしっかり書いてもらえると SalesforceDXでmetadataを落としてくる→xmlからドキュメントを自動生成みたいなのも現実的ですね！！
ちょっと、Salesforce CLIのpluginとしてやってみようと思います


# 参考

https://unofficialsf.com/spring-23-sneak-preview-flow-builder-orchestrator-slack-integrations/

https://help.salesforce.com/s/articleView?id=release-notes.rn_automate_flow_builder_see_element_descriptions_on_the_flow_canvas.htm&type=5&release=242