IM-BIS for Accel Platform IM-BIS 仕様書 第12版 2019-08-01

15. 一括インポート・エクスポートの仕様

一括インポート・エクスポートの仕様を説明します。
一括インポート・エクスポートを利用する手順については、「 IM-BIS システム管理者操作ガイド 」-「 一括インポート・エクスポートを行う 」を参照してください。

15.1. 一括インポート・エクスポートの対象

一括インポート・エクスポートで扱うことのできる定義ファイルは以下の通りです。
設定・定義
説明
BIS定義
IM-BIS で作成したフローに関する定義です。
以下の定義情報を含みます。
  • BIS定義
  • アプリケーション定義
  • フロー定義
  • コンテンツ定義
  • ルート定義
  • 設計文書管理として添付したファイル
ルール定義
-
案件プロパティ定義
利用種別に「一覧表示項目の項目として使用する」を設定している場合、別途一覧表示パターン定義のインポート・エクスポートが必要です。
管理グループ定義
-
IMBox 定義
-
メール定義
-
データソース定義
-
採番ルール定義
一括エクスポートでは、論理削除済みの採番ルール定義、採番ルール定義の「採番管理コードマスタ」(imfr_m_auto_no_code)のデータは対象外です。
一括インポート・エクスポートの対象外となる設定・定義は以下の通りです。
設定・定義
説明
サブフロー
( IM-BIS で作成したフロー)
一括エクスポート時にメインフローを選択しただけではサブフローに関する定義は含まれません。
サブフローを含める場合、サブフローもメインフローと同様に1つのBIS定義として選択します。
サブフロー
( IM-Workflow / IM-FormaDesigner で作成したフロー)
IM-BIS で作成していないフローについては、一括インポート・エクスポートの対象外です。
別途「 IM-Workflow 」「 IM-FormaDesigner 」のインポート・エクスポートをご利用ください。
テンプレートカテゴリ定義
「テンプレートカテゴリ定義インポート」「テンプレートカテゴリ定義エクスポート」をご利用ください。
一覧表示パターン定義
IM-BIS の一覧表示パターン定義を設定している場合には、以下のドキュメントに従ってインポート・エクスポートを行ってください。
コンテンツ定義・フロー定義で参照しているユーザプログラム本体
アクション処理等に設定しているユーザプログラムの本体については、ユーザモジュールとしてWARファイルに組み込んでください。
データソース定義(JAVA等)で参照するJARファイル
データソース定義で設定しているユーザプログラムの本体については、ユーザモジュールとしてWARファイルに組み込んでください。
LogicDesigner定義情報
データソース定義でLogicDesigner定義を利用している場合には、 IM-LogicDesigner のインポート・エクスポートを利用してください。

15.2. 一括インポート・エクスポートのファイル

一括インポート・エクスポートのファイルの仕様は以下の通りです。

15.2.1. 一括エクスポート時のファイルの出力先

一括エクスポートで出力されるファイルの出力先に関する仕様は以下の通りです。
  • ファイルディレクトリ

    %PUBLIC_STORAGE_PATH% / im_bis / lump_export / %一意キー%

    • 上記の出力先の設定は変更できません。
    • 出力されたファイルのディレクトリの一意キーは、複数のユーザによる競合の発生を防ぐための識別情報として自動採番されている値です。
  • ファイル名

    bis_lump_(固定)+エクスポート実行日時(yyyymmdd-HHmm).zip

    • エクスポートしたファイルは、ファイル名を変更して別の環境に一括インポートを行うことができます。

15.2.2. 一括インポート・エクスポートで扱うファイルの構成

