業務ロジック仕様
本ドキュメントは、運航調整機能の業務ロジック仕様を定義する。
開発は下記のフェーズで段階的に行うため、フェーズにより仕様が異なる内容がある場合は、その旨を記載する。
| フェーズ | 説明 ||---|---|| Sprint1 | 周りのコンポーネントがない状態で、運航調整機能単体で、単純なパターンの正常系のみ動かせるようにする。周りのコンポーネントの情報を使う場合はダミーデータを使う。認証は対象外。 || Sprint2 | 周りのコンポーネントと結合する。認証は対象外(4.1.1)。デモで行うパターンを全て動かせるようにする。 || forDemo | デモ向けに簡素化した仕様。 Sprint2と同じ内容を適用する。 || future | 将来的な仕様。 |2. 機能概要
Section titled “2. 機能概要”運航調整機能は、飛行計画が重複した際に、その重複を解消するために、UTM間で運航調整をするための機能である。
下記の機能をAPIで提供する。
- 重複情報の管理
- 重複通知の受信(重複情報の登録)
- 重複解除通知の受信(重複情報の更新)
- 重複情報の取得
- 運航調整情報の管理
- 調整依頼の開始(運航調整情報の登録)
- コンテキストを作成してDBへ登録 (コンテキストIDを採番)
- 重複相手のUTMへ調整開始を通知 (コンテキスト情報を共有)
- 調整依頼の実行(運航調整情報の更新)
- 1つのコンテキストと調整条件を指定してターンを開始 (セッションが開始していない場合はセッションも開始) し、DBを更新
- 対応するコンテキストIDを対応する重複情報にセットすることで、重複情報と運航調整情報を紐付け
- 重複相手のUTMへ調整依頼を通知
- 調整依頼回答の受信(運航調整情報の更新)
- 重複相手のUTMから調整依頼回答(合意 or 否認)を受信し、DBを更新
- 調整開始の受信(運航調整情報の登録)
- 重複相手のUTMから調整開始を受信し、共有されたコンテキスト情報をDBへ登録
- 調整依頼の受信(運航調整情報の更新)
- 重複相手のUTMから調整依頼を受信し、DBを更新
- 対応するコンテキストIDを対応する重複情報にセットすることで、重複情報と運航調整情報を紐付け
- 調整依頼回答の実行(運航調整情報の更新)
- 重複相手から共有された調整依頼内容に対して、調整依頼回答(合意 or 否認)を指定し、DBを更新
- 重複相手のUTMへ調整依頼回答を通知
- 運航調整情報の取得
- 調整依頼の開始(運航調整情報の登録)
2.1. 実行元によるAPI分類
Section titled “2.1. 実行元によるAPI分類”| 実行元 | API | 認証方式(forDemo) | 認証方式(Sprint1) ||---|---|---|---|| フロントエンド(UI) | 重複情報の取得、運航調整情報の取得、調整依頼の開始、調整依頼の実行、調整依頼の回答実行 | 未定 | 認証なし || 対向UTM | 調整開始の受信、調整依頼の受信、調整依頼回答の受信 | 公開鍵方式 (公開鍵を事前に配布して共有) | 認証なし || DIPS Connector (UTM Backends内部コンポーネント) | 重複通知の受信、重複解除通知の受信 | 認証なし | 認証なし |3. 用語定義
Section titled “3. 用語定義”| 用語 | 意味 |
|---|---|
| UTM (ドローン運行管理システム) | 通報先のDIPS、飛行のためのGCSと連携し、UASのオペレーター向けに飛行計画通報の支援を提供する。また、飛行計画が他の飛行計画と重複した際に、他UTM/ビジターと調整して重複を解消することを支援する。 |
| DIPS (ドローン情報基盤システム) | 日本国内でドローンを飛行させるために必要な「機体登録」「飛行許可・承認申請」「飛行計画の通報」などの手続きを、オンライン上で一元管理できるシステム。運航調整機能においては、運航調整のトリガーとなる飛行計画の重複判定をDIPSで行い、重複通知をUTMに送信する。 |
| 飛行計画 | 航空法で定められた「特定飛行」を行う際に、あらかじめ飛行の日時、場所(経路)、高度、目的、操縦者などの詳細情報を国土交通省が運用するDIPSを利用して通報する制度。 |
| USS | 本ドキュメント内ではUTMとほぼ同義。他社USS向けのAPIでは、“USS”という単語を用いる。それ以外の部分では”USS”という単語はできるだけ使わず、“UTM”を使うこと。 |
| 運航調整 | 飛行計画が重複したときに、重複解消するために重複した人と重複された人の間で調整すること。 |
| 運航調整プロトコル | UTM間で運航調整の通信をするためのプロトコル。 |
| 依頼者 (requester) | 飛行計画が重複したとき、相手に調整を依頼する人。依頼者と調整対象者の関係はセッション・ターンごとに入れ替わることがある。 |
| 調整対象者 (responder) | 飛行計画が重複したとき、相手に調整を依頼された人。依頼者と調整対象者の関係はセッション・ターンごとに入れ替わることがある。 |
| Operator (運航者) | UTM管理の元、ドローンを運航させる人。飛行計画作成・調整や動態監視を担う。運航調整を行う際は、依頼者、または調整対象者となる。 |
| Organization Manager (組織管理者) | Operatorが所属する組織の管理者。組織のメンバー管理を担う。Operatorが可能な操作に加えて、組織管理のための操作ができる。 |
| Visitor (ビジター) | 飛行計画調整のため、一時的にUTMを利用するドローンを運航させる人。運航調整を行う際は、依頼者、または調整対象者となる。 |
| System Operator (運用管理者) | UTMサービスの運用を担う人 |
| UTM Backends | UIと繋がり飛行計画管理、制限空域、運航調整などを担うWeb Backend Server |
| 運航調整コンテキスト | 運航調整情報の一番大きな単位であり、ある重複において、運航調整を開始する際に作成する。 |
| 運航調整ターン | 運航調整情報の一番小さな単位であり、調整依頼を相手に送信する際にターンを開始し、相手から回答(合意 or 否認)が返ってきた際にターンを終了する。 |
| 運航調整セッション | 運航調整情報の二番目に大きな単位であり、運航調整プロトコルタイプによっては、複数のターンが1つのセッションに含まれる。 |
| 運航調整プロトコルタイプ | 運航調整において、シングルターン、マルチターン(Continuous)、マルチターン(Alternating)の3種類のどれを使うかを表す。運航調整コンテキストに定義し、調整相手に共有する。「6.7. 運航調整プロトコルタイプ」参照。 |
| シングルターン | 1つのセッションでターンが1つのみのタイプ。ターンが終了するとセッションも終了する。 |
| マルチターン | 1つのセッションで複数回のターンが回せるタイプ。ターンが終了後、同じセッションで次のターンを開始可能。 |
| マルチターン(Continuous) | 一度目の調整(ターン)が否認で完了後、前回の依頼者側が連続で調整依頼実行可能。 |
| マルチターン(Alternating) | 調整依頼は連続で実行できず、交互に実行可能。 (前回の依頼者側は連続で調整依頼実行不可)ただし、セッションが終了し、次のセッション開始時の最初のターンでは、前回の依頼者側からでも調整依頼実行可能。 |
| DIPS Connector | DIPSから重複通知をPub/Subで受け取り、運航調整機能にAPIで重複を通知するUTM Backendsの機能。 |
| 調整結果通知 | 本ドキュメント内では「調整依頼回答の実行」(送信側) or 「調整依頼回答の受信」(受信側)と同義。 |
| 調整条件 | 調整依頼の際に指定する条件。4種類のタイプがある。「6.6. 調整条件」参照。 |
4. 機能配置
Section titled “4. 機能配置”- 運航調整機能は、UTM Backendsに含まれる形で実装する。
- Sprint1時点ではUTM Backendsが存在しなかったため単体で実装し、Sprint2でUTM Backendsへ統合した(PR #40)。
4.1. Sprint1の制約
Section titled “4.1. Sprint1の制約”Sprint1時点の制約と、Sprint2(forDemo)以降の状況を記載する。
4.1.1. 認証
Section titled “4.1.1. 認証”Sprint1では、認証サービスは存在しないため、認証なしで実装する。
Sprint2(forDemo)以降も、認証は行わない(UTM間API・フロントエンド向けAPI・DIPS Connector向けAPIのいずれも認証なし)。
TODO(#341) TODO(#342)
4.1.2. DIPS Connector
Section titled “4.1.2. DIPS Connector”Sprint1では、DIPS Connectorは存在しないため、以下のAPIを認証なしで手動でCurlで叩けるように実装する。
- 重複通知の受信
- 重複解除通知の受信
forDemoでは、UTM Backends側にDIPS Connectorが実装されるまでの暫定対応として、DIPS Connector相当の機能 (模擬DIPSからのMQTT通知受信、上記2APIに相当する処理の呼び出し)を運航調整機能自体に一時的に実装する。 詳細は下記を参照。
- docs/coordination/DipsConnector_forDemo.md
TODO(#374)
4.1.3. フロントエンド(UI)
Section titled “4.1.3. フロントエンド(UI)”Sprint1では、フロントエンド(UI)は存在しないため、以下のAPIを認証なしで手動でCurlで叩けるように実装する。
- 重複情報の取得
- 運航調整情報の取得
- 調整依頼の開始
- 調整依頼の実行
- 調整依頼回答の実行
Sprint2(forDemo)以降は、フロントエンド(UI)と結合し、上記APIを画面から呼び出す。認証は行わない(4.1.1)。
TODO(#342)
4.1.4. 対向先UTM
Section titled “4.1.4. 対向先UTM”Sprint1では、対向先UTM無しでも確認できるよう、以下のAPIを認証なしで手動でCurlで叩けるように実装する。
- 調整開始の受信
- 調整依頼の受信
- 調整依頼回答の受信
また、対向先UTMの宛先を設定ファイルで、正常系の応答のみ返すMockに切り替えられるように実装する。
Sprint2(forDemo)以降は、対向先UTM(他社のUTM)と結合し、相互に運航調整を行う。認証は行わない(4.1.1)。 対向先UTMを用意できない環境での確認のため、Mockへの切り替えは引き続き利用できる。
TODO(#341)
4.1.5. UTM Backends
Section titled “4.1.5. UTM Backends”Sprint1では、UTM Backendsが存在しないため、下記の処理が必要な場合は、以下のように実装する。
- 飛行計画の取得
- UTM Backendsの機能を使って取得するのではなく、固定のダミーデータを使う。
- 運航者情報の取得
- UTM Backendsの機能を使って取得するのではなく、固定のダミーデータを使う。
ただし、Sprint1では、上記両方とも不要であるため、ダミーデータの作成や返却モジュールの作成は不要。
Sprint2(forDemo)以降の状況は下記のとおり。
- 飛行計画の取得
- 運航調整期限の算出(6.1.1・6.1.2)に使う想定だが、forDemoでも取得は行わず、Sprint1と同じ暫定値を設定している。
- TODO(#334)
- 運航者情報の取得
- DIPSの重複通知に含まれない情報は、USSIDごとのデフォルト値で補う(DipsConnector_forDemo.md「uss_default_infoテーブル」)。
- 飛行計画の更新・DIPS通報
- 飛行計画自動修正案の採用時に、UTM Backendsの機能を呼び出す(6.8.3)。
5. 保持データ
Section titled “5. 保持データ”運航調整機能では、下記の情報を保持する。
- 重複情報
- 運航調整情報
運航調整機能では、下記の情報は保持しない。
- 飛行計画情報
- DIPS通報済の飛行計画は、DIPSで保持
- 自社UTM利用者の飛行計画はUTM Backends内のDBでも保持
- 運航者情報
- 自社UTM利用者の運航者情報はUTM Backends内のDBで保持
5.1. 重複情報
Section titled “5.1. 重複情報”重複情報は、主に下記の情報を含む。
- 自分の飛行計画ID: self_flight_plan_id
- 相手の飛行計画ID: opponent_flight_plan_id
- 自分の運航者識別子: self_operator_id
- 相手の運航者識別子: opponent_operator_id
- 自分の運航者識別子に対応するメールアドレス: self_mail_address
- 相手の運航者識別子に対応するメールアドレス: opponent_mail_address
- 自分のUTMエンドポイントURL: self_utm_endpoint_url
- 相手のUTMエンドポイントURL: opponent_utm_endpoint_url
- 自分のUTM利用タイプ: self_utm_usage_type
- 相手のUTM利用タイプ: opponent_utm_usage_type
- 運航調整コンテキストID: context_id
- 重複情報と運航調整情報の紐付けのために設定する情報
- 運航調整コンテキスト期限: context_timeout
- 重複状態フラグ: conflict_flag
forDemoでは、上記のうちDIPSの重複通知に含まれない項目(self/opponent_operator_id、self/opponent_mail_address、
self/opponent_utm_usage_type、self_utm_endpoint_url)をUSSIDごとのデフォルト情報テーブル
(coordination.uss_default_info)から補う。値の決定方針の詳細は下記を参照。
- docs/coordination/DipsConnector_forDemo.md
5.1.1. 重複情報の取得
Section titled “5.1.1. 重複情報の取得”重複情報の取得処理の仕様は下記とする。
- 指定可能パターン
- A. self_flight_plan_id + opponent_flight_plan_id
- B. self_flight_plan_id
上記に加え、重複状態フラグ(conflict_flag) によるフィルタを任意で指定可能とする。
複数件存在する場合、全件を返す。
5.1.2. 画面表示用重複情報
Section titled “5.1.2. 画面表示用重複情報”フロントエンド(UI)側で重複あり/なしを表示するための情報として、 下記の画面表示用情報を保持する。
- 重複状態フラグ: conflict_flag
また、重複情報の取得のレスポンスに下記の画面表示用情報を加える。
- 画面表示用情報
- 画面表示用運航調整状態: display_coordination_status
- 調整依頼実行可能フラグ: coordination_request_possible_flag
- 調整依頼回答実行可能フラグ: coordination_response_possible_flag
上記の情報はDBには格納せず、重複情報の取得を実行された際の読取り時に、下記の対応表の内容で都度算出する。
- docs/coordination/CoordinationStatus_MappingTable_forDisplay.md
5.1.3. 同一の飛行計画の組み合わせに対する複数の重複情報
Section titled “5.1.3. 同一の飛行計画の組み合わせに対する複数の重複情報”重複が解消した際は、該当の重複情報の重複状態フラグをfalseへ更新し、レコードは残す。
同じ飛行計画の組み合わせで再度重複した場合は、既存のレコードを重複中へ戻さず、新規レコードを登録する
(docs/coordination/sequence/detail/forDemo/Coordination_SequenceDetail_Conflictions_forDemo.mdの2-A-B)。
過去の重複と、それに対して行った運航調整を履歴として残すためである。
そのため、同一の飛行計画の組み合わせに対する重複情報は複数件存在しうる。参照時の扱いは下記とする。
- 重複中(重複状態フラグがtrue)の重複情報は、1つの組み合わせにつき常に1件までとする。
DBの部分ユニークインデックス(
uq_confliction_active)で担保する - 「現在の重複」を対象とする処理(重複通知・重複解消通知の受信、調整開始・調整依頼の実行と受信、 自動調整設定の更新)は、飛行計画IDの組み合わせで取得した重複中の1件を対象とする。 全件が解消済の場合は最新の1件を対象とする(重複解消済であることを判定するため)
- 運航調整コンテキストが確定している処理(調整依頼回答の実行と受信)は、飛行計画IDの組み合わせに加えて 運航調整コンテキストIDを指定し、対象を一意に特定する
- 飛行計画自動修正案の登録は、自分の飛行計画IDで取得した重複情報のうち、重複中のものを対象とする
- 重複情報の取得(5.1.1)は画面表示用であり、絞り込み条件に該当するものを全件返す(履歴を含む)
TODO: FOLLOWUP 317-01
5.2. 運航調整情報
Section titled “5.2. 運航調整情報”運航調整情報は、主に下記の情報を含む。
- コンテキスト
- コンテキストID: context_id
- 自分の飛行計画ID: self_flight_plan_id
- 相手の飛行計画ID: opponent_flight_plan_id
- 運航調整プロトコルタイプ: protocol_type
- コンテキスト期限: context_timeout
- コンテキスト状態: context_status
- セッション間のインターバル: session_interval
- インターバル解除時刻: interval_cancellation_time
- セッション
- セッションID: session_id
- セッション期限: session_timeout
- セッション状態: session_status
- ターン
- ターンID: turn_id
- ターン期限: turn_timeout
- ターン状態: turn_status
- 運航調整プロトコルの送受信内容: body
- JSONB 形式で保持
- 調整依頼の実行時に相手側のUTMへ送信するリクエストボディの内容をそのまま格納する
- 調整依頼回答受信時には更新しない
- 調整依頼の受信時に相手側のUTMから受信したリクエストボディの内容をそのまま格納する
- 調整依頼回答送信時には更新しない
- 調整条件、任意のテキスト等、相手側のUTMと送受信したリクエストボディの内容が含まれる
- 画面表示用情報
- 画面表示用運航調整状態: display_status
- 調整依頼実行可能フラグ: request_possible_flag
- 調整依頼回答実行可能フラグ: response_possible_flag
5.2.1. 運航調整情報の履歴
Section titled “5.2.1. 運航調整情報の履歴”運航調整情報は、ターンごとに履歴レコードを保持する。
- 該当ターンで自分側が依頼者側の場合
- 調整依頼の実行時
- 採番したセッションID、ターンIDのレコードを作成
- 調整依頼回答の受信時
- 調整依頼の実行時に作成したレコードを更新 (ターン状態を更新することで回答内容を反映)
- 調整依頼の実行時
- 該当ターンで相手側が依頼者側の場合
- 調整依頼の受信時
- 相手からAPIで指定されたセッションID、ターンIDでレコードを作成
- 調整依頼回答の実行時
- 調整依頼の受信時に作成したレコードを更新 (ターン状態を更新することで回答結果を反映)
- 調整依頼の受信時
コンテキスト作成時(調整依頼の開始/調整開始の受信時)には、ターン・セッション情報を持たないレコードを1件作成する。
- 調整依頼の開始実行時
- 採番したコンテキストIDのレコードを作成
- 調整開始の受信時
- 相手からAPIで指定されたコンテキストIDでレコードを作成
該当コンテキストIDの最新レコードは、当該context_idを持つレコードのうちcreated_atが最大のものとする。
5.2.2. 調整依頼回答の結果の保持
Section titled “5.2.2. 調整依頼回答の結果の保持”ターン毎の調整依頼回答の結果(合意 or 否認)は、ターン状態(Agreed or Disagreed)で保持する。
そのため、運航調整プロトコルの送受信内容 (body) には、調整依頼回答の結果は保持しない。
状態遷移については、「6.4. 状態遷移」参照。
5.2.3. 運航調整情報の取得
Section titled “5.2.3. 運航調整情報の取得”運航調整情報の取得処理の仕様は下記とする。
- 指定可能パターン
- A. self_flight_plan_id + opponent_flight_plan_id + context_id
- B. context_id
- C. self_flight_plan_id + opponent_flight_plan_id + context_id + session_id + turn_id
- D. context_id + session_id + turn_id
上記指定可能パターンのうち、A と B は、履歴含め情報が複数件存在する可能性がある。 複数件存在する場合、「最新のレコード」(created_atが最大のもの) 1件のみを返す。
5.2.4. 画面表示用運航調整情報
Section titled “5.2.4. 画面表示用運航調整情報”フロントエンド(UI)側で運航調整状況、調整依頼実行ボタン、調整依頼回答実行ボタンを表示するための情報として、 下記の画面表示用情報を保持する。
- 画面表示用情報
- 画面表示用運航調整状態: display_status
- 調整依頼実行可能フラグ: request_possible_flag
- 調整依頼回答実行可能フラグ: response_possible_flag
上記の情報は、コンテキスト状態、セッション状態、ターン状態を元に、下記の対応表で算出する。
- docs/coordination/CoordinationStatus_MappingTable_forDisplay.md
5.3. DBテーブル定義
Section titled “5.3. DBテーブル定義”運航調整機能のDBテーブル定義は、下記の内容に従う。
- db/schema/coordination.sql
Sprint2でUTM Backendsと統合した際も、運航調整機能のテーブルはcoordinationスキーマに置き、構造は変えていない。
5.3.1. 論理削除カラムの用途
Section titled “5.3.1. 論理削除カラムの用途”is_deleted 論理削除カラムを各テーブルに用意しているが、現時点では削除のトリガーがなく、TRUE になることはない。
削除のトリガーは、削除機能が要件として必要になった時点で検討する。GET系 APIでは削除済のデータは対象に含めない想定であるため、未削除のデータに絞り込んで取得する。
5.4. 飛行計画自動修正案情報 (issue #112)
Section titled “5.4. 飛行計画自動修正案情報 (issue #112)”10月デモ向けに、AIによる飛行計画自動修正機能の暫定実装を追加する。詳細は以下を参照。
- https://github.com/ix-reamo/utm-backend/issues/100
- https://github.com/ix-reamo/utm-backend/issues/112
自動提案API(AIによる自動生成)は10月デモでは実装しない。修正後の飛行計画情報は、実行者が相手からの調整依頼内容と整合するよう事前に用意し、Curlで直接登録する運用とする(「6.8. 自動修正」参照)。 自動承認フラグ(AIの提案を自動で承認するフラグ)は10月デモでは常時OFF固定とし、設計・実装の対象外とする。
5.4.1. 重複情報への追加項目
Section titled “5.4.1. 重複情報への追加項目”重複情報(5.1節)に、下記を追加保持する。
- 自動修正フラグ: auto_correction_flag
- ONの場合、調整相手から調整依頼を受けた際に、飛行計画自動修正案登録APIで登録された修正案を採用できる状態になる。
- 10月デモでは画面を持たず、Curlによる手動切替のみとする。
- 10月デモ向けの暫定対処として、重複情報の登録時点からONとする(本来の既定はOFFで、対象の重複情報にだけ
Curlで切り替える)。デモでは用意したシナリオ以外に、来場者へ説明しながら運航調整を操作する場面があり、
その都度Curlでフラグを立てられないため。本フラグは登録済みの修正案を採用できる状態にするだけで、
自動修正案の生成・登録を引き起こすものではないため、自動修正を使わないケースへの影響はない。
暫定対処の実体は
ReceiveConflictionUseCaseのAUTO_CORRECTION_FLAG_DEFAULTで、デモ後はOFFへ戻す。 TODO: FOLLOWUP 319-01 - TODO: FOLLOWUP 320-02
- 飛行計画自動修正案存在フラグ: auto_correction_proposal_exists_flag
- 対応する飛行計画自動修正案情報(5.4.2節)が存在するかどうか。
- 飛行計画自動修正案ID: auto_correction_proposal_id
- 飛行計画自動修正案存在フラグがtrueの場合のみ設定。
5.4.2. 飛行計画自動修正案情報
Section titled “5.4.2. 飛行計画自動修正案情報”飛行計画自動修正案情報は、下記を保持する新規テーブル(coordination.auto_correction_proposal)とする。 重複情報:飛行計画自動修正案情報は1:1とする(10月デモでは1つの飛行計画に複数の重複が同時発生するケースは対象外のため、「6.8. 自動修正」参照)。 TODO(#339)
- 飛行計画自動修正案ID
- 対応する重複情報ID
- 対応する自分の飛行計画ID(登録時に指定された値。DIPS管理の文字列型)
- 修正後の飛行計画情報: flight_plan_body
- UTM Backendsの飛行計画詳細取得APIのレスポンス(FlightPlanDetailResponse)と同形式のJSONを、内容を解釈せずそのまま格納する(5.2節の運航調整プロトコルの送受信内容(body)と同様の設計判断)
- 変更案生成理由: generation_reason (issue #149)
- 自動修正案を生成した理由(生成のトリガー・判断根拠等)を自然文で保持する。
- 登録APIでの指定は任意とし、指定がない場合はNULL(取得APIのレスポンスにも含めない)。Outlookカレンダーの変更を契機に自動修正案を自動生成する場合(issue #149)に指定される想定。
- 内容はバックエンドでは解釈せず、指定された文字列をそのまま格納・返却する。
- 自動修正案採用状態: adoption_status
- 未決定(Undecided)/ 採用(Adopted)/ 不採用(Rejected)
- ユーザーの採否判断そのものを表す
- 自動修正案実行状態: execution_status
- 未着手(NotStarted)/ 合意回答完了(AgreementDone)/ UTM側更新完了(UtmUpdateDone)
- 採用時に実行する各処理の進行状況を表す(「6.8.3. 飛行計画自動修正案への回答(採用時)の処理」参照)
5.4.3. DBテーブル定義
Section titled “5.4.3. DBテーブル定義”db/schema/coordination.sqlの内容(重複情報テーブルへの追加カラム、飛行計画自動修正案情報テーブルの新設)に従う。
6. 主な仕様
Section titled “6. 主な仕様”6.1. 運航調整期限
Section titled “6.1. 運航調整期限”運航調整のコンテキスト、セッション、ターンはそれぞれ期限を持つ。
6.1.1. コンテキスト期限
Section titled “6.1.1. コンテキスト期限”コンテキスト期限は、重複通知の受信時に、下記のように設定する。
- 重複通知に含まれる、自分の飛行計画IDと相手の飛行計画IDを指定して、UTM Backendsの機能を使って、それぞれの飛行計画情報を取得
- 両者の飛行計画に含まれる飛行終了時刻のうち、早い方の時刻をコンテキスト期限として設定
ただし、Sprint1では、飛行計画情報取得は行わず、現在時刻から2週間後をコンテキスト期限として設定する。
TODO(#334)
調整依頼の開始時は、下記を行う。
- 運航調整情報のコンテキスト期限のカラムに、対応する重複情報のコンテキスト期限を設定する
- 重複相手のUTMへ調整開始を通知する際、設定したコンテキスト期限を指定する
調整開始の受信時は、下記を行う。
- 重複相手のUTMから調整開始を受信し、共有されたコンテキスト情報をDBへ登録する際、相手から指定されたコンテキスト期限を設定する
- 対応する重複情報のコンテキスト期限と異なる場合でも、このタイミングでは重複情報側のコンテキスト期限は更新しない (自分側と相手側のどちらのコンテキストを使って運航調整を行うかこのタイミングでは未確定のため)
調整依頼の実行時、または調整依頼の受信時に、下記を行う。
- 対応するコンテキストIDを対応する重複情報にセットすることで、重複情報と運航調整情報を紐付けする際に、合わせて重複情報側のコンテキスト期限を(運航調整のコンテキスト期限と異なる場合は)更新する
6.1.2. セッション期限
Section titled “6.1.2. セッション期限”セッション期限は、調整依頼の実行時、または、調整依頼の受信時に、下記のように設定する。
- APIで指定された時刻とする。
- ただし、指定された時刻がコンテキスト期限以降の場合、セッション期限は指定された時刻ではなく、コンテキスト期限と同じ時刻を設定する。
- APIで指定されなかった場合は下記のルールでシステム側で設定する。
- 自分の飛行計画IDと相手の飛行計画IDを指定して、UTM Backendsの機能を使って、それぞれの飛行計画情報を取得
- 両者の飛行計画に含まれる飛行開始時刻のうち、早い方の時刻が現在時刻よりも2週間以上後の場合
- 現在時刻から1週間後の時刻とする
- 早い方の時刻が現在時刻よりも1週間以上後の場合
- 現在時刻から1日後の時刻とする
- 早い方の時刻が現在時刻よりも1日以上後の場合
- 現在時刻から1時間後の時刻とする
- 早い方の時刻が現在時刻から24時間以内の場合
- 現在時刻から10分後の時刻とする
- 両者の飛行計画に含まれる飛行開始時刻のうち、早い方の時刻が現在時刻よりも2週間以上後の場合
- 自分の飛行計画IDと相手の飛行計画IDを指定して、UTM Backendsの機能を使って、それぞれの飛行計画情報を取得
ただし、Sprint1では、APIで指定されなかった場合は、飛行計画情報取得は行わず、コンテキスト期限と同じ時刻をセッション期限として設定する。
TODO(#334)
6.1.3. ターン期限
Section titled “6.1.3. ターン期限”ターン期限は、調整依頼の実行時、または、調整依頼の受信時に、下記のように設定する。
- APIで指定された時刻とする。
- ただし、指定された時刻がコンテキスト期限以降の場合、ターン期限は指定された時刻ではなく、コンテキスト期限と同じ時刻を設定する。
- APIで指定されなかった場合はセッション期限と同じ時刻を設定する。
6.2. セッション間のインターバル
Section titled “6.2. セッション間のインターバル”セッションが終了し、次のセッションを開始可能になるまでは一定時間インターバルを設ける(Blocked状態)。
インターバルの時間は、調整依頼の開始時に指定された時間とする。
インターバル経過後、コンテキスト状態はNegotiableへ遷移する(docs/coordination/state/forDemo/StateTransition_Coordination_Context_SimpleVerForDemo.pu)。この遷移は下記2つの経路で反映する。
- 調整依頼の実行時(自分側が依頼者):
interval_cancellation_timeを経過しているBlockedコンテキストを、その場でNegotiableとみなして以降の判定を行う(この経路ではDB上のcontext_status自体は更新しない。後述のスイープ処理が反映するまでの間も、再依頼の受理判定自体は待たせないため) - 定期実行のスイープ処理:
interval_cancellation_timeを経過したBlocked状態のコンテキスト(コンテキストごとの最新レコード)を、一定間隔でNegotiableへ更新する。画面表示用情報(display_status・request_possible_flag)もあわせて算出し直すため、GET /api/v1/coordination/coordinationsの応答にも反映される(フロントエンドが「調整依頼実行」ボタンの活性判定に使用)- ポーリング間隔は
coordination.sweep.interval-secondsで設定する(既定60秒、forDemo環境向け) - 今後追加予定の期限切れ判定(
docs/coordination/state/future/StateTransition_Coordination_Context.puの「調整期限を経過」)も、同じスイープ処理の枠組みに追加していく想定
- ポーリング間隔は
6.3. コンテキストオーナー変更
Section titled “6.3. コンテキストオーナー変更”調整開始通知をお互いが同時に送り合った場合、その後の運航調整を行う際に使うコンテキストはいずれか片方に後述のルールで決定し、使わない方のコンテキストはContextOwnerChanged状態とする。
- 運航調整を行うコンテキストの決定ルール
- 先に調整依頼通知を送って受諾された側 (相手側は調整依頼通知受信まで調整依頼通知送信していない状態) のコンテキストを使う
- 調整依頼も同時に送り合った場合は、運航者識別子の番号順で番号の小さい方のコンテキストを使う
ただし、forDemoまでは、お互いが同時に送り合うケースは実装・テストの対象外とする。
TODO(#335)
6.4. 状態遷移
Section titled “6.4. 状態遷移”コンテキスト、セッション、ターンそれぞれの状態は、下記の状態遷移のルールに従って遷移させる。
6.4.1. コンテキストの状態遷移
Section titled “6.4.1. コンテキストの状態遷移”下記のplantumlファイルの内容に従う。
- docs/coordination/state/future/StateTransition_Coordination_Context.pu
ただし、forDemoまでは、コンテキストオーナー変更や期限切れの仕様は対象外とした、下記の内容に従う。
- docs/coordination/state/forDemo/StateTransition_Coordination_Context_SimpleVerForDemo.pu
TODO(#334) TODO(#335)
6.4.2. セッションの状態遷移
Section titled “6.4.2. セッションの状態遷移”運航調整プロトコルタイプ毎に、下記のplantumlファイルの内容に従う。
- 運航調整プロトコルタイプがシングルターンの場合
- docs/coordination/state/future/StateTransition_Coordination_Session_SingleTurn.pu
- 運航調整プロトコルタイプがマルチターン(Continuous)の場合
- docs/coordination/state/future/StateTransition_Coordination_Session_MultiTurn_Continuous.pu
- 運航調整プロトコルタイプがマルチターン(Alternating)の場合
- docs/coordination/state/future/StateTransition_Coordination_Session_MultiTurn_Alternating.pu
ただし、forDemoまでは、シングルターンのみ対象とし、コンテキストオーナー変更や期限切れの仕様は対象外とした、下記の内容に従う。
- docs/coordination/state/forDemo/StateTransition_Coordination_Session_SingleTurn_SimpleVerForDemo.pu
TODO(#333) TODO(#334) TODO(#335)
6.4.3. ターンの状態遷移
Section titled “6.4.3. ターンの状態遷移”下記のplantumlファイルの内容に従う。
- docs/coordination/state/future/StateTransition_Coordination_Turn.pu
ただし、forDemoまでは、期限切れの仕様は対象外とした、下記の内容に従う。
- docs/coordination/state/forDemo/StateTransition_Coordination_Turn_SimpleVerForDemo.pu
TODO(#334)
6.5. OpenAPI
Section titled “6.5. OpenAPI”OpenAPI定義はAPIの実行元毎に下記に定義する。
- 実行元が対向UTMのAPI
- docs/openapi/openapi_astm.yaml
- 実行元がフロントエンド(UI)のAPI
- docs/openapi/openapi_coordination_backend.yaml
- 実行元がUTM Backends内部コンポーネントのAPI
- docs/openapi/openapi_coordination_backend_internal.yaml
openAPI定義は、futureフェーズ向けの内容で定義し、forDemo向けに制約を入れたものは作成しない方針。
6.6. 調整条件
Section titled “6.6. 調整条件”調整条件には、下記の4種類のタイプがある。
- AVOID_OVERLAP : 重複解消
- 対向UTMとのopenAPI定義内では、「重複解消するようにどいて」に対応
- AVOID_OVERLAP_WITH_DIRECTION : 調整方向指定での重複解消
- 対向UTMとのopenAPI定義内では、「重複解消するように調整方向を教えるからどいて」に対応
- MOVE_FROM_HERE : ここから移動
- 対向UTMとのopenAPI定義内では、「ここからどいて」に対応
- MOVE_TO_HERE : ここへ移動
- 対向UTMとのopenAPI定義内では、「ここにして」に対応
ただし、forDemoまでは、MOVE_FROM_HERE のみを対象とし、その他の調整条件タイプは対象外とする。
TODO(#336)
6.6.1. AVOID_OVERLAP
Section titled “6.6.1. AVOID_OVERLAP”特に条件を与えず、調整相手に重複を解消してほしい場合に使うことを想定。
6.6.2. AVOID_OVERLAP_WITH_DIRECTION
Section titled “6.6.2. AVOID_OVERLAP_WITH_DIRECTION”調整相手に飛行計画の調整方向を指定して、その方向に調整してほしい場合に使うことを想定。
時間・方角・高度の調整方向を指定可能。(最低1つは指定) 複数指定した場合は、AND条件で指定するかOR条件で指定するかも指定する。
- 時間の調整方向
- Later: 後ろへ
- Earlier: 前へ
- 方角の調整方向
- North: 北へ
- East: 東へ
- West: 西へ
- South: 南へ
- 高度の調整方向
- Up: 上へ
- Down: 下へ
6.6.3. MOVE_FROM_HERE
Section titled “6.6.3. MOVE_FROM_HERE”自分の飛行計画の時間帯、高度、エリアを指定して、調整相手にその時間帯・範囲外で飛行計画を調整してほしい場合に使うことを想定。
時間帯、高度、エリアの組み合わせをAND条件の1セットとして、複数セット指定可能。 複数セット指定した場合は、セット毎の関係はAND条件となる。(指定した全ての範囲からどいてもらうため)
- 時間帯
- 飛行計画の開始時刻
- 飛行計画の終了時刻
- 高度
- 飛行計画の最低高度
- 飛行計画の最高高度
- エリア
- 下記の何れか1つ
- 飛行計画のエリア情報(多角形)
- 多角形の頂点となる、地表上の点(緯度・経度)を3点以上指定
- 飛行計画のエリア情報(円)
- 円の中心となる地表上の点(緯度・経度)
- 円の半径
- 飛行計画のエリア情報(多角形)
- 下記の何れか1つ
6.6.4. MOVE_TO_HERE
Section titled “6.6.4. MOVE_TO_HERE”時間帯、高度、エリアを指定して、調整相手にその時間帯・範囲内で飛行計画を調整してほしい場合に使うことを想定。
時間帯、高度、エリアの組み合わせをAND条件の1セットとして、複数セット指定可能。 複数セット指定した場合は、セット毎の関係はOR条件となる。(指定したいずれか1つの範囲に入ってもらえば良いため)
- 時間帯
- 飛行計画の開始時刻
- 飛行計画の終了時刻
- 高度
- 飛行計画の最低高度
- 飛行計画の最高高度
- エリア
- 下記の何れか1つ
- 飛行計画のエリア情報(多角形)
- 多角形の頂点となる、地表上の点(緯度・経度)を3点以上指定
- 飛行計画のエリア情報(円)
- 円の中心となる地表上の点(緯度・経度)
- 円の半径
- 飛行計画のエリア情報(多角形)
- 下記の何れか1つ
6.7. 運航調整プロトコルタイプ
Section titled “6.7. 運航調整プロトコルタイプ”運航調整プロトコルには、下記の3種類のタイプがある。
- SINGLE_TURN : シングルターン
- MULTI_TURN_CONTINUOUS : マルチターン(Continuous)
- MULTI_TURN_ALTERNATING : マルチターン(Alternating)
運航調整の開始の際、コンテキストに上記情報を格納することで、該当の運航調整をどのタイプで行うかを調整相手と共有する。
ただし、forDemoまでは、シングルターンのみを対象とし、その他の運航調整プロトコルタイプは対象外とする。
TODO(#333)
6.7.1. シングルターン
Section titled “6.7.1. シングルターン”1つのセッションでターンが1つのみのタイプ。 一度目の調整(ターン)が否認で終了後、セッションも終了する。
-
合意でターンが終了した場合の仕様
- セッションは残り、重複解除通知受信時にセッションが終了する
- 合意でターン終了後、同じセッションで次のターン(調整依頼)を実行することはできない
- 合意でターンとセッションが両方とも終了後、次のセッションを開始することはできない
-
否認でターンが終了した場合の仕様
- セッションもターンと同時に終了する
- 次のターン(調整依頼)を実行するには、次のセッションで行う必要がある
- ただし、次のセッション開始には、セッション間のインターバルの時間分間隔を空ける必要がある
6.7.2. マルチターン
Section titled “6.7.2. マルチターン”1つのセッションでターンが複数のタイプ。 一度目の調整(ターン)が否認で終了後、セッションは残り、同じセッションで次のターン(調整依頼)を実行可能。
- 合意でターンが終了した場合の仕様
- セッションは残り、重複解除通知受信時にセッションが終了する
- 合意でターン終了後、同じセッションで次のターン(調整依頼)を実行することはできない
- 合意でターンとセッションが両方とも終了後、次のセッションを開始することはできない
否認でターンが終了した場合の仕様は、Continuous と Alternating で異なる。
6.7.2.1. マルチターン(Continuous)
Section titled “6.7.2.1. マルチターン(Continuous)”一度目の調整(ターン)が否認で終了後、前回の依頼者側が連続で調整依頼実行可能。(前回の調整対象者側からも調整依頼実行可能)
6.7.2.2. マルチターン(Alternating)
Section titled “6.7.2.2. マルチターン(Alternating)”調整依頼は連続で実行できず、交互に実行可能。 (前回の依頼者側は連続で調整依頼実行不可) ただし、セッションが(セッション期限切れにより)終了し、次のセッション開始時の最初のターンでは、前回の依頼者側からでも調整依頼実行可能。
6.8. 自動修正 (issue #112)
Section titled “6.8. 自動修正 (issue #112)”10月デモでは、自動提案API(AIによる自動生成)は実装せず、修正後の飛行計画情報を実行者がCurlで直接登録する運用とする(「5.4. 飛行計画自動修正案情報」参照)。 自動承認フラグは10月デモでは常時OFF固定であり、設計・実装の対象外とする。
6.8.1. 提供API
Section titled “6.8.1. 提供API”下記のAPIを、実行元がフロントエンド(UI)のAPI(2.1節)としてdocs/openapi/openapi_coordination_backend.yamlに定義する。ただし「自動調整設定の切り替え」「飛行計画自動修正案の登録」の2APIは、10月デモでは画面を持たず、Curlによる手動実行を想定する。
- 自動調整設定の切り替え(
PATCH /api/v1/coordination/conflictions/auto-coordination-setting) - 飛行計画自動修正案の登録(
POST /api/v1/coordination/auto-correction-proposals) - 飛行計画自動修正案の取得(
GET /api/v1/coordination/auto-correction-proposals/{id}) - 飛行計画自動修正案への回答(
PATCH /api/v1/coordination/auto-correction-proposals/{id})
「自動調整設定の切り替え」APIは、現時点では自動修正フラグ(auto_correction_flag)のみを設定対象とするが、
将来的に自動承認フラグ(issue #100参照)等を同じ設定として追加する想定のため、auto-correction(自動修正)
ではなく汎用的なauto-coordination(自動調整)という語をリソース名に用いている(PR #129レビュー対応)。
個々の設定項目(フィールド)自体の名称は、その項目が指す内容に応じてauto_correction_flagのように
具体的な語を用いる。
6.8.2. 飛行計画自動修正案登録APIの受付条件
Section titled “6.8.2. 飛行計画自動修正案登録APIの受付条件”以下の全てを満たす場合のみ受け付ける。いずれかを満たさない場合はエラーとする。
- 指定された自分側飛行計画IDに対応する重複情報が「重複あり」の状態で存在すること
- 本APIで指定する自分側飛行計画IDはUTM管理のID(UUID)である(issue #249)。重複情報はDIPS管理の飛行計画ID(文字列型)で管理しているため、受付条件の判定に先立ち、DIPS通報履歴からDIPS管理の飛行計画ID(受付番号)を解決する
- 重複情報自体が存在しない場合は404エラーを返す
- 対象の飛行計画が存在しない場合・DIPS未通報で受付番号が採番されていない場合も、重複情報を特定できないため404エラーを返す(呼び出し側から見て「対象の重複情報が無い」という同じ結果であり、区別しない)
- 重複情報は存在するが重複解消済(重複状態フラグがfalse)の場合は、reasonにCONFLICT_RESOLVEDを設定した406エラーを返す
- 該当重複情報の調整依頼回答実行可能フラグ(coordination_response_possible_flag)がtrueであること
- 満たさない場合、reasonにRESPONSE_NOT_POSSIBLEを設定した406エラーを返す
- 該当重複情報の自動修正フラグがtrueであること
- 満たさない場合、reasonにAUTO_CORRECTION_FLAG_OFFを設定した406エラーを返す
- 該当重複情報に既存の飛行計画自動修正案が登録されていない(飛行計画自動修正案存在フラグがfalse)こと、
または登録済みでも採否が未決定(自動修正案採用状態がUndecided)であること
- 満たさない場合、reasonにPROPOSAL_ALREADY_EXISTSを設定した406エラーを返す
- 10月デモ向けの暫定対処として、未決定の場合は既存の飛行計画自動修正案を論理削除し、新しい修正案へ 置き換える。 日付等を誤って登録した修正案を、登録APIの再実行で取り直せるようにするため。 削除APIを別に設けるとフロントエンド側の対応が必要になるため、登録APIの再実行で置き換える形とした。 採用済み・却下済みの場合は置き換えない(採用済みは合意回答の送信・飛行計画の更新・DIPS通報まで 実行済みで、修正案だけを差し替えても実際の飛行計画と整合しないため)。デモ後は「登録済みなら406」へ戻す
- 置き換えは登録済みの修正案を行ロックしたうえで行う。同時に実行された別の登録が先に置き換えを終えていた 場合は、後から実行された側もPROPOSAL_ALREADY_EXISTSを設定した406エラーとする(そのまま登録すると、 先に登録された修正案が重複情報から外れて未決定のまま残るため)
- TODO: FOLLOWUP 320-01
受付時、飛行計画自動修正案情報テーブルへ修正後の飛行計画情報を登録し(自動修正案採用状態はUndecidedで初期化)、対応する重複情報の飛行計画自動修正案存在フラグをONにし、飛行計画自動修正案IDへ採番したIDを設定する。
変更案生成理由(generation_reason、issue #149)が指定されている場合は、あわせて登録する。任意項目であり、受付条件の判定には用いない。登録後の変更は行わない(飛行計画自動修正案への回答時も更新対象外)。
6.8.3. 飛行計画自動修正案への回答(採用時)の処理
Section titled “6.8.3. 飛行計画自動修正案への回答(採用時)の処理”10月デモで受け付けるのは「採用」のみとする(「却下」「修正して採用」は10月デモでは対象外。フロントエンド側の画面にはボタンを表示するが、押しても本APIは呼ばれない想定)。
TODO(#338)
採用時、以下を順に実行する。
- 調整相手への合意回答(「調整依頼回答の実行」6.4.2節・7.1節5と同様の処理を行う)
- 完了時、自動修正案実行状態をAgreementDoneに更新する
- UTM Backends側の飛行計画更新API呼び出し
- 完了時、自動修正案実行状態をUtmUpdateDoneに更新する
- UTM Backends側のDIPS通報API呼び出し
本APIが再実行された場合、自動修正案実行状態を見て完了済みの処理をスキップし、未完了の処理から再開する。DIPS通報(3)の完了有無は自動修正案実行状態には含めず、UTM Backends側の既存のDIPS通報状態(report_status)を参照して判別する(飛行計画更新APIを呼ぶとreport_statusが未通報に戻る仕様のため)。
上記1〜3はいずれも外部への副作用を伴い、後段が失敗しても前段は取り消せない。全体を1つのトランザクションで行うと、後段の失敗で自動修正案実行状態まで巻き戻り、再実行時に合意回答を相手へ二重送信することになる。そのため処理ごとにトランザクションを分け、完了した時点で状態を確定させる。各処理の開始時に対象の飛行計画自動修正案を取り直して実行要否を判定するため、分割しても同時実行(画面の二度押し等)で同じ処理が二重に走ることはない。
DIPS通報(3)はトランザクションの外で呼び出す。UTM Backends側のDIPS通報は、模擬DIPSの応答で状態が決まるため外部呼び出しをトランザクション外に置く構成をとっており、本APIのトランザクションで包むとその前提を壊すため(外部の応答を待つあいだ行ロックを保持することになる)。
7. 処理の流れ (外部コンポーネントとの関係観点)
Section titled “7. 処理の流れ (外部コンポーネントとの関係観点)”外部コンポーネントとの関係観点での処理の流れを示す。 運航調整機能内部の詳細処理は、「8. 処理の流れ (運航調整機能内部観点)」を参照すること。
7.1. 基本的な処理の流れ (自分側のUTMが調整依頼の送信側の場合)
Section titled “7.1. 基本的な処理の流れ (自分側のUTMが調整依頼の送信側の場合)”-
- 重複通知の受信
- 1-1. DIPSからPub/Subで通知された重複通知をDIPS Connectorが受信
- 1-2. DIPS Connectorが「重複通知の受信」APIで運航調整機能に通知
- 1-3. 「重複通知の受信」APIの処理で、DBに重複情報を登録 (重複状態フラグはtrueで登録)
-
- 重複情報の取得
- 2-1. フロントエンド(UI)から自分の飛行計画IDを指定して「重複情報の取得」APIを実行し、重複情報を取得
- 2-2. フロントエンド(UI)で重複情報を一覧表示 (自分の飛行計画と重複している、相手側の飛行計画ID一覧)
- 2-3. 一覧から調整依頼を行う1件を選択 (ここで相手側の飛行計画IDが一意に決まる)
-
- 調整依頼の開始
- 3-1. フロントエンド(UI)から自分の飛行計画IDと相手の飛行計画IDを指定して「調整依頼の開始」APIを実行
- 3-2. 「調整依頼の開始」APIの処理で、以下を実行
- 3-2-1. コンテキストIDを採番し、DBに運航調整情報を登録
- 3-2-2. 自分の飛行計画IDと相手の飛行計画IDとコンテキストIDを指定して、相手側のUTMへ「調整開始通知」APIを実行
- 3-3. 「調整依頼の開始」APIのレスポンスで採番したコンテキストIDを返す
-
- 調整依頼の実行
- 4-1. フロントエンド(UI)から自分の飛行計画IDと相手の飛行計画IDとコンテキストIDと調整条件を指定して「調整依頼の実行」APIを実行
- 4-2. 「調整依頼の実行」APIの処理で、以下を実行
- 4-2-1. セッションIDとターンIDを採番し、DBの該当運航調整情報を更新 (調整条件も登録)
- 4-2-2. 対応する重複情報に、コンテキストIDを紐付け登録
- 4-2-3. 自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整条件を指定して、相手側のUTMへ「調整依頼通知」APIを実行
-
- 調整結果通知の受信
- 5-1. 相手側のUTMから、自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整結果(合意 or 否認)を指定して「調整結果通知」APIを受信
- 5-2. 指定された調整結果(合意 or 否認)により、DBの該当運航調整情報を更新
-
- 飛行計画の修正 (運航調整機能の範囲外)
- 6-1. 調整条件に従って、相手側が飛行計画を修正して、修正後の飛行計画をDIPSへ登録
- 6-2. DIPSで重複判定が行われ、重複が解除された場合、重複解除通知をPub/Subで送信
-
- 重複解除通知の受信
- 7-1. DIPSからPub/Subで通知された重複解除通知をDIPS Connectorが受信
- 7-2. DIPS Connectorが「重複解除通知の受信」APIで運航調整機能に通知
- 7-3. 「重複解除通知の受信」APIの処理で、DBの重複情報を更新 (重複状態フラグをtrueからfalseへ更新)
7.1.1. コンテキストIDの採番
Section titled “7.1.1. コンテキストIDの採番”コンテキストIDは、UUID v4形式で採番し、設定する。
7.1.2. セッションIDの採番
Section titled “7.1.2. セッションIDの採番”セッションIDは、現在時刻のUnixタイムミリ秒で設定する。
- セッションIDの制約
- コンテキスト内でユニークかつ単調増加であればよい
- 相手側が全く同一の時刻でセッションIDを採番するケースは考慮しない (可能性がゼロに近いため)
7.1.3. ターンIDの採番
Section titled “7.1.3. ターンIDの採番”ターンIDは、現在時刻のUnixタイムミリ秒で設定する。
- ターンIDの制約
- コンテキスト内でユニークかつ単調増加であればよい
- 相手側が全く同一の時刻でターンIDを採番するケースは考慮しない (可能性がゼロに近いため)
7.2. 基本的な処理の流れ (自分側のUTMが調整依頼の受信側の場合)
Section titled “7.2. 基本的な処理の流れ (自分側のUTMが調整依頼の受信側の場合)”-
- 重複通知の受信
- 1-1. DIPSからPub/Subで通知された重複通知をDIPS Connectorが受信
- 1-2. DIPS Connectorが「重複通知の受信」APIで運航調整機能に通知
- 1-3. 「重複通知の受信」APIの処理で、DBに重複情報を登録 (重複状態フラグはtrueで登録)
-
- 調整開始通知の受信
- 2-1. 相手側のUTMから、自分の飛行計画IDと相手の飛行計画IDとコンテキストIDを指定して、「調整開始通知」APIを受信
- 2-2. 指定された内容で、DBに運航調整情報を登録
-
- 調整依頼通知の受信
- 3-1. 相手側のUTMから、自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整条件を指定して、「調整依頼通知」APIを受信
- 3-2. 指定された内容で、DBの該当運航調整情報を更新 (調整条件も登録)
- 3-3. 対応する重複情報に、コンテキストIDを紐付け登録
-
- 重複情報と運航調整情報の取得
- 4-1. フロントエンド(UI)から自分の飛行計画IDを指定して「重複情報の取得」APIを実行し、重複情報を取得
- 4-2. 重複情報に紐づく運航調整情報のコンテキストIDが存在する場合、自分の飛行計画IDと相手の飛行計画IDとコンテキストIDを指定して、「運航調整情報の取得」APIを実行し、運航調整情報を取得
- 4-3. フロントエンド(UI)で重複情報とそれに紐づく運航調整情報を一覧表示
- 4-4. 一覧から調整依頼回答を行う1件を選択
-
- 調整依頼の回答実行
- 5-1. フロントエンド(UI)から自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整結果(合意 or 否認)を指定して「調整依頼の回答実行」APIを実行
- 5-2. 「調整依頼の回答実行」APIの処理で、以下を実行
- 5-2-1. 指定された調整結果(合意 or 否認)により、DBの該当運航調整情報を更新
- 5-2-2. 自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整結果(合意 or 否認)を指定して相手側のUTMへ「調整結果通知」APIを実行
-
- 飛行計画の修正 (運航調整機能の範囲外)
- 6-1. 調整条件に従って、飛行計画を修正して、修正後の飛行計画をDIPSへ登録
- 6-2. DIPSで重複判定が行われ、重複が解除された場合、重複解除通知をPub/Subで送信
-
- 重複解除通知の受信
- 7-1. DIPSからPub/Subで通知された重複解除通知をDIPS Connectorが受信
- 7-2. DIPS Connectorが「重複解除通知の受信」APIで運航調整機能に通知
- 7-3. 「重複解除通知の受信」APIの処理で、DBの重複情報を更新 (重複状態フラグをtrueからfalseへ更新)
7.3. 依頼者 (requester) / 調整対象者 (responder) と、自分側 / 相手側 の対応関係
Section titled “7.3. 依頼者 (requester) / 調整対象者 (responder) と、自分側 / 相手側 の対応関係”調整開始通知APIの送信/受信時の、依頼者 (requester) / 調整対象者 (responder) と、自分側 / 相手側 の対応関係は、下記のようになる。
| 調整開始通知APIの指定パラメータ | 送信時 | 受信時 |
|---|---|---|
| 依頼者側の飛行計画ID (requester_flight_plan_id) | 自分の飛行計画ID (self_flight_plan_id) | 相手の飛行計画ID (opponent_flight_plan_id) |
| 調整対象者側の飛行計画ID (responder_flight_plan_id) | 相手の飛行計画ID (opponent_flight_plan_id) | 自分の飛行計画ID (self_flight_plan_id) |
| 依頼者の運航者識別子 (requester) | 自分の運航者識別子 (self_operator_id) | 相手の運航者識別子 (opponent_operator_id) |
| 調整対象者の運航者識別子 (responder) | 相手の運航者識別子 (opponent_operator_id) | 自分の運航者識別子 (self_operator_id) |
7.4. 自動修正 (issue #112) の処理の流れ
Section titled “7.4. 自動修正 (issue #112) の処理の流れ”「7.2. 基本的な処理の流れ (自分側のUTMが調整依頼の受信側の場合)」の4〜5に対応する自動修正の処理の流れを示す。10月デモでは、以下のように相手側から調整依頼を受けた後、フロントエンド(UI)から回答実行するまでの間に、実行者が飛行計画自動修正案登録APIをCurlで手動実行する運用とする。
-
- 自動調整設定の切り替え (事前準備)
- 1-1. 実行者が自分の飛行計画IDと相手の飛行計画IDを指定して「自動調整設定の切り替え」APIをCurlで実行し、自動修正フラグをONにする
- 1-2. 10月デモ向けの暫定対処により、本手順は不要(重複情報の登録時点でONになっているため。5.4.1節参照)。 フラグをOFFにしたい場合や、暫定対処の適用前に登録された重複情報を使う場合にのみ実行する
-
- 調整依頼通知の受信 (7.2節の2〜3と同様)
-
- 飛行計画自動修正案の登録
- 3-1. 実行者が、相手からの調整依頼内容と整合するよう事前に用意した修正後の飛行計画情報と、自分の飛行計画ID(UTM管理のID。issue #249)を指定して「飛行計画自動修正案の登録」APIをCurlで実行
- 3-2. 「飛行計画自動修正案の登録」APIの処理で、受付条件(6.8.2節)を満たす場合、DBに飛行計画自動修正案情報を登録し、対応する重複情報に紐付ける
-
- 重複情報と運航調整情報の取得 (7.2節の4と同様)
- 4-1. フロントエンド(UI)側では、重複情報取得APIのレスポンスの飛行計画自動修正案存在フラグ・IDを参照し、存在する場合は「飛行計画自動修正案の取得」APIで修正後の飛行計画情報を取得・画面表示する
-
- 飛行計画自動修正案への回答 (「調整依頼の回答実行」7.2節の5の代わりに実行)
- 5-1. フロントエンド(UI)から自動修正案IDと回答内容(採用)を指定して「飛行計画自動修正案への回答」APIを実行
- 5-2. 「飛行計画自動修正案への回答」APIの処理で、以下を順に実行(6.8.3節参照)
- 5-2-1. 指定された調整結果(合意)により、DBの該当運航調整情報を更新
- 5-2-2. 自分の飛行計画IDと相手の飛行計画IDとコンテキストID、セッションID、ターンID、調整結果(合意)を指定して相手側のUTMへ「調整結果通知」APIを実行
- 5-2-3. UTM Backends側の飛行計画更新・DIPS通報を呼び出す
-
- 飛行計画の修正 (運航調整機能の範囲外、7.2節の6と同様)
-
- 重複解除通知の受信 (7.2節の7と同様)
8. 処理の流れ (運航調整機能内部観点)
Section titled “8. 処理の流れ (運航調整機能内部観点)”運航調整機能内部の処理の流れは、下記の内容に従う。
- docs/coordination/sequence/detail/Coordination_SequenceDetail_index.md
ただし、forDemoまでは、簡素化した下記の内容に従う。
- docs/coordination/sequence/detail/Coordination_SequenceDetail_index_forDemo.md
デモ向け版(forDemo)では、簡素化のため、下記の処理・判定は対象外とする。
- 期限切れ判定 TODO(#334)
- 自分側と相手側の相互での調整開始や調整依頼の同時実行パターン TODO(#335)
- 最初にどちらか片方側が、調整開始 + 1回目の調整依頼 までを行うまでの間、もう片方側は調整開始、調整依頼を行わない前提とする
- また、1回目の調整依頼のターンが否認で完了した後、2回目以降の調整依頼を同じコンテキストIDで行う際も、調整依頼を相互に同時実行はしない前提とする
- 本パターン対象外により、コンテキストオーナー変更のケースが発生しない
- 調整回答合意後の飛行計画の修正により、重複が解消されず、再度重複通知を受信するパターン TODO(#337)
- ビジター対応処理 TODO(#340)
また、デモ向け版(forDemo)では、運航調整プロトコルタイプはシングルターンのみ対象とし、マルチターン(Continuous)、マルチターン(Alternating)は対象外とする。 TODO(#333)
9. 関連ドキュメント
Section titled “9. 関連ドキュメント”- メッセージ一覧(英語化対応): Coordination_MessageList.md
- 画面表示用マッピング情報 : CoordinationStatus_MappingTable_forDisplay.md
- 自動修正(issue #112)のフロントエンド向けAPI利用法 : forFrontend/Coordination_AutoCorrection_ApiUsage.md