データのインポート/エクスポート
ここでは、作成したアプリケーションやマスタデータの移行について、開発環境から本番環境への移行を想定して解説します。
開発環境でのマスタデータやアプリケーションの作成および動作検証が終了したら、本番環境への移行作業を行います。
本番適用の基本的な作業は 「移行元からデータをエクスポートし、移行先へインポート」 です。
この項目では、intra-martにおけるインポート・エクスポートの仕様を確認しながら、何のデータをどのように、どのような順序で移行するか、という手順を解説します。また、予期せぬ事故を起こさないための安全な移行の方法もあわせて見ていきましょう。
テスト環境と同様に、ここではミドルウェアのセットアップ完了後のテナント環境セットアップ以降の設定について説明します。
ミドルウェアのセットアップからデプロイまでの詳しい手順は、下記のページもあわせて参照してください。
「セットアップガイド」
「クイックセットアップガイド」
本番環境構築の概要
intra-martでは、開発環境と検証環境を分けて構築し、開発環境→検証環境→本番環境 という段階を踏んだ移行 を推奨しています。
開発環境上で自由に開発したデータには、不必要なものも含まれている場合があります。検証環境でデータの取捨選択をしたうえで本番環境に移行することで、予期せぬ事故などが起こらない安全な移行作業が可能です。
開発および検証環境の情報に基づいて本番環境を新しく構築する場合には、必要な情報のみを適切に移行する必要があります。
移行作業を行うにあたって、
- 移行するデータにどのようなものがあるか（会社組織などのマスタデータ、使用しているアプリケーションやそれに関する設定ファイル など）
- データをエクスポートおよびインポートする手段はどれか（intra-martの画面からか、ジョブやAPIを利用するのか など）
- データの形式は何か（xmlやcsv、xlsx、json など）
などを把握し、適切に環境構築するための手順を理解しましょう。
前提条件
- 検証環境と本番環境でのアプリケーションの構成、バージョン（パッチ含む）は、同一とし、IM-Jugglingのプロジェクトも共通とする
- マスタデータについて、会社・組織・役職、パブリックグループ・役割といったユーザを除くデータは、検証環境からそのまま本番環境に移行
- ユーザのマスタデータ（ユーザ、ユーザ所属情報など）については、「IM-共通マスタ インポート・エクスポート仕様書」に基づいたインポートファイルを、本番環境の構築前に作成
対象データの移行方法一覧
移行はデータによって最適な方法が異なり、またファイル形式もさまざまです。あらかじめそれぞれの移行方法やファイル形式などを把握しておくと、スムーズな作業が可能です。
移行の実行方法には、ジョブを利用するもの、Javaやスクリプト開発モデルなどのAPIを利用するもの、inrta-mart Accel Platformの設定画面から操作するものがあります。
以下は、intra-mart上の標準で活用されるエクスポートデータの一例です。
| 移行対象物 | 移行方法 | ファイル形式 | 補足事項 |
|---|---|---|---|
| IM-共通マスタ | ジョブ、API | XML、csv | 会社グループ、会社組織、パブリックグループ、パブリックグループ分類、プライベートグループ、ユーザ、ユーザ分類、法人グループ、法人、取引先、品目、品目カテゴリ、通貨 の情報が含まれます |
| 認可情報（IM-Authz） | ジョブ、画面 | xml、xlsx | リソース、リソースグループ、サブジェクトグループ、ポリシー の情報が含まれます |
| アカウント情報 | ジョブ、API | xml、csv | アカウント情報、アカウントテーマ情報、日付と時刻の形式情報、アカウント属性情報、アカウント付与ロール情報、アプリケーションライセンス情報 が含まれます |
| ロール情報 | ジョブ、API | xml | ロール情報、ロール表示名情報、ロール親子関係 の情報が含まれます |
| メニュー情報 | ジョブ、API | XML | メニューグループカテゴリ情報、メニューグループカテゴリ表示名情報、メニューグループ、メニューグループ情報、メニュー情報、メニュー引数情報、メニュー表示名情報、メニューグループカテゴリ内包情報 のデータが含まれます |
| IM-Workflow | 画面 | xml | IM-Workflow の各種マスタ定義 が含まれます |
| IM-Repository | 画面 | xlsx、json | 辞書、列挙、エンティティ のデータが含まれます |
| テーブルデータ | 画面 | csv | データベース上のテーブルのデータを「TableMaintenance」機能でインポート/エクスポートします |
| ジョブ情報 | ジョブ、API | xml | ジョブ情報のインポート/エクスポートを行います |
| Accel Studioアプリケーション | 画面 | zip | Accel Studioの画面から、アプリケーション単位の統合的なローコード資材（アプリケーション情報、アプリケーションカテゴリ、リソース情報、認可情報）をインポート/エクスポートします |
| Accel Studioユーテリティ | 画面 | xlsx、json | Accel Studioで利用する採番定義、共通定数定義、多言語メッセージ定義をインポート/エクスポートします |
| IM-BloomMaker定義ファイル | 画面 | zip | IM-BloomMakerで作成したコンテンツ定義をインポート/エクスポートします |
| IM-LogicDesigner定義ファイル | 画面 | zip | IM-LogicDesignerで作成したコンテンツ定義をインポート/エクスポートします |
| ViewCreatorデータ | 画面 | zip | ViewCreatorで作成したクエリやデータ参照およびルーティング定義をインポート/エクスポートします |
| IM-BIS/Forma定義 | 画面 | zip | 「一括インポート・エクスポート」機能で特定のBIS定義、およびFormaアプリケーションとその定義に関連する定義のインポート・エクスポートをまとめて実行します |
| IM-BPMデータ | 画面 | zip | IM-BPMで作成した処理プロセスなどのデータをインポート/エクスポートします |
| IM-Copirotアシスタント定義 | 画面 | json | IM-Copirotのアシスタント定義データをインポート/エクスポートします |
| IM-共通マスタ テンプレート定義 | 画面 | json | json形式で作成したテンプレート定義情報とその親となるテンプレートカテゴリ情報をインポート/エクスポートします |
各ツールのインポート/エクスポートの詳細については、「製品別ドキュメントライブラリ - インポート/エクスポート タグ検索結果一覧」より、各ドキュメントを参照してください。
移行手順
開発・検証環境から新しく本番環境を構築するための手順について説明します。
intra-mart全体の資材の移行
(1) テナント環境セットアップ
必要なデータのエクスポートが完了したら、「初期設定 > 2. intra-martの初期設定 > 環境のセットアップ」 と同様に、テナント環境セットアップを行います。
(2) テナント環境セットアップ後の作業
「テナント環境セットアップ」やセットアップ後のライセンス登録などの実施後、「ファイル操作」で必要なデータを移行します。
ファイル操作の対象
「ファイル操作」で設定するファイルには、以下のものがあります。
- template.html （ IM-FormaDesigner 、 IM-BIS ）
- ワークフローパラメータ（tenant）
- 印影関連の設定（param_stamp）
- IM共通マスタのインポート設定ファイル
「ファイル操作」については、以下のドキュメントに基づいて実施してください。
システム管理者操作ガイド - ファイル操作
マスタデータなどの個別資材のインポート
テナント環境セットアップなどの作業で、intra-mart Accel Platform本体の準備が整ったら、マスタデータやアプリケーションなど、個別のデータをインポートしましょう。
上位マスタが先に存在していないと参照整合エラーになるため、インポートを行う順番は重要です。また、インポートはアプリ単位で上書きになるので特定バージョンのみの差分インポートは基本不可となることにも注意が必要です。
推奨するインポート順
データをインポートする際には、データ同士の関係や順番に注意しましょう。例えば、マスタデータを活用するアプリケーションを作成したとして、先にアプリケーションをインポートしてしまうとデータの不整合や意図しない変更が発生してしまう恐れもあります。
以下のように、マスタのデータを先にインポートしたのちにアプリケーションのインポートを行うと、データの不整合などを防ぎやすくなります。
- 会社/組織
- ユーザ情報
- ロール/ロール割り当て
- ライセンス情報
- メニュー/ポータル
- 認可
- その他アプリケーションや資材
(1) ジョブによるマスタデータのインポート
ジョブを利用してマスタデータ登録を行います。
「ジョブの実行」についての詳細は、「6. 運用中のやること > 定期的に処理を実行する」を参照してください。
基盤系ジョブ
最初に基盤のジョブを実行します。
-
ジョブの実行順は、以下のドキュメントに基づいて確認してください。
「テナント環境セットアップ 仕様書 - インポートするデータの依存関係」 -
ジョブのパラメータの設定は、以下のドキュメントを参照してください。
「ジョブ・ジョブネットリファレンス」 -
認可のインポート・エクスポートの設定は、以下のドキュメントを参照してください。
「IM-Authz（認可）インポート・エクスポート仕様書」
共通マスタ系ジョブ
共通マスタのジョブを実行します。
-
共通マスタのインポート・エクスポートは、以下のドキュメントを参照してください。
「IM-共通マスタ インポート・エクスポート仕様書」 -
共通マスタのインポートは、以下の順序に従ってください。
1 ユーザ
2 会社組織
3 パブリックグループ
上記以外の共通マスタのデータの順序は特にルールはありません。詳細は、以下のドキュメントを参照してください。
「IM-共通マスタ インポート・エクスポート仕様書 - データ領域」
(2) アプリケーションのインポート
ノーコード/ローコード開発したアプリケーションのインポート
intra-martの代表的なアプリケーションのインポート手順となります。
- IM-BloomMaker（画面定義）
- 管理画面から「インポート」を実行、またはユーザモジュール内の拡張インポート
- 必要なユーザモジュールや独自APIをデプロイ、画面の表示確認。ストレージの添付ファイルは別途コピー
- IM-LogicDesigner（サーバ側ロジック）
- LogicDesignerのインポート画面またはLogicFlowImporter APIで取り込み（APIはログインテナント操作が前提）
- 該当モジュール（Java等）をデプロイ、ジョブやトリガーの動作確認
- IM-FormaDesigner/Forma（フォーム・アプリ）
- 管理画面から「インポート」を実行、既存のテーブルと競合するとDDLでエラーになる箇所はスキップされることがあるので注意
- テーブルのカラム追加やサイズ変更は本番側の「テーブル設定画面」から手動で反映。ユーザプログラムは別途デプロイ
- IM-Workflow（ワークフロー定義）
- ワークフロー管理の「インポート」で取り込み。インポート前に対象ユーザ/組織/コンテンツが存在することを確認
- IM-BIS（BISフロー/案件管理）
- 管理画面から「インポート」を実行、BIS側のテーブル作成オプション等を確認（既存案件保持のための設定に注意）
- 関連するFormaやWorkflowを先に整備しておく。トランザクションテーブルや既存案件の参照をチェック
(3) その他のインポート
「対象データの移行方法一覧」で確認した、画面やAPIからのインポートが必要なデータをインポートします。
IM-Workflow、IM-FormaDesigner、IM-BISの移行作業の詳細については、以下のドキュメントを参照してください。
IM-Workflow / IM-FormaDesigner / IM-BIS 本番適用ガイド
プロコード開発したアプリケーションのインポート
intra-mart標準のアプリケーションや設定ファイル以外の、プロコード開発で独自に作成したアプリケーションや設定ファイルの移行について見ていきましょう。
- intra-mart推奨の手順
ローカル上のファイルを直接修正・操作してアプリケーションサーバ（Resin）を再起動という方法よりも、IM-Juggling側で設定ファイルを修正し、それを書き出しする ことを推奨します。
こうした場合、将来的にIM-Juggling上でプロジェクトのアップデートをした際に、設定ファイルを修正しなくて良いという利点があります。
- IM-Juggling上で、プロジェクトの「juggling.im」を開き、「設定ファイル」タブを選択します。
編集したい設定ファイルのあるモジュールを選択し、「出力」ボタンをクリックしてください。
- プロジェクト直下のconfフォルダ配下にファイルが出力されます。必要に応じて設定ファイルを編集し、保存してください。