一括インポート・エクスポートで扱うファイルについて説明します。
一括インポート・エクスポートで扱うファイルは個別のインポート・エクスポートと異なる構成になるため、個別のインポート・エクスポートで出力したファイルを一括インポートする、または逆に一括エクスポートで出力したファイルを個別でインポートする、といったことはできません。
ファイル名(bis_lump_(固定)+エクスポート実行日時(yyyymmdd-HHmm).zip)
   |
   ├─ bis
   |  |
   |  ├─ %BISID%                            ・・・ BIS定義単位に作成されるディレクトリ
   |  |   |
   |  |   ├─ bis                            ・・・ BIS定義関連のデータ
   |  |   |   |
   |  |   |   └─ %BISID%.zip
   |  |   |
   |  |   ├─ forma
   |  |   |   |
   |  |   |   └─ %アプリケーションID%.zip
   |  |   |
   |  |   └─ workflow
   |  |       |
   |  |       └─ im_workflow(固定).xml
   |  |
   |  |
   |  └─ %BISID%
   |
   ├─ rule                                  ・・・ ルール定義のデータ
   |    |
   |    └─ im_workflow(固定).xml
   |
   ├─ matter_property                       ・・・ 案件プロパティ定義のデータ
   |    |
   |    └─ im_workflow(固定).xml
   |
   ├─ bis_admin_group                       ・・・ 管理グループ定義のデータ
   |     |
   |     ├─ bis_administration_group(固定).xml
   |     |
   |     └─ im_workflow(固定).xml
   |
   ├─ imbox                                 ・・・ IMBox定義のデータ
   |    |
   |    └─ im_workflow(固定).xml
   |
   ├─ mail                                  ・・・ メール定義のデータ
   |    |
   |    └─ im_workflow(固定).xml
   |
   ├─ datasource                            ・・・ データソース定義のデータ
   |    |
   |    └─ datasource(固定).zip
   |
   └─ unique_no                             ・・・ 採番ルール定義のデータ
        |
        └─ unique_no(固定).xml

15.3. 一括インポートの仕様

15.3.1. 一括インポートでの整合性チェック

一括インポート実行時の整合性チェックに関する仕様は以下の通りです。
  • IM-Workflow に関するデータ(ファイル名が”im_workflow.xml”となるもの)については、以下のドキュメントを参照してください。

  • 上記以外のデータについては、整合性チェックは行いません。
    一括インポート中にエラーが発生した場合、エラーが発生した定義はスキップされ、次の処理を行います。
    インポート中にエラーが発生した定義については、インポート結果画面で確認できます。

15.3.2. 一括インポートの処理順序

一括インポートの処理順序は以下の通りです。
一括インポート対象外の定義は、一括インポート後に個別でインポートしてください。
  1. 案件プロパティ定義
  2. メール定義
  3. IMBox 定義
  4. ルール定義
  5. データソース定義
  6. 採番ルール定義
  7. BIS定義関連(BIS定義の単位で繰り返しインポート処理を実行)
    1. コンテンツ定義
    2. ルート定義
    3. フロー定義
    4. アプリケーション定義
    5. BIS定義
  8. 管理グループ定義( IM-Workflow → IM-BIS の順に取り込みます。)

15.4. 一括インポートの画面の機能と各部の説明

BIS定義と IM-BIS で作成したフローに関する設定や定義を一度にインポートすることができます。
インポート元のファイルは、ローカルからのアップロード、パブリックストレージからの指定のどちらにも対応しています。
../../_images/import.png
  1. ローカル

    ローカルからインポート対象のファイルをアップロードする場合に選択します。
    デフォルトでは、ローカルからのアップロードが選択されています。
  2. ストレージ

    パブリックストレージに配置したインポート対象のファイルを利用する場合に選択します。
    設定する場合にはzipファイル名まで記載します。
    ファイル名やディレクトリを指定する場合には、半角英数字と「_」、「-」、「/」、「.」以外の文字は入力できません。
    指定できる範囲は、「Public Storage」配下のみで、「../」を含むパスを記述することはできません。
    以下は、一括エクスポートのデフォルトのディレクトリに配置しているインポート対象のファイルを指定した例です。

    im_bis/lump_export/8e0x56k3gm0wy3k(一意キー)/bis_lump_20160620-0900.zip

コラム

