intra-mart Accel Platform IM-Workflow 管理者操作ガイド 第33版 2024-10-01

4.14. インポート/エクスポートを行う

インポート/エクスポートは、以下の情報をファイルに保存、またはファイルから読み取ってIM-Workflowに登録する機能です。

  • コンテンツ定義
  • ルート定義
  • フロー定義
  • 案件プロパティ定義
  • ルール定義
  • メール定義
  • IMBox定義
  • 一覧表示パターン定義
  • フローグループ定義
  • 管理グループ定義
  • 代理管理者設定
  • メッセージ定義

マスタ定義や権限者設定のバックアップ、別のintra-mart環境のIM-Workflowから各種マスタ定義をコピーをする場合に使用します。

注意

  • コンテンツ定義
  • ルート定義
  • フロー定義

上記の情報はバージョン情報を持っていますが、インポート・エクスポートの単位は定義内のバージョン情報を包括した1定義単位です。

バージョン単位でのインポート・エクスポートを行うことはできないので注意してください。

注意

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

4.14.1. インポートを活用する

  1. 「サイトマップ」「ワークフロー」→「ワークフロー管理者」→「インポート/エクスポート」→「インポート」をクリックします。

  2. インポートするファイルのチェックボックスをオンにします。

  3. 「データ選択へ」をクリックします。

    ../../_images/apply_guide_5_1.png

    コラム

    インポート対象は、ストレージサービスの以下のパス配下に配置されているファイルです。
    「%PUBLIC_STORAGE_PATH%/im_workflow/data/<テナントID>/import_export/」
    画面下部からローカルのインポートファイルをアップロードしてインポートを行うこともできます。
    (ローカルからのアップロードを有効にするためには、ワークフローパラメータの設定が必要です。ワークフローパラメータの詳細は、別紙「 IM-Workflow 仕様書 」を参照してください。)
    ../../_images/apply_guide_5_2.png
  4. インポートしたいマスタ定義のチェックボックスをオンにします。
    インポートファイルに存在し、インポート先に存在しない定義は新規登録されますので、「新規」のチェックボックスをオンにします。
    インポートファイルに存在し、インポート先にも存在する定義は更新されますので、「更新」のチェックボックスをオンにします。
    ../../_images/apply_guide_5_3.png
  5. 「インポート」をクリックします。

    ../../_images/apply_guide_5_4.png
    すべてのマスタ定義をインポートする場合は、「全選択」をクリックしてください。インポート可能なマスタ定義が全てチェック状態に変わります。
    最初の状態に戻す場合は、「全解除」をクリックしてください。選択されているマスタ定義のチェックが全て解除されます。
    キーが重複する場合(例えば、コンテンツ定義で同じコンテンツIDが複数存在する場合)は、片方の定義を選択状態にすると、残りの定義は選択できません。

    コラム

    インポート処理中に「閉じる」をクリックすると、途中でインポート処理を中止することができます。
    ただし、中止までにインポートされたマスタ定義はロールバックされません。
  6. インポートすることができました。

    ../../_images/apply_guide_5_5.png
    全てのマスタ定義が問題なくインポートされた場合は、インポート実行結果に「正常終了」が表示されます。
    インポート時に問題があったマスタ定義は、赤字で問題の内容が表示されます。
    赤字で表示された定義情報については登録されていません。
    黒字で表示された定義情報については登録されています。

コラム

インポートの仕様については、別紙「 IM-Workflow 仕様書 」を参照してください。

コラム

インポート対象のファイルは、インポート後も削除しません。
インポート/エクスポートファイル削除ジョブは、猶予期間を経過したインポート対象のファイルを削除できます。
詳細は以下のドキュメントを参照してください。

注意

インポート時に特に発生しやすい問題の内容と対処方法は以下の通りです。

  • <定義名>に登録されている<キー>が存在しないため、登録できません。
    インポートしようとしたマスタ定義に関連付けられている別のマスタ定義が存在しませんでした。
    関連付けられているマスタ定義を事前に登録するか、同時にインポートしてください。
  • ルート定義情報のインポートに失敗しています。
    ルート定義情報のインポートに失敗しています。
    この場合は、原因によって対応方法が異なりますので、エラーログを確認してください。
    • ルート定義のXMLファイルの保存に失敗しました。

      インポートしようとしたルート定義のXMLファイルがすでに存在しています。
      インポートを行う前に、ルートXMLファイルを削除してください。
    %PUBLIC_STORAGE_PATH%/im_workflow/data/<テナントID>/<ワークフローパラメータのマスタディレクトリ(master-file-dir)>/route/<ルートID>
    

4.14.2. エクスポートを活用する

  1. 「サイトマップ」→「ワークフロー」→「ワークフロー管理者」→「インポート/エクスポート」→「エクスポート」をクリックします。

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

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

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

    管理グループ定義で「フロー、ルート、コンテンツ、メッセージ、メール、IMBoxとの関連付け情報を含める」のチェックを外すと、管理グループ定義に関連付けられたフロー、ルート、コンテンツ、メッセージ、メール、IMBoxのリンク情報をファイルに含めずに出力することができます。

    コラム

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

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

コラム

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

コラム

インポート/エクスポートファイル削除ジョブは、猶予期間を経過したエクスポートファイルを削除できます。
詳細は以下のドキュメントを参照してください。

注意

出力されたファイルの内容は直接変更しないようにしてください。