IM-BIS for Accel Platform システム管理者 操作ガイド 第20版 2019-12-01

4.8. インポート・エクスポートを行う

ここでは、インポート・エクスポートの実行方法について説明します。

4.8.1. インポート・エクスポートとは

インポート・エクスポートは、他の環境のIM-BISへ定義を移すための機能です。
インポート・エクスポートの対象は、「 IM-Workflow に関する定義ファイル」や「アプリケーション情報」、「データソース定義」、「BIS定義」です。

4.8.2. インポート・エクスポートの前提条件

  • IM-BIS で作成したBISフロー/ワークフローで使用している定義をインポート・エクスポートを実行するためには IM-Workflow 、 IM-FormaDesigner のインポート・エクスポート機能も利用するため、実行ユーザに必要な権限を設定してください。

  • BIS定義のインポート・エクスポート機能は、ローカルからの入出力のみ対応しています。

  • 本番環境へのモジュールの適用方法や、変更に基づいた適用作業に必要な資材の情報等に関しては、「 IM-Workflow / IM-FormaDesigner / IM-BIS 本番適用ガイド 」を参照してください。

  • インポート機能では、BIS定義全体を上書き反映するのではなく、差分のみマージしています。
    そのため、エクスポート元とインポート先の両環境で、エクスポート元のみBIS定義の修正が存在することを前提とします。
  • インポート機能では、差分のみマージしていますが、削除内容はマージされません。
    BIS定義に関する削除は、エクスポート元とインポート先の両環境で実施してください。
  • インポート・エクスポートを利用し、定義情報を更新する場合は、新規バージョンを追加し、修正を実施することを推奨します。

コラム

エクスポート元の環境のみノードに対する設定の削除が実施された状態でインポートを実行した場合、データ不整合が発生する可能性があります。
そのため、以下のデータについては洗い替えを実施しています。
詳細は、別紙「 IM-BIS テーブル定義書(Excel版) 」を参照してください。
  • imbis_m_node_coop_detail_attr
  • imbis_m_soa_mapping
  • imbis_m_data_mapping
  • imbis_m_data_mappingに紐づくデータマッピングファイル

4.8.3. エクスポートの事前準備

IM-BIS でのエクスポート作業を行う前に事前準備として、対象の確認を行います。
IM-BIS でBISフロー/ワークフローを作成を行うと以下の情報が自動で作成されます。そのため、対象名を事前に確認する必要があります。
  • コンテンツ定義

    必ず作成され、コンテンツ名はBIS名が設定されます。
  • ルート定義

    必ず作成され、ルート名はBIS名が設定されます。
  • フロー定義

    必ず作成され、フロー名はBIS名が設定されます。
  • 案件プロパティ定義

    BISフロー/ワークフローでルール定義を利用した分岐や、追記設定などで案件プロパティを利用した場合に作成されます。
    「 IM-BIS - ルール定義」画面で、キー名となる画面項目の名称を確認します。
  • ルール定義

    BISフロー/ワークフローでルール定義を利用した分岐を含む場合に作成されます。
    「 IM-BIS - フロー編集」画面の分岐条件を設定する「分岐開始」ノードで、ルール名を確認します。

コラム

以下の情報は IM-BIS では定義されません。
IM-Workflow を利用して定義した場合はインポート/エクスポートをしてください。
詳細は、別紙「 IM-Workflow 管理者操作ガイド 」を参照してください。
  • IMBox定義
  • メール定義

コラム

「管理グループ」のインポート・エクスポートを行う場合には、 IM-Workflow 、 TableMaintenance のインポート・エクスポートをご利用ください。
  • IM-Workflow では、インポート・エクスポートで「管理グループ」に IM-BIS で使用している管理グループを含めてください。

  • TableMaintenance では、以下のテーブルを対象にインポート・エクスポートを実行してください。

    • imbis_m_administration_group
    • imbis_m_administration_plugin
    • imbis_m_administration_target
    • imbis_m_admin_relation
「一覧表示パターン」、「採番ルール定義」のインポート・エクスポートを行う場合には、 TableMaintenance のインポート・エクスポートをご利用ください。
  • 「一覧表示パターン」については、以下のテーブルを対象にインポート・エクスポートを実行してください。

    • imbis_m_list_pattern
    • imbis_m_selected_column_list
    • imbis_m_column
  • 「採番ルール定義」については、以下のテーブルを対象にインポート・エクスポートを実行してください。
    • imfr_m_auto_no
    • imfr_m_auto_no_company
    • imfr_m_auto_no_locale
    上記の「imfr_m_auto_no」、「imfr_m_auto_no_company」は、採番ルール定義を論理削除しているため、テーブルに削除済みのデータが残っています。
    不要なデータを移行ファイルから削除するためには、各テーブルに対応したCSVファイルから以下の条件でレコードを削除してください。
    • 対象テーブル.delete_flag = 1

4.8.4. エクスポートを実行する

