9.11. 外部連携

外部連携一覧やデータマッパー(DM)などを利用して、フローへの外部連携を設定することができます。
アクション設定では、フォーム上への画面アイテムへの操作(イベント)をトリガーとしたアクションイベントを設定することができます。

9.11.1. 外部連携一覧(前処理/後処理)画面の機能と各部の説明

「IM-BIS - フロー編集」画面で画面(フォーム)が設定されたノードを右クリックし、コンテキストメニューで「外部連携」-「外部連携一覧」をクリックすると表示することができる画面です。
「外部連携一覧」(前処理/後処理)画面の内容は以下の通りです。
../../_images/process_node_external_linkage.png
  1. イベント選択

    外部連携処理を選択しているタスク(ノード)の前処理、後処理のどのタイミングで実行するかを選択します。
  2. データソース名

    設定しているデータソース名を表示します。
  3. 説明

    外部連携の処理やマッピングについての設定の説明を入力します。
  4. 前処理エラー時

    2件以上の外部連携を登録しており、直前に実行する外部連携処理がエラーの時にどのように処理を行うかを設定します。
    • 処理を続行する→直前の外部連携処理の結果に関係なく、処理を実行します。
    • 処理を中止する→直前の外部連携処理の結果がエラーとなった場合、処理を中止します。
    • スキップ→直前の外部連携処理の結果がエラーとなった場合、処理をスキップします。

    コラム

    「前処理エラー時」の設定値に基づくエラー発生時の処理
    1つのイベントに対して、複数の外部連携やアクション設定を設定している場合、前の処理でエラーが発生した場合の対応方法を「前処理エラー時」の項目で設定します。
    複数の処理の実行中にエラーが発生した場合の、「前処理エラー時」の設定値による処理の違いは、以下のようになります。
    • 前処理エラー時「続行」としており、その直前の処理でエラーが発生した場合

      ../../_images/pattern_1.png
    • 前処理エラー時「続行」、次の処理で「全体中止」としており、「続行」と設定した方の処理の直前の処理でエラーが発生した場合

      ../../_images/pattern_2.png
    • 前処理エラー時「スキップ」としており、その直前の処理でエラーが発生した場合

      ../../_images/pattern_3.png
    • 前処理エラー時「全体中止」としており、その直前の処理でエラーが発生した場合

      • タスク(ノード)の前処理、画面イベント(アクション設定)、案件終了処理

        ../../_images/pattern_4.png
      • タスク(ノード)の後処理

        ../../_images/pattern_5.png
    • 複数の外部連携・アクション設定を設定しており、最後の処理でエラーが発生した場合

      • タスク(ノード)の前処理、画面イベント(アクション設定)、案件終了処理

        ../../_images/pattern_6.png
      • タスク(ノード)の後処理

        ../../_images/pattern_7.png
  5. DM

    アイコンをクリックすると、「データマッパー」画面に遷移します。
  6. 削除

    アイコンをクリックすると、登録済みの外部連携設定を削除します。

9.11.2. 外部連携一覧(案件終了処理)画面の機能と各部の説明

「IM-BIS - フロー編集」画面で、終了ノードを右クリックした後、コンテキストメニューで「外部連携」-「外部連携一覧」をクリックすると表示することができる画面です。
「外部連携一覧」(案件終了処理)画面の内容は以下の通りです。
../../_images/end_node_external_linkage.png
  1. イベント選択

    終了ノードから表示した場合、案件終了処理を固定で表示します。
  2. データソース名

    設定しているデータソース名を表示します。
  3. 説明

    外部連携の処理やマッピングについての設定の説明を入力します。
  4. 前処理エラー時

    2件以上の外部連携を登録している場合に、直前に実行する外部連携処理がエラーの時にどのように処理を行うかを設定します。
    • 処理を続行する→直前の外部連携処理の結果に関係なく、処理を実行します。
    • 処理を中止する→直前の外部連携処理の結果がエラーとなった場合、処理を中止します。
    • スキップ→直前の外部連携処理の結果がエラーとなった場合、処理をスキップします。

    コラム

    案件終了処理でのエラーハンドリングについて
    案件終了処理時の外部連携でエラーが発生した場合、フローは終了せずに終了ノードで未完了のままとなります。
    案件終了時に設定されている外部連携はそれぞれ別トランザクションとなるため、前の外部連携処理の内容はロールバックされません。
  5. DM

    アイコンをクリックすると、「データマッパー」画面に遷移します。
  6. 削除

    アイコンをクリックすると、登録済みの外部連携設定を削除します。

