起動単位一覧を作成しよう
クエスト概要
taiasでは構築したI/Fを、運用の中で実行したい任意の単位でまとめることが可能です。
例えば、2つのI/Fに依存関係があり、組織情報の出力I/Fを実行した後に、社員情報の出力I/Fを実行したいという場合は、「人事情報出力」という一つのI/F起動単位を作成することでこれを実現できます。
構築したI/FをそのままI/F起動単位とすることも可能です。taiasでは構築したI/Fの本数分、I/F起動単位がデフォルトで
作成されているので、I/Fを集約した形式でのI/F起動単位の設定が不要な場合は、そのままクエスト完了して頂いて構いません。
また、人事情報を出力した後に、連携先のシステムで必ずバッチを実行する必要がある、といった場合等、
I/Fを起動した後に特定のAPIやバッチを実行したい場合、事後処理の設定をI/F起動単位の中で定義することができます。
JP1等の統合管理ツールで制御することが一般的ですが、事後処理もI/Fとまとめてtaias内で管理したいといった場合に活用できます。
用語一覧
このクエストで登場する用語を解説します。
起動単位の設定
起動単位名
定義する起動単位の呼び名となるものです。この起動単位でどういったI/Fが実行されるのか、簡潔で分かりやすい名称をつけましょう。各種一覧画面で検索する際にも利用できます。 デフォルトでI/Fと1:1で作成された起動単位は、I/F名と同じ名称となっています。
起動単位コード
起動単位コードはtaias内で起動単位を一意に識別するためのコードです。一意になるコードを入力してください。
概要
起動単位の内容を簡潔に説明する任意の項目です。
処理の流れ
複数のI/Fを一つの起動単位で実行する場合は、以下、直列/並列の指定をします。
直列：指定されたI/Fを順番に実行します。
並列を選択：指定されたI/Fを並列に（同時に）実行します。途中で失敗があった場合は一部のI/Fが実行されない場合もあります。
事後処理の設定
I/F事後処理とは、連携で呼び出すAPIの後に、任意のAPIを呼び出したり、ステータス監視をする処理のことです。 主に、連携で呼び出すAPIが非同期実行、かつ、その実行結果をtaias上の実行履歴にも反映したい場合に利用します。
事後処理は以下の順番で定義します。
- APIの送信先システム選択
- 事後処理API設定
- ポーリング設定
- ポーリング終了条件設定
事後処理API設定
URL
事後処理として実際に実行したいバッチ等のAPIのURLを定義します。 リクエストメソッドをGET/POST/PUT/DELETEの中から選択した後、ホスト名以降のURL情報を定義して下さい。 ホスト名は接続情報で定義された情報をもとに実行されるので、ここでは指定する必要はありません。
クエリパラメータ
事後処理API設定でクエリパラメータを指定する必要がある場合は指定してください。
リクエストヘッダパラメータ
事後処理API設定でリクエストヘッダパラメータを指定する必要がある場合は指定してください。
リクエストボディ
事後処理のAPIに渡す必要のあるリクエストボディを定義します。現時点ではjsonでの定義しかできません。
ポーリング設定
ポーリング設定
事後処理で実行したAPIの結果を定期的に監視して、実行結果を取得するために設定します。
ポーリングが不要な場合は設定する必要はありません。
事後処理APIレスポンス
ポーリング設定を利用する場合、事後処理APIレスポンスの値をもとに条件を指定して監視することになりますので、そのレスポンスのjsonを定義することができます。
URL
事後処理として実際に実行したいバッチ等のAPIのURLを定義します。 リクエストメソッドをGET/POST/PUT/DELETEの中から選択した後、ホスト名以降のURL情報を定義して下さい。 ホスト名は接続情報で定義された情報をもとに実行されるので、ここでは指定する必要はありません。
クエリパラメータ
事後処理API設定でクエリパラメータを指定する必要がある場合は指定してください。
リクエストヘッダパラメータ
事後処理API設定でリクエストヘッダパラメータを指定する必要がある場合は指定してください。
ポーリング終了条件設定
ポーリングAPIレスポンス
ポーリングAPIで返却されるAPIの値を定義します。 これを定義することで、どういった時に正常/異常終了とするのか、ということを条件に指定します。 このポーリングAPIとして定義する値は、jsonを取り込んで定義します。APIのリファレンスに記載されているサンプルリファレンスを利用するか、APIの担当者に確認の後、jsonファイルを作成して取り込んでください。
異常終了条件
事後処理で実行するAPIの実行結果を異常終了とする条件を定義します。条件はポーリングAPIレスポンスで指定した項目に対して定義して下さい。ここで指定した条件に合致する場合、I/Fの実行結果は異常終了となります。
正常終了条件
事後処理で実行するAPIの実行結果を正常終了とする条件を定義します。 条件はポーリングAPIレスポンスで指定した項目に対して定義して下さい。ここで指定した条件に合致する場合、I/Fの実行結果は正常終了となります。
繰り返しの間隔（秒）
ポーリングのAPIをどの間隔で実行するのか、秒を指定して定義します。
タイムアウト（分）
ポーリングのAPIを繰り返し実行した結果、最初のポーリングから何分経過したらタイムアウトとするのか定義します。