採番ルール定義の更新インポートについて

  • インポート済みの採番ルール定義に対して、再度インポートを行う場合、更新インポートとして既存の設定内容を上書き更新します。
    ただし、番号接頭語の設定は、設定内容によって更新されない場合がありますので、適宜インポート後に必要な対応を行ってください。
    • 番号接頭語が「固定文字列」の場合

      設定内容はインポートファイルの内容でそのまま更新されます。
    • 番号接頭語が「日付形式」「プログラム」の場合

      設定内容のフォーマット(日付形式の場合は yyyy年 )は更新されますが、フォーマット変換後にセットされる値( yyyy年 を変換して採番に反映する”2016年”の値など)は更新されません。

15.4.1. 一括インポート結果画面

一括インポートの結果は、エラーが発生した場合のみ詳細を表示します。
すべて正常終了した場合には、処理完了のメッセージのみを表示します。
  • 一括インポートがすべて正常終了した場合

    ../../_images/import_result_1.png
  • 一括インポートでエラーが発生した場合

    エラーメッセージをクリックすると、エラーの詳細を表示します。
    ../../_images/import_result_2.png
    1. BIS定義のエラーメッセージ
      インポートでエラーの発生した定義とメッセージを表示します。
      メッセージをクリックすると、2.エラーメッセージ詳細を表示します。
    2. エラーメッセージ詳細
      エラーメッセージの詳細を表示します。
    3. 関連定義のエラーメッセージ
      関連定義のインポートで発生したエラーメッセージを表示します。
      IM-Workflow に関連する定義のインポートに関するメッセージについては、以下のドキュメントを参照し、必要な対応を行ってください。
      IM-FormaDesigner に関連する定義のインポートに関するメッセージについては、以下のドキュメントを参照し、必要な対応を行ってください。

15.5. 一括エクスポートの画面の機能と各部の説明