コラム

案件終了処理での外部連携の設定
案件終了処理での外部連携は、以下の設定のみが利用できます。
  • 設定できるデータソース定義の種別は、「テナントDB更新系クエリ」「シェアードDB更新系クエリ」です。
  • データマッパーでのマッピングでは、「リクエスト」のみ設定できます。

9.11.3. イベント設定(初期表示イベント)画面の機能と各部の説明

フォーム(画面)の初期表示時に外部連携を行うための設定画面です。
「フォーム・デザイナ」画面で「アクション設定」をクリックして表示します。
../../_images/external_linkage_onload.png
  1. イベントタイプ

    初期表示イベント設定の場合は、固定で「ロード」が表示されます。
  2. 処理中にインジケータを表示する

    チェックがオンになっている場合、外部連携・アクションの実行中はインジケータが表示されるようになります。

    コラム

    「インジケータ」の表示
    「処理中にインジケータを表示する」の設定を有効にしている場合、以下のように表示されます。
    ../../_images/indicator_sample.png
  3. アクション

    設定しているアクションの種類を表示します。
  4. 説明

    外部連携の処理やマッピングについての設定の説明を入力します。
    外部連携でデータソース定義が設定されている場合には、設定済みのデータソース定義名を表示します。
  5. 前処理エラー時

    2件以上の外部連携・アクションを登録している場合に、直前に実行する外部連携・アクションがエラーの時にどのように処理を行うかを設定します。
    • 処理を続行する→直前の外部連携・アクションの結果に関係なく、処理を実行します。
    • 処理を中止する→直前の外部連携・アクションの結果がエラーとなった場合、処理を中止します。
    • スキップ→直前の外部連携・アクションの結果がエラーとなった場合、処理をスキップします。
  6. 設定

    アイコンをクリックすると、選択されたアクションに応じて、以下の設定画面に遷移します。
    • 外部連携 → 「データマッパー」画面に遷移します。
    • 入力モード変換 → 「入力モード変換設定」画面に遷移します。
    • 表示モード変換 → 「表示モード変換設定」画面に遷移します。
    • カスタムスクリプト → 「カスタムスクリプト設定」画面に遷移します。
  7. 条件

    アイコンをクリックすると、「条件設定」画面に遷移します。
  8. 削除

    アイコンをクリックすると、登録済みの外部連携・アクション設定を削除します。

9.11.4. イベント設定(アイテムイベント)画面の機能と各部の説明

フォーム(画面)のアイテムのイベント(アクション)が発生した時にアクションを実行するための設定画面です。
「フォーム・デザイナ」画面で「アクション設定」をクリックして表示します。

通常イベントのみの場合

通常イベントとは、通常の画面アイテムを設定した場合の、アクション設定の設定項目です。

../../_images/item_event_settings_normal.png
  1. アイテム

    外部連携・アクションのタイミングとなる画面アイテムの「ラベル」、「フィールド識別ID」を表示します。
  2. イベントタイプ

    イベントタイプには以下の種類を選択できます。
    画面アイテムの種類によって使用できないものがあります。

    イベント種別

    イベントタイプ

    説明

    通常イベント

    フォーカスイン

    入力フィールドをマウスでクリックしたり、ユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスを合わせたときに処理を実行します。

    クリック

    入力フィールド、ボタン、アイコンをクリックしたとき、処理を実行します。

    入力

    入力フィールドに値を入力してフォーカスが外れた時に処理を実行します。

    フォーカスアウト

    他画面アイテムをマウスでクリックしたりユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスが外れたときに処理を実行します。

  3. 説明

    画面アイテムと選択したイベントタイプに設定した内容の説明を入力します。
  4. 設定

    アイコンをクリックすると、「アクション設定」画面に遷移します。
  5. 削除

    アイコンをクリックすると、登録済みのイベント設定を削除します。
  6. light_bulb_on (処理中にインジケータを表示する)

    チェックがオンになっている場合、外部連携・アクションの実行中はインジケータが表示されるようになります。

    コラム

    「インジケータ」の表示
    「処理中にインジケータを表示する」の設定を有効にしている場合、以下のように表示されます。
    ../../_images/indicator_sample.png

特殊イベントがある場合

特殊イベントとは、特殊な画面アイテムを設定した場合の、外部連携の必須設定項目です。

