メインコンテンツまでスキップ
バージョン: v2.3.0

FRUCtoS v2.2.0 エクスポート手順 (Docker)

注意

v2.3.0およびv2.4.0の資材をお持ちの方へ

  • 現在、ご利用中のv2.3.0およびv2.4.0のパッケージ内に含まれているdump-toolsおよびdump-tools-auditeventのエクスポートツールは、古いバージョンのものとなっています。このため、現行のダンプツールでは正しく動作しない可能性があります。
  • 最新のダンプツールが必要な場合は、 お手数ですがこちらからお問い合わせください。

1. 本手順の目的​

本手順はFRUCtoS v2.2.0のデータのエクスポート手順を記載しています。

FRUCtoSではFHIRリソース本体とその履歴のほかに検索のためのインデックスを内部的に生成し保持しています。 エクスポート時にFHIRリソース本体とその履歴のみを出力し、インポート時にFHIRリソース本体とその履歴の入力とインデックスの再生成することで異なるバージョン間でのデータ移行を実現しています。

バージョンアップに伴いデータベース(以下DB)の互換性が失われる場合があるため、v2.2.0のデータをv2.3.0の環境で利用する必要がある場合、本手順のエクスポートとFRUCtoS インポートを行うことを推奨します。

注記

ダンプツールは、1つ前のバージョンからのデータ移行のみサポートしています。

本手順は、以下に関する基本的な知識を有する作業者を対象としています。

  • FRUCtoS
  • Docker
注意
  • ダンプツールではFRUCtoSリポジトリのリソースの登録・改変履歴をテキストファイルに出力し、リポジトリのバックアップやデータ移行に用いることができます。その性質上内部には機密性の高いデータが含まれるため、取り扱いに際しては運用ルール等を定めて厳格に取り扱うことが求められます。
  • バックアップ等データの復元可能な準備を行ってから実施してください。
備考

例としてDockerを実行環境とする場合を記載しています。 他のDocker互換のコンテナ実行環境をお使いの方は、適宜読み替えてください。 設定ファイルも適宜書き換えてください。

2. 準備​

2.1. 必要な資材​

  • v2.2.0-dump-tools-export
    • 通常リソースのエクスポートの資材
  • v2.2.0-dump-tools-auditevent-export
    • 監査ログのエクスポートの資材
    • 監査ログのデータ移行を行う場合のみ必要

2.2. 資材のダウンロード​

v2.2.0-dump-tools-exportは、FRUCtoSの資材のdump-toolsフォルダに、
v2.2.0-dump-tools-auditevent-exportは、FRUCtoSの資材のdump-tools-auditeventフォルダにそれぞれ入っています。
FRUCtoSの資材をお持ちでない場合は、こちらからお申込みください。

2.3. 配布資材の構成​

  • v2.2.0-dump-tools-exportのフォルダ/ファイル構成は以下となっています。
v2.2.0-dump-tools-export/
|-- Export.ps1    ・・・エクスポート時に実行するファイル(Windows環境)
|-- Export.sh     ・・・エクスポート時に実行するファイル(Linux/Mac環境)
|-- README.md
|-- fructoslog    ・・・デフォルトでエクスポートしたファイルが出力されるディレクトリ
`-- tools
  • v2.2.0-dump-tools-auditevent-exportのフォルダ/ファイル構成は以下となっています。
v2.2.0-dump-tools-auditevent-export/
|-- AuditEventExport.ps1    ・・・エクスポート時に実行するファイル(Windows環境)
|-- AuditEventExport.sh     ・・・エクスポート時に実行するファイル(Linux/Mac環境)
|-- README.md
|-- fructoslog              ・・・デフォルトでエクスポートしたファイルが出力されるディレクトリ
`-- tools
注意

docker-composeのバージョンがv2.0.0以上の場合、以下ファイル内のdocker-composeコマンドをdocker composeコマンドに修正した後ご利用ください。
・ Export.bat
・ Export.sh
・ AuditEventExport.bat
・ AuditEventExport.sh

3. エクスポート手順​

通常リソースと監査ログのデータ移行を行う場合は、3.1.以降の全ての手順を実施してください。
通常リソースのみデータ移行を行う場合は、3.1., 3.2., 3.3., 3.4. のみ実施してください。

