モデルのチェック
エディターは作業中にモデルをチェックし、他の誰かが問題に気づく前に何が間違っているかを教えてくれます。チェックは2種類あり、プロセスのモデリング方法を確認するLintパネルと、BPMN自体が正しく形成されているかを確認する検証レポートです。
Lintパネル
ツールバーのLintをクリックするとパネルが開きます。ヘッダーには3段階の重大度ごとのカウントがリアルタイムで表示されます。
| 重大度 | 意味 |
|---|---|
| エラー | モデルに致命的な欠陥があり、実行可能なプロセスを表していません。 |
| 警告 | モデルは動作しますが、混乱やメンテナンスの問題を引き起こす可能性があります。 |
| 情報 | 提案です。読む価値はありますが無視しても安全です。 |
任意の問題をクリックすると、その問題が関連する要素が選択されスクロールされるため、探すことなく修正ができます。問題がなくなるとパネルには問題は見つかりませんでしたと表示されます。
クイックフィックス
いくつかの問題には「ゲートウェイの削除」や「要素の削除」、「重複フローの削除」など、ワンクリックで修正できるクイックフィックスがあります。クイックフィックスを適用した操作は通常の編集なので、Ctrl+Zで元に戻せます。
Lintがチェックする内容
チェック項目は主に以下のカテゴリに分かれます。
構造 - 全てのプロセスには開始と終了が必要
- スタートイベントやエンドイベントのないプロセスやサブプロセス。
- 複数の空のスタートイベントがあるプロセス。各入り口はタイプを付けるかスタートを統合する必要があります。
- 上流または下流に接続がなく暗黙的に開始や終了として働いている要素。
接続性 - 孤立した要素があってはいけない
- 入力も出力もない要素。
- 行き止まり（出力シーケンスフローがない）。
- 到達不能な要素（入力シーケンスフローがない）。
- 出所または先が存在しないシーケンスフロー。
- 重複したシーケンスフローで結ばれている2つの要素。
- 重複した要素ID。
ゲートウェイ - 分岐は明示的に
- 複数の出力フローがゲートウェイの役割をしている要素（暗黙の分岐）、または複数の入力フローが結合を行っている要素。
- 結合と分岐の両方を行うゲートウェイは分割が必要。
- 発散または収束と宣言されているのに誤った配線のゲートウェイ。
- 入力1、出力1のゲートウェイは結合も分岐もしていないため削除可能。
- イベントベースゲートウェイの後に中間キャッチイベントまたは受信タスク以外のものが続く。
- 条件付き兄弟フローのため条件が必要な出力フロー。
- 包括ゲートウェイや複雑ゲートウェイは排他または並列ゲートウェイより理論が難しいため警告される。
サブプロセスと終端イベント
- 埋め込みサブプロセス内の型付きスタートイベントは空のスタートを使う必要がある。
- イベントサブプロセスでは空のスタートイベントではなく型付きスタートが必要。
- 不要な終了イベントのTerminate。
命名とサイズ - 可読性
- 名前が無い要素。
- 動作動詞で始まっていないアクティビティ名（例:「請求書を承認する」、「通知を送る」）。
- 完了した状態を表現していないイベント名（例:「請求書受領済み」、「注文出荷済み」）。
- サブプロセスに分割する価値のある大きなプロセス。
- 入力または出力のパスが多すぎて、分岐を上流で分割または統合すべき要素。
検証レポート
キャンバスのコントロールには検証レポートを表示があり、インタラクティブリストではなくプレーンテキストのレポートとして同じ問題を示します。総問題数、その後に各問題の重大度と該当要素のIDが記されます。問題がなければその旨も表示します。
プロセスの作成時はLintパネルを使いましょう。問題をクリックして該当要素にジャンプできます。レビューのメモやチケット、メールに結果をコピーして共有したい場合は、要素IDが明確なので検証レポートが便利です。
プロセスドキュメントプレビュー
キャンバスのコントロールのプロセスドキュメントプレビューを表示は、モデルを文章としてレンダリングし、文章として読んだ時に意味不明な手順がないかをチェックできます。これはエクスポート > Markdown docsから得られる書き起こしと同じものです。
キャンバス上の通知
別の場所で作成されたモデルにキャンバスで描画できないものが含まれている場合、何も表示せずに無視するのではなく、通知が表示されます。通知は以下の内容をカバーしています。
- ドリルダウンビューが未描画で部分的な表示になっている。
- 位置情報がない要素は表示されない。
- プレースホルダーとして描かれる要素タイプ。
根底にあるBPMNはどちらの場合でも保持されます。通知は「図が不完全である」ことを示し、「ファイル自体が壊れている」ことを示すものではありません。
推奨される順序
- プロセスを描く。
- Lintを開き、エラー、次に警告を解消する。
- プロセスドキュメントプレビューを読んで、文章としてプロセスが意味を成しているか確認する。
- 経路をクリーンアップと配置 > 自動レイアウトで図を整える。
- 保存し、公開する。