../../_images/item_event_settings_special.png
  1. アイテム

    外部連携処理のタイミングとなる画面アイテムの「ラベル」、「フィールド識別ID」を表示します。
  2. イベントタイプ

    通常イベントのイベントタイプには、以下の種類を選択できます。
    画面アイテムの種類によって使用できないものがあります。
    特殊イベントは必須項目のため、選択することはできません。

    イベント種別

    イベントタイプ

    説明

    特殊イベント

    アイコンクリック

    一覧選択の search をクリックしたときに処理を実行します。

    インポート

    ボタンをクリックしたとき、インポートを行います。

    エクスポート

    ボタンをクリックしたとき、エクスポートを行います。

    通常イベント

    フォーカスイン

    入力フィールドをマウスでクリックしたり、ユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスを合わせたときに処理を実行します。

    クリック

    入力フィールド、ボタン、アイコンをクリックしたとき、処理を実行します。

    入力

    入力フィールドに値を入力してフォーカスが外れた時に処理を実行します。

    フォーカスアウト

    他画面アイテムをマウスでクリックしたりユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスが外れたときに処理を実行します。

  3. 説明

    画面アイテムと選択したイベントタイプに設定した内容の説明を入力します。
  4. 設定

    アイコンをクリックすると、「外部連携設定」画面に遷移します。
  5. 通常イベント

    詳細は、「通常イベントのみの場合」の設定を参照してください。

イベント設定(アイテムイベント)画面で使用できるイベントタイプ

画面アイテムによって、選択できるイベントタイプが異なります。
以下を参照してください。
画面アイテム 選択できるイベントタイプ
  • 文字列
  • 複数行字列
  • 数値
  • 一覧選択(product_72_itemSelect)
  • 日付
  • 期間
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト
  • チェックボックス
  • ラジオボタン
  • リストボックス
  • セレクトボックス
  • チェックボックス(product_72_checkbox)
  • ラジオボタン(product_72_radio)
  • リストボックス(product_72_listbox)
  • セレクトボックス(product_72_selectbox)
  • 入力
  • 一覧選択
  • アイコンクリック
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト
  • 期間
  • 開始日 フォーカスイン
  • 開始日 クリック
  • 開始日 入力
  • 開始日 フォーカスアウト
  • 終了日 フォーカスイン
  • 終了日 クリック
  • 終了日 入力
  • 終了日 フォーカスアウト
  • ボタン(イベント)
  • クリック
  • ボタン(インポート)
  • インポート
  • ボタン(エクスポート)
  • エクスポート

コラム

以下のイベントタイプは、特殊イベントに分類されます。

  • アイコンクリック
  • インポート
  • エクスポート

9.11.5. イベント設定(テーブルイベント)画面の機能と各部の説明

フォーム(画面)のテーブル系アイテムの列にイベント(アクション)が発生した時に外部連携・アクションを行うための設定画面です。
「フォーム・デザイナ」画面で「アクション設定」をクリックして表示します。

通常イベントのみの場合

通常イベントとは、通常の画面アイテムを設定した場合の、外部連携・アクションの設定項目です。

../../_images/table_event_settings_normal.png
  1. テーブル

    画面アイテム「明細テーブル」もしくは「グリッドテーブル」の「ラベル」、「テーブル識別ID」を表示します。
  2. 外部連携処理のタイミングとなるテーブル系アイテムの列の「列名」、「フィールド識別ID」を表示します。
  3. イベントタイプ

    イベントタイプには以下の種類を選択できます。
    画面アイテムの種類によって使用できないものがあります。

    イベント種別

    イベントタイプ

    説明

    通常イベント

    フォーカスイン

    入力フィールドをマウスでクリックしたり、ユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスを合わせたときに処理を実行します。

    クリック

    入力フィールド、ボタン、アイコンをクリックしたとき、処理を実行します。

    入力

    入力フィールドに値を入力してフォーカスが外れた時に処理を実行します。

    フォーカスアウト

    他画面アイテムをマウスでクリックしたりユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスが外れたときに処理を実行します。

  4. 説明

    画面アイテムと選択したイベントタイプに設定した内容の説明を入力します。
  5. 設定

    アイコンをクリックすると、「アクション設定」画面に遷移します。
  6. 削除

    アイコンをクリックすると、登録済みの外部連携・アクション設定を削除します。
  7. light_bulb_on (処理中にインジケータを表示する)

    チェックがオンになっている場合、外部連携・アクションの実行中はインジケータが表示されるようになります。

    コラム

    「インジケータ」の表示
    「処理中にインジケータを表示する」の設定を有効にしている場合、以下のように表示されます。
    ../../_images/indicator_sample.png