3.1. FRUCtoSの停止​

  • FRUCtoSの配置フォルダへ移動して以下コマンドを実行します。

    Powershell/Shell
    docker-compose stop tomcat

3.2. 【通常リソース】エクスポートの準備​

  1. v2.2.0-dump-tools-exportをFRUCtoSの配置フォルダ直下に配置します。
  2. v2.2.0-dump-tools-export/Export.ps1をメモ帳などで開き、ユーザー設定項目のエクスポート先を修正してください。デフォルトはv2.2.0-dump-tools-export/fructoslogとなっています。
# =============== ユーザー設定項目 ===============
## エクスポートしたファイルを保存するディレクトリ
$TransactionlogFilePath="$(pwd)/fructoslog/"
# ================================================

3.3. 【通常リソース】エクスポートの実施​

  1. v2.2.0-dump-tools-exportで以下コマンドをを実行します。

    Powershell
    PowerShell .\Export.ps1

  2. エクスポートが開始されるので、コマンドが終了するまで待機します。

  3. コマンド終了後、以下コマンドを実行します。 0 が表示されれば正常に終了しています。

    Powershell
    echo $lastexitcode
ヒント

環境によりPowerShellスクリプトが実行出来ない場合は、必要に応じてPowerShellスクリプトの実行に先立ち、 以下の「Windowsの実行ポリシーの設定」や「PowerShellスクリプトのプロパティ変更」を行ってください。

  • 実行ポリシーの設定

    PowerShell
    Set-ExecutionPolicy RemoteSigned -Scope Process

    『y』を入力してください。

  • プロパティ変更
    Export.ps1ファイルの『セキュリティ』を次の手順で許可にしてください。

    1. Export.ps1ファイルをエクスプローラーで選択し、マウスボタン右クリックでプロパティを表示します。
    2. 『全般』タブの『セキュリティ：』の『許可する(K)』をチェックします。

3.4. 【通常リソース】出力ファイルの確認​

  • 正常にエクスポートが実行された場合、3.2. 【通常リソース】エクスポートの準備で設定したフォルダにfhirlogファイルとgzファイルが存在します。
  • gzファイルをインポートで使用します。よって、gzファイルは適切な場所に保管しておいてください。

3.5. 【監査ログ】エクスポートの準備​

監査ログのエクスポートの準備
  1. v2.2.0-dump-tools-auditevent-exportをFRUCtoSの配置フォルダ直下に配置します。
  2. v2.2.0-dump-tools-auditevent-export/AuditEventExport.ps1をメモ帳などで開き、ユーザー設定項目のエクスポート先を修正してください。デフォルトはv2.2.0-dump-tools-auditevent-export/fructoslogとなっています。修正する場合は3.2. 【通常リソース】エクスポートの準備とは異なるフォルダを設定してください。
# =============== ユーザー設定項目 ===============
## エクスポートしたファイルを保存するディレクトリ
$TransactionlogFilePath="$(pwd)/fructoslog/"
# ================================================

3.6. 【監査ログ】エクスポートの実施​

監査ログのデータ移行を行わない場合、本手順はスキップしてください。

監査ログのエクスポートの実施

  1. v2.2.0-dump-tools-auditevent-exportで以下コマンドを実行します。

    Powershell
    PowerShell .\AuditEventExport.ps1

  2. エクスポートが開始されるので、コマンドが終了するまで待機します。

  3. コマンド終了後、以下コマンドを実行します。 0 が表示されれば正常に終了しています。

    Powershell
    echo $lastexitcode
ヒント

環境によりPowerShellスクリプトが実行出来ない場合は、必要に応じてPowerShellスクリプトの実行に先立ち、 3.3. 【通常リソース】エクスポートの実施と同様に「Windowsの実行ポリシーの設定」や「PowerShellスクリプトのプロパティ変更」を行ってください。

3.7. 【監査ログ】出力ファイルの確認​

監査ログのデータ移行を行わない場合、本手順はスキップしてください。

監査ログの出力ファイルの確認
  • 正常にエクスポートが実行された場合、3.5. 【監査ログ】エクスポートの準備で設定したフォルダにfhirlogファイルとgzファイルが存在します。
  • gzファイルをインポートで使用します。よって、gzファイルは適切な場所に保管しておいてください。