intra-mart Accel Platform IM-LogicDesigner チュートリアルガイド 第9版 2021-04-01

5.8. フロートリガを利用する

この章では、フロートリガの概要、および、利用方法について説明します。

5.8.1. フロートリガとは?

フロートリガとは、intra-mart Accel Platform上で行われる特定の操作に連動して、ロジックフローを実行するための設定情報です。
フロールーティングを設定する」や「ジョブを利用したロジックフローの実行」などで説明した方法でロジックフローを実行する場合、開発者が能動的にどのタイミングで実行するかを決定する必要があります。
../../../_images/flow_by_active_execute.png

図:フローの能動的な実行

フロートリガを利用することで、フローを実行したいタイミング(トリガ発生条件)や実行するフローを設定し、受動的にロジックフローを実行することが可能です。
../../../_images/flow_by_passive_execute.png

図:フローの受動的な実行

コラム

フロートリガの内部動作

フロートリガはIM-Propagationを利用して実現されています。
IM-Propagationの詳細については「IM-Propagation 仕様書」を参照してください。

5.8.1.1. 本チュートリアルについて

本チュートリアルでは、「基礎編 - ファースト・ステップ」で作成したロジックフローを用いて、
「アカウント情報が新規に作成されたタイミングで、作成されたアカウント情報のユーザコードをロジックフローに渡し、実行する」
という処理の実装を行います。
../../../_images/flow_trigger_tutorial.png

図:チュートリアルイメージ

5.8.2. トリガ定義一覧画面を表示する

フロートリガの一覧画面は、サイトマップより遷移します。
  1. 「サイトマップ」→「LogicDesigner」→「トリガ定義一覧」をクリックします。

    ../../../_images/flow_trigger_list1.png

    図:サイトマップ

  2. トリガ定義一覧画面が表示されます。

    ../../../_images/flow_trigger_list2.png

    図:トリガ定義一覧画面

5.8.3. 新規にフロートリガを作成する

フロートリガの作成は、トリガ定義編集画面から行います。
  1. トリガ定義一覧画面左上の「新規作成」をクリックします。

    ../../../_images/create_flow_trigger1.png

    図:新規作成リンク

  2. トリガ定義編集画面が表示されます。

    ../../../_images/create_flow_trigger2.png

    図:トリガ定義編集画面

  3. トリガ定義の基本情報となる各項目に以下の値を入力します。

    • トリガ定義ID「flow_trigger_account_create

    • トリガ定義名
      • 標準 - 「トリガ定義[Account Create]
      • 日本語、英語、中国語(中華人民共和国) - 入力なし
    • 有効「チェックボックス:オン

    ../../../_images/create_flow_trigger3.png

    図:基本情報

  4. トリガ定義の発生条件について、本チュートリアルが想定するタイミング(トリガ発生条件)である「アカウントの作成」を選択します。

    ../../../_images/create_flow_trigger4.png

    図:トリガ発生条件

  5. トリガ発生時に実行するフローについて、各項目に以下の値を入力します。

    • 対象フロー
      • フロー定義ID - 「tutorial_flow
      • フロー定義名 - 「チュートリアルフロー
    ../../../_images/create_flow_trigger5.png

    図:実行フロー情報

  6. 作成されたアカウント情報から、ユーザコードをロジックフローへ渡すためのマッピング設定を以下のように行います。

    入力(始点) 出力(終点)
    アカウントの作成<object> - userCd<string> チュートリアルフロー<object> - message<string>
    ../../../_images/create_flow_trigger6.png

    図:マッピング設定

  7. 「登録」をクリックします。

    ../../../_images/create_flow_trigger7.png

    図:登録

以上で、アカウントの作成をタイミング(トリガ発生条件)としたフロートリガの作成が完了しました。

5.8.4. 作成したフロートリガの動作を確認する

フロートリガとは?」で説明したとおり、フロートリガは外部の動作をタイミング(トリガ発生条件)に動作します。
本チュートリアルでは「アカウントの作成」をタイミング(トリガ発生条件)としたので、実際にアカウントの作成を行いフローが想定する動作をするか確認します。
  1. 「サイトマップ」→「共通マスタ」→「ユーザ」をクリックします。

  2. ユーザ検索が表示されます。
    ユーザ検索左上の「ユーザの新規登録」をクリックします。
    ../../../_images/confirm_trigger_execution1.png

    図:ユーザの新規登録 その1

  3. ユーザ詳細(新規)について、各項目に以下の値を入力します。

    • 基本 - ユーザコード「tutorial_trigger_user
    • プロファイル - ユーザ名「チュートリアルトリガユーザ
    ../../../_images/confirm_trigger_execution2.png

    図:ユーザの新規登録 その2

  4. 「登録」をクリックします。