特殊イベントがある場合

特殊イベントとは、特殊な画面アイテムを設定した場合の、外部連携の必須設定項目です。

../../_images/table_event_settings_special.png
  1. テーブル

    画面アイテム「明細テーブル」もしくは「グリッドテーブル」の「ラベル」、「テーブル識別ID」を表示します。
  2. 外部連携処理のタイミングとなるテーブル系アイテムの列の「列名」、「フィールド識別ID」を表示します。
  3. イベントタイプ

    通常イベントのイベントタイプには、以下の種類を選択できます。
    画面アイテムの種類によって使用できないものがあります。
    特殊イベントは必須項目のため、選択することはできません。

    イベント種別

    イベントタイプ

    説明

    特殊イベント

    アイコンクリック

    一覧選択の search をクリックしたときに処理を実行します。

    通常イベント

    フォーカスイン

    入力フィールドをマウスでクリックしたり、ユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスを合わせたときに処理を実行します。

    クリック

    入力フィールド、ボタン、アイコンをクリックしたとき、処理を実行します。

    入力

    入力フィールドに値を入力してフォーカスが外れた時に処理を実行します。

    フォーカスアウト

    他画面アイテムをマウスでクリックしたりユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスが外れたときに処理を実行します。

  4. 説明

    画面アイテムと選択したイベントタイプに設定した内容の説明を入力します。
  5. 設定

    アイコンをクリックすると、「外部連携設定」画面に遷移します。
  6. 通常イベント

    詳細は、「通常イベントのみの場合」の設定を参照してください。

イベント設定(テーブルイベント)画面で使用できるイベントタイプ

画面アイテムと、テーブルで設定したタイプによって、選択できるイベントタイプが異なります。
以下を参照してください。

明細テーブル

タイプ 選択できるイベントタイプ
  • 文字列
  • 数値
  • 日付
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト
  • ラジオボタン
  • セレクトボックス
  • 入力
  • 一覧選択
  • アイコンクリック
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト

グリッドテーブル

タイプ 選択できるイベントタイプ
  • 文字列
  • 数値
  • 日付
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト
  • セレクトボックス
  • 入力
  • イメージ
  • クリック
  • 一覧選択
  • アイコンクリック
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト

明細テーブル(product_72_itemSelect)

タイプ 選択できるイベントタイプ
  • 文字列
  • 数値
  • 日付
  • 一覧選択
  • フォーカスイン
  • クリック
  • 入力
  • フォーカスアウト
  • ラジオボタン
  • セレクトボックス
  • 入力

コラム

各テーブルの以下のイベントタイプは、特殊イベントに分類されます。

  • アイコンクリック

9.11.6. 外部連携設定画面(アイテムイベント)の機能と各部の説明

画面アイテム「一覧選択」などで実行する特殊イベントから外部連携を設定するための画面です。
「外部連携設定」画面の内容は以下の通りです。
../../_images/item_event_external_linkage.png
  1. アイテム

    外部連携の対象の画面アイテムの「ラベル」、「フィールド識別ID」を表示します。
  2. イベントタイプ

    外部連携処理のタイミングとなる画面アイテムのイベントタイプを表示します。
  3. アクション

    設定しているアクションの種類を表示します。
  4. 説明

    アクションとして設定した内容の説明を入力します。
    外部連携が設定済みの場合には、データソース定義名を表示します。
  5. 前処理エラー時

    2件以上の外部連携・アクションを登録している場合に、直前に実行する外部連携・アクションの処理がエラーの時に処理を続行する(次の処理を実行する)か、処理を中止するかを設定します。
    • 処理を続行する→直前の外部連携・アクションの結果に関係なく、処理を実行します。
    • 処理を中止する→直前の外部連携・アクションの結果がエラーとなった場合、処理を中止します。
    • スキップ→直前の外部連携・アクションの結果がエラーとなった場合、処理をスキップします。
  6. DM

    アイコンをクリックすると、「データマッパー」画面に遷移します。
  7. 削除

    アイコンをクリックすると、登録済みの外部連携設定を削除します。

9.11.7. 外部連携設定画面(テーブルイベント)の機能と各部の説明