IM-BIS の定義をエクスポートするには、以下の手順で行います。

IM-Workflow に関する定義ファイルをエクスポートする

IM-Workflow のエクスポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要な IM-Workflow の定義をエクスポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「エクスポート」→「 IM-BIS 」→「 IM-Workflow エクスポート」をクリックします。

  2. エクスポートするマスタ定義の「検索」をクリックします。
    (全てエクスポートしたい場合、「エクスポート(全件)」のチェックをオンにしてください。)
    ../../_images/imw_export_12.png
  3. エクスポートしたい定義を選択します。

    ../../_images/imw_export_13.png
  4. 「エクスポート」をクリックします。
    確認ダイアログが表示されたら「OK」をクリックします。
    ../../_images/imw_export_14.png

    フローグループ定義で「フローとの関連付け情報を含める」のチェックを外すと、フローグループ定義に関連付けられたフローのリンク情報をファイルに含めずに出力できます。

    コラム

    エクスポート処理中に「閉じる」をクリックすると、途中でエクスポート処理を中止できます。
    エクスポート処理を中止すると、それまで出力されていたファイルは削除されます。
  5. エクスポートできました。

    ../../_images/imw_export_15.png
    全てのマスタ定義が問題なくエクスポートされた場合は、エクスポート実行結果に「正常終了」が表示されます。
    エクスポート時に問題があったマスタ定義は、赤字で問題の内容が表示されます。
    赤字で表示された定義情報については出力されていません。
    また、出力されたファイルの名称が「出力ファイル名」として表示されます。

コラム

エクスポートしたファイルは、パブリックストレージの以下のディレクトリ配下に出力されます。
「%PUBLIC_STORAGE_PATH%/im_workflow/data/<テナントID>/import_export/」
エクスポートしたファイルをローカルにダウンロードしたい場合には、エクスポート結果のファイル名をクリックします。
(ローカルへのダウンロードを有効にするためには、ワークフローパラメータの設定が必要です。ワークフローパラメータの詳細は、別紙「 IM-Workflow 仕様書 」を参照してください。)
../../_images/imw_export_16.png

アプリケーション情報をエクスポートする

IM-FormaDesigner のエクスポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要なアプリケーション情報をエクスポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「システム管理者」→「エクスポート」→「 IM-BIS 」→「IM-Formaアプリエクスポート」をクリックします。

  2. 「アプリケーション情報エクスポート」画面が表示されます。

    ../../_images/forma_export_1.png
  3. 検索条件をクリックして開き、「アプリケーション名」にエクスポート対象のBIS名を入力して「検索」をクリックします。

    ../../_images/forma_export_2.png
  4. 「エクスポート」をクリックすると、エクスポートファイルを出力します。

    ../../_images/forma_export_3.png

データソース定義をエクスポートする

IM-FormaDesigner のエクスポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要なデータソース定義をエクスポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「エクスポート」→「データソース定義」→「データソース定義エクスポート」をクリックします。

  2. 「データソース情報エクスポート」画面が表示されます。

    • エクスポートタイプが「一括」の場合

      データソース定義をすべてエクスポートします。

      ../../_images/datasource_export_1.png

    • エクスポートタイプが「選択」の場合

      一覧で選択したデータソース定義をエクスポートします。

      ../../_images/datasource_export_2.png

  3. 「エクスポート実行」をクリックすると、エクスポートファイルを出力します。

    ../../_images/datasource_export_3.png

テンプレートカテゴリをエクスポートする

フォームのテンプレート機能のテンプレートカテゴリをエクスポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「エクスポート」→「テンプレートカテゴリ定義」→「テンプレートカテゴリ定義エクスポート」をクリックします。

  2. 「テンプレートカテゴリ定義エクスポート」画面が表示されます。

    ../../_images/category_export_1.png
  3. 「エクスポート実行」をクリックすると、エクスポートファイルを出力します。

    ../../_images/category_export_2.png

IM-BIS の定義をエクスポートする

IM-BIS の定義をエクスポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「エクスポート」→「 IM-BIS 」→「 IM-BIS エクスポート」をクリックします。

  2. 「BISエクスポート」画面が表示されます。

    ../../_images/bis_export_1.png
  3. 一覧の表示を絞り込む場合には、「BIS作成種類」、「BIS名」、「BIS ID」、説明のいずれかを検索条件に指定し、「検索」をクリックします。

    ../../_images/bis_export_2.png
  4. 「エクスポート」をクリックすると、エクスポートファイルをローカルに出力します。

    ../../_images/bis_export_3.png

注意

BIS定義のサイズが合計4GB以上の状態でエクスポートを行った場合に、システムエラーが発生する可能性があります。
また、「設計文書管理」を利用してサイズの大きいファイルを添付している場合には、ダウンロードに時間がかかりますので注意してください。

4.8.5. インポートを実行する

IM-BIS の定義をインポートするには、以下の手順で行います。