アカウントの作成後、続いてロジックフローの実行結果を確認します。
実行結果として「基礎編 - ファースト・ステップ」で作成したロジックフローの以下の内容が、作成したユーザコード(tutorial_trigger_user)を入力として出力されていることを確認してください。
以上で、作成したフロートリガの動作が確認できました。

5.8.5. 同じトリガ発生条件に複数のロジックフローを設定する

フロートリガでは、同じトリガ発生条件に複数のロジックフローを設定することができます。
ここでは「新規にフロートリガを作成する」で説明した方法をベースに、二つ目のフロートリガを設定します。
  1. 「サイトマップ」→「LogicDesigner」→「トリガ定義一覧」から、トリガ定義一覧画面を開きます。
    一覧の中から、トリガ定義ID「flow_trigger_account_create」の行の編集アイコンをクリックします。
  2. トリガ定義の基本情報の「トリガ定義IDを新しく割り当てて複製する」にチェックを入れます。

    ../../../_images/flow_trigger_multiple1.png

    図:トリガ定義IDを新しく割り当てて複製する

  3. トリガ定義IDが入力可能になったことを確認した上で、トリガ定義の基本情報となる各項目について以下の値を変更します。

    • トリガ定義ID「flow_trigger_account_create_2

    • トリガ定義名
      • 標準 - 「トリガ定義2[Account Create]
      • 日本語、英語、中国語(中華人民共和国) - 入力なし
    ../../../_images/flow_trigger_multiple2.png

    図:二つ目のフロートリガの設定

  4. 今回作成するフロートリガでは、作成したアカウントの有効開始日を入力としてマッピング設定を行います。
    作成されたアカウント情報から、有効開始日をロジックフローへ渡すためのマッピング設定を以下のように行います。
    (もとから定義されているマッピング情報は削除してください)
    入力(始点) 出力(終点)
    アカウントの作成<object> - validStartDate<date> チュートリアルフロー<object> - message<string>
    ../../../_images/flow_trigger_multiple3.png

    図:二つ目のフロートリガのマッピング設定

  5. 「登録」をクリックします。

二つ目のフロートリガ作成後、「作成したフロートリガの動作を確認する」で説明した方法と同様に新しいユーザを作成します。
ユーザ作成後の実行結果として、以下の二つの出力結果が得られることを確認してください。
  • 新規にフロートリガを作成する」で作成したフロートリガから得られる結果(ユーザコードの出力)。
  • 本項で作成したフロートリガから得られる結果(有効開始日の出力)。

注意

フロートリガの実行順序について

同じトリガ発生条件を設定したフロートリガが複数あった場合、フロートリガの実行順序は不定であることに注意してください。
あるフロートリガの動作以前、または、以後に動くことを想定する別のフロートリガの設定を行った場合、正常に動作しない場合があります。

5.8.6. 作成したフロートリガの利用を停止する

フロートリガの利用を停止する場合、以下の二つの方法があります。
  • フロートリガを無効にする。
  • フロートリガを削除する。

5.8.6.1. 有効/無効による制御

一時的にフロートリガの利用を停止したい場合、フロートリガを無効にする方法が有用です。
  1. 「サイトマップ」→「LogicDesigner」→「トリガ定義一覧」から、トリガ定義一覧画面を開きます。
    一覧の中から、トリガ定義ID「flow_trigger_account_create」の行の編集アイコンをクリックします。
  2. トリガ定義の基本情報から、以下の項目を変更します。

    • 有効「チェックをはずす
    ../../../_images/flow_trigger_disable.png

    図:有効/無効の設定

  3. 「更新」をクリックします。

    ../../../_images/flow_trigger_disable2.png

    図:更新

更新後、「作成したフロートリガの動作を確認する」で説明した方法と同様に新しいユーザを作成します。
ユーザ作成後の実行結果として、「新規にフロートリガを作成する」で作成したフロートリガは動作していないことを確認してください。

5.8.6.2. フローを削除する

対象のフロートリガが不要になった等、今後利用するケースが無い場合、フロートリガを削除する方法が有用です。
  1. 「サイトマップ」→「LogicDesigner」→「トリガ定義一覧」から、トリガ定義一覧画面を開きます。
    一覧の中から、トリガ定義ID「flow_trigger_account_create_2」の行の編集アイコンをクリックします。
  2. トリガ定義編集下部、「削除」をクリックします。

    ../../../_images/flow_trigger_delete1.png

    図:削除

  3. 削除を確認するダイアログが表示されるので、決定をクリックします。

  4. 削除が完了した旨のメッセージと共に、トリガ定義一覧画面に遷移します。

    ../../../_images/flow_trigger_delete2.png

    図:削除後、一覧画面へ遷移

削除後、「作成したフロートリガの動作を確認する」で説明した方法と同様に新しいユーザを作成します。
ユーザ作成後の実行結果として、「同じトリガ発生条件に複数のロジックフローを設定する」で作成したフロートリガは動作していないことを確認してください。