BIS定義と IM-BIS で作成したフローに関する設定や定義を一度にエクスポートすることができます。
エクスポートしたファイルは、結果画面からダウンロードすることができます。
なお、BIS定義のみ、または関連定義のみを選択してエクスポートすることもできます。
../../_images/export.png
  1. BIS定義

    エクスポート対象の IM-BIS で作成したBISフロー・ワークフローを指定します。
    1. エクスポート(全件)

      作成済みのすべてのBIS定義(BISフロー・ワークフロー)を対象に選択します。
      ただし、BISのフロー編集で「定義の反映」を一度も実行していないBIS定義は対象外です。
    2. 検索

      BIS定義の検索画面を表示します。
      任意のBIS定義をエクスポートの対象に追加するには、検索画面から追加します。
    3. 対象一覧

      エクスポート対象に選択されたBIS定義を表示します。
      「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
    4. 削除

      エクスポート対象に追加済みのBIS定義を対象一覧から削除します。
  2. 関連定義

    BIS定義に含まれないデータソース定義等の関連する定義情報を追加できます。
    「関連定義」では、BIS定義で選択したBISフロー・ワークフローに関係なく任意の定義情報を含めることができます。
    タブを切り替えると、エクスポート対象の定義の種類を変更できます。
    1. ルール定義

      ../../_images/export_rule.png
      1. エクスポート(全件)

        すべてのルール定義をエクスポート対象に選択します。
      2. 検索

        ルール定義の検索画面を表示します。
        任意のルール定義をエクスポートの対象に追加するには、検索画面から追加します。
        BIS定義をエクスポート対象としている場合であっても、該当のBIS定義での利用有無に関係なくすべてのルール定義から検索できます。
      3. 対象一覧

        エクスポート対象に選択されたルール定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みのルール定義を対象一覧から削除します。
    2. 案件プロパティ定義

      ../../_images/export_matter_property.png
      1. エクスポート(全件)

        すべての案件プロパティ定義をエクスポート対象に選択します。
      2. 検索

        案件プロパティ定義の検索画面を表示します。
        任意の案件プロパティ定義をエクスポートの対象に追加するには、検索画面から追加します。
        BIS定義をエクスポート対象としている場合であっても、該当のBIS定義での利用有無に関係なくすべての案件プロパティ定義から検索できます。
      3. 対象一覧

        エクスポート対象に選択された案件プロパティ定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みの案件プロパティ定義を対象一覧から削除します。
    3. 管理グループ定義

      ../../_images/export_administration_group.png
      1. エクスポート(全件)

        すべての管理グループ定義をエクスポート対象に選択します。
      2. 検索

        管理グループ定義の検索画面を表示します。
        任意の管理グループ定義をエクスポートの対象に追加するには、検索画面から追加します。
      3. 対象一覧

        エクスポート対象に選択された管理グループ定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みの管理グループ定義を対象一覧から削除します。
    4. IMBox 定義

      ../../_images/export_imbox.png
      1. エクスポート(全件)

        すべての IMBox 定義をエクスポート対象に選択します。
      2. 検索

        IMBox 定義の検索画面を表示します。
        任意の IMBox 定義をエクスポートの対象に追加するには、検索画面から追加します。
        BIS定義をエクスポート対象としている場合であっても、該当のBIS定義での利用有無に関係なくすべての IMBox 定義から検索できます。
      3. 対象一覧

        エクスポート対象に選択された IMBox 定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みの IMBox 定義を対象一覧から削除します。
    5. メール定義

      ../../_images/export_mail.png
      1. エクスポート(全件)

        すべてのメール定義をエクスポート対象に選択します。
      2. 検索

        メール定義の検索画面を表示します。
        任意のメール定義をエクスポートの対象に追加するには、検索画面から追加します。
        BIS定義をエクスポート対象としている場合であっても、該当のBIS定義での利用有無に関係なくすべてのメール定義から検索できます。
      3. 対象一覧

        エクスポート対象に選択されたメール定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みのメール定義を対象一覧から削除します。
    6. データソース定義

      ../../_images/export_datasource.png
      1. エクスポート(全件)

        すべてのデータソース定義をエクスポート対象に選択します。
      2. 検索

        データソース定義の検索画面を表示します。
        任意のデータソース定義をエクスポートの対象に追加するには、検索画面から追加します。
        BIS定義をエクスポート対象としている場合であっても、該当のBIS定義での利用有無に関係なくすべてのデータソース定義から検索できます。
      3. 対象一覧

        エクスポート対象に選択されたデータソース定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みのデータソース定義を対象一覧から削除します。
    7. 採番ルール定義

      ../../_images/export_numbering_rule.png
      1. エクスポート(全件)

        すべての採番ルール定義をエクスポート対象に選択します。
      2. 検索

        採番ルール定義の検索画面を表示します。
        任意の採番ルール定義をエクスポートの対象に追加するには、検索画面から追加します。
      3. 対象一覧

        エクスポート対象に選択された採番ルール定義を表示します。
        「エクスポート(全件)」がチェックされている場合、一覧は表示されません。
      4. 削除

        エクスポート対象に追加済みの採番ルール定義を対象一覧から削除します。

15.5.1. 一括エクスポート結果画面

一括エクスポートの結果は、パブリックストレージにインポート用のファイルを出力します。
正常にエクスポートが行われた場合には、結果で表示される出力ファイル名をクリックすると、インポート用のファイルをローカルにダウンロードできます。
  • エクスポートが正常に完了した場合

    ../../_images/export_result_1.png
    1. 出力ファイル

      出力先のディレクトリと出力したファイル名を表示します。
      クリックすると、ローカルに出力したファイルをダウンロードできます。
      パブリックストレージから取得する場合には 一括エクスポート時のファイルの出力先 の配下から表示されているディレクトリ・ファイル名を確認してください。
警告やエラーが発生した場合には、メッセージをクリックすると詳細の確認ができます。
  • エクスポートで警告やエラーが発生した場合

    ../../_images/export_result_2.png
  1. 出力ファイル
    エクスポートでは、エラーや警告が発生した場合であっても正常にエクスポートできる定義が存在する場合、正常にエクスポートできる定義のみを出力します。
    クリックすると、ローカルに出力したファイルをダウンロードできます。
  2. エラーメッセージ
    エラーメッセージを表示します。
    クリックすると、3.エラーメッセージ詳細を確認できます。
  3. エラーメッセージ詳細
    一括エクスポートで発生したエラーメッセージを表示します。