IM-Workflow に関する定義ファイルをインポートする

IM-Workflow のインポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要な下記の定義をインポートします。
  1. インポート対象は、パブリックストレージの以下のディレクトリ配下に配置します。
    「%PUBLIC_STORAGE_PATH%/im_workflow/data/<テナントID>/import_export/」
  2. 「サイトマップ」→「 IM-BIS 」→「インポート」→「 IM-BIS 」→「 IM-Workflow インポート」をクリックします。

  3. 「インポート」画面が表示されます。

    ../../_images/imw_import_1.png
  4. インポート対象のファイルのチェックボックスをオンにし、「データ選択へ」をクリックします。

    ../../_images/imw_import_2.png
  5. インポート対象のチェックボックスをオンにして選択します。

    ../../_images/imw_import_3.png
  6. 「インポート」をクリックしてインポートを実行します。

    ../../_images/imw_import_4.png

    注意

    異なる環境からの IM-Workflow に関する定義ファイルのインポート時に、インポート元の環境およびインポート先の環境のワークフローパラメータの設定に関する注意事項があります。
    詳細は以下のドキュメントを参照してください。

アプリケーション情報をインポートする

IM-FormaDesigner のインポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要なアプリケーション情報をインポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「インポート」→「 IM-BIS 」→「IM-Formaインポート」をクリックします。

  2. 「アプリケーション情報インポート」画面が表示されます。

    ../../_images/forma_import_1.png
  3. 「インポートファイル」にインポートするファイルの情報を設定します。

    ../../_images/forma_import_2.png
  4. 「インポート実行」をクリックすると、インポートを実行します。

    ../../_images/forma_import_3.png

コラム

アプリケーション情報インポートに伴い、テーブルの作成や更新が必要な場合には、インポート後に以下の作業が必要です。
  1. インポート先環境に対象のテーブルが存在しない(新規にアプリケーションを作成した等)
    この場合には、エクスポート時に作成されたテーブル作成のDDLをインポート処理時に実行するため、追加の作業は必要ありません。
  2. インポート先環境に対象のテーブルが存在する
    この場合には、インポート処理時にはテーブルの更新・再作成等の処理は一切行われません。
    カラムの追加等のテーブル操作が必要な場合、インポート後にBISの編集画面から「定義の反映」を実行してください。
    定義の反映の処理により、テーブルに必要な処理が実行されます。
    該当のBIS定義に複数のバージョンが含まれる場合には、バージョン単位に「定義の反映」を実行してください。
IM-FormaDesigner のアプリケーションのインポートの詳細については「 IM-FormaDesigner 作成者操作ガイド 」-「 アプリケーションの個別対応一覧 」を参照してください。

データソース定義をインポートする

IM-FormaDesigner のインポート機能を利用して、 IM-BIS で作成したBISフロー/ワークフローに必要なデータソース定義をインポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「インポート」→「データソース定義」→「データソース定義インポート」をクリックします。

  2. 「データソース情報インポート」画面が表示されます。

    ../../_images/forma_import_4.png
  3. 「インポートファイル」にインポートするファイルの情報を設定します。

    ../../_images/forma_import_5.png
  4. 「インポート実行」をクリックすると、インポートを実行します。

    ../../_images/forma_import_6.png

コラム

データソース種別「JAVA」をインポートする場合は、JAVAプログラムを別途配置する必要があります。
詳細は、「 JAVA(非推奨) 」を参照してください。

テンプレートカテゴリの定義をインポートする

フォームのテンプレート機能のテンプレートカテゴリをインポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「インポート」→「テンプレートカテゴリ定義」→「テンプレートカテゴリ定義インポート」をクリックします。

  2. 「テンプレートカテゴリ定義インポート」画面が表示されます。

    ../../_images/category_import_1.png
  3. 「インポートファイル」にインポートするファイルの情報を設定します。

    ../../_images/category_import_2.png
  4. 「インポートオプション」にインポートの方法を指定します。

    • 上書き
      テンプレートカテゴリ定義のデータをすべて削除してから、インポートファイルのデータを登録します。
      ../../_images/import_option_save.png
    • マージ
      テンプレートカテゴリ定義のデータにインポートファイルのデータを追加します。
      ../../_images/import_option_merge.png
  5. 「インポート実行」をクリックすると、インポートを実行します。

    ../../_images/category_import_3.png

IM-BIS の定義をインポートする

IM-BIS の定義をインポートします。
  1. 「サイトマップ」→「 IM-BIS 」→「インポート」→「 IM-BIS 」→「 IM-BIS インポート」をクリックします。

  2. 「BISインポート」画面が表示されます。

    ../../_images/bis_import_1.png
  3. 「インポートファイル」にインポートするファイルの情報を設定します。

    ../../_images/bis_import_2.png
  4. 「インポート実行」をクリックすると、インポートを実行します。

    ../../_images/bis_import_3.png