テーブル系アイテムの列タイプ「一覧選択」などで実行する特殊イベントから外部連携を設定するための画面です。
「外部連携設定」画面の内容は以下の通りです。
../../_images/table_event_external_linkage.png
  1. アイテム

    外部連携処理の対象のテーブル系アイテムの列の「列名」、「フィールド識別ID」を表示します。
  2. イベントタイプ

    外部連携処理のタイミングとなる画面アイテムのイベントタイプを表示します。
    イベントタイプには以下の種類を選択できます。
    画面アイテムの種類によって使用できないものがあります。

    イベントタイプ

    説明

    フォーカスイン

    入力フィールドをマウスでクリックしたり、ユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスを合わせたときに処理を実行します。

    クリック

    入力フィールド、ボタン、アイコンをクリックしたとき、処理を実行します。

    入力

    入力フィールドに値を入力してフォーカスが外れた時に処理を実行します。

    フォーカスアウト

    他画面アイテムをマウスでクリックしたりユーザが[TAB]キーもしくは[Enter]キーを押してフォーカスが外れたときに処理を実行します。

    アイコンクリック

    一覧選択の search をクリックしたときに処理を実行します。

    インポート

    ボタンをクリックしたとき、インポートを行います。

    エクスポート

    ボタンをクリックしたとき、エクスポートを行います。

  3. データソース名

    設定しているデータソース定義の名称を表示します。
  4. 説明

    データソース定義として設定した内容の説明を入力します。
  5. 前処理エラー時

    2件以上の外部連携・アクションを登録している場合に、直前に実行する外部連携・アクションがエラーの時に処理を続行する(次の処理を実行する)か、処理を中止するかを設定します。
    • 処理を続行する→直前の外部連携・アクションの結果に関係なく、処理を実行します。
    • 処理を中止する→直前の外部連携・アクションの結果がエラーとなった場合、処理を中止します。
    • スキップ→直前の外部連携・アクションの結果がエラーとなった場合、処理をスキップします。
  6. DM

    アイコンをクリックすると、「データマッパー」画面に遷移します。
  7. 削除

    アイコンをクリックすると、登録済みの外部連携設定を削除します。

9.11.8. データマッパー画面の機能と各部の説明

外部連携を行う際に、データマッパーを利用して、データソース定義の項目とフォーム(画面)の項目のマッピングをすることができます。
「データマッパー」画面の内容は以下の通りです。
../../_images/dm_request.png
  1. フォームフィールドエリア

  2. 作業エリア

  3. マッピングエリア

  4. 外部連携フィールドエリア


データマッパー画面の各エリアの説明

エリア エリアの各部の説明

dm_detail_1


フォームフィールドエリア

  1. フォーム名
フォームの名称を表示します。
  1. フォームフィールドリスト
フォームのフィールドをツリー状に表示します。
マッピングしたい項目をクリックすると、作業エリアの「選択フォームフィールド」に追加されます。
  • レスポンスでは、表示タイプが参照の画面アイテムとforma-config.xmlで「exclude-itemselect」として指定されている画面アイテムは反映されません。


dm_detail_2

作業エリア

  1. 選択フォームフィールド
フォームフィールドリストから選択したフォームのフィールドを表示します。
  1. 選択外部連携フィールド
外部連携フィールドリストから選択した外部連携フィールドを表示します。
  1. オペレーション
式エリアで使用できる演算子を表示しています。
対象の演算子をクリックすると、式エリアの末尾に演算子を追加します。
  • 利用可能な演算子

    対象のデータ型

    利用できる演算子

    数値

    加算: +

    減算: -

    積算: ×

    除算: ÷

    注意

    • マッピング時のデータ型
    演算子の利用時に使用する対象項目は同じデータ型となっている必要があります。
    異なるデータ型の項目での演算子の利用はできませんが、関数ビルダを使用して型変換を行えば、利用することができます。
    • マッピングで利用できない記号
    データマッピングを行うフォーム(画面)、項目名に以下の記号が入っている場合には、エラーが発生します。
    • 全角文字の + 、 - 、 × 、 ÷、||
    • 半角文字の [ 、 ]、<、>
  1. 式エリア
式を作成するエリアです。

dm_detail_3



マッピングエリア

マッピングしたフォームのフィールドと外部連携フィールドを表示します。

dm_detail_4


外部連携フィールドエリア

  1. 外部連携名
外部連携の名称が表示されます。
右の search アイコンをクリックすると、対象とする外部連携(データソース)の選択画面を表示します。
  1. 外部連携フィールドリスト
  • リクエストタブの外部連携フィールドリストには、外部連携のインプットフィールドをツリー状に表示します。
  • レスポンスタブの外部連携フィールドリストには、外部連携のアウトプットフィールドをツリー状に表示します。