Viedocデータインポートアプリケーション
はじめに
Viedocでは、Viedocデータインポートアプリケーションを使用して、ラボデータ等のデータをViedocの試験にインポートする機能を提供しています。データをインポートする際、Viedocデータインポートアプリケーションでは以下を行います。
- データマッピングファイルを使用して、提供されたデータをCDISC ODMの臨床データ形式に変換する。
- ViedocのAPIを介して、そのデータをViedocにプッシュ（追加）する。
このドキュメントでは、Viedocデータインポートアプリケーションを使用して、Viedocにデータをインポートする方法を説明します。一般的なデータインポートの手順と以下のステップについて解説します。
- Viedoc DesignerからDefine-XML形式のデータマッピングファイルをダウンロードする。
- Viedoc AdminでViedoc APIのクライアントキーを作成する。詳細は、API設定を参照ください。
- 構成ファイルを作成する
- 作業フォルダーを準備する
- Viedocデータインポートアプリケーションをダウンロードする
- データを作業フォルダーに投入する
- Viedocデータインポートアプリケーションを実行する
追加情報
このドキュメントでは、Define-XML形式でデータマッピングファイルを作成する方法は説明されていません。データマッピングファイルの作成方法については、データインポート用のデータマッピングを作成するを参照してください。
Viedocへのデータのインポートに関する詳細は、チュートリアル動画で解説しています。
サーバーインスタンスの詳細については、Viedocサーバーインスタンスのガイドを参照してください。
Viedocへのデータのインポートについて
Viedocデータインポートアプリケーション
Viedocでは、Viedocデータインポートアプリケーションを介して、データをフォーム（ラボデータなど）にインポートする機能を提供しています。
Viedocにデータをインポートするにあたり、Viedocデータインポートアプリケーションは、まず提供されたデータをCDISC ODMの臨床データ形式に変換します。これを行うには以下が必要となります。
-
データマッピングファイル：提供されたデータをCDISC ODM形式に変換するために使用されます。
-
コンフィグファイル
-
Viedocにインポートするデータが入ったデータファイル。このデータファイルは区切りファイルの必要があります。デフォルトでカンマ区切り（CSV）ファイルがサポートされていますが、構成ファイルで区切り文字を指定することにより、他の区切り文字を使用することもできます。
次に、Viedocデータインポートアプリケーションは、Viedoc APIを介してCDISC ODM形式の臨床データをViedocにプッシュします。これを行うには、アプリケーションで以下が必要となります。
-
適切な権限を持っているViedoc ユーザーネームとパスワード
-
試験固有のViedoc APIのクライアントキー
Viedoc Designerのグローバルデザイン設定のデータマッピングウィンドウから、Viedocデータインポートアプリケーションの最新バージョンをダウンロードすることができます。手順については、3.6 Viedocデータインポートアプリケーションをダウンロードするを参照してください。
データマッピングファイル
データマッピングファイルでは、どのように外部データをViedocのフォーム項目にマッピングするかを定義します。また、インポートするデータファイルのそれぞれの列、およびViedoc側のデータのインポート先を記載します。
データマッピングファイルは、Viedoc Designerのグローバルデザイン設定で作成されます。システム内では、データマッピングはCDISC Define-XML形式で保存されます。インポートするデータファイルのタイプごとに、個別のデータマッピングファイルを作成する必要があります。
データマッピングファイルの作成方法については、データインポートのためのデータマッピングを作成する
構成ファイル
構成ファイルでは以下を定義します。
- Viedocのどの試験にデータをインポートするか
- データマッピングファイルの場所
- インポートするデータを含むデータファイルの場所
- データをインポートする先のAPIインスタンス（v4、v4training、v4jpなど）
- データをインポートするときに使用するログイン認証情報
上記の情報は、構成ファイルで定義しなければならない項目です。オプションで、構成ファイルを使用して以下を定義することができます。
- インポートされたデータの中に、まだ試験に追加されていない患者のデータが含まれている場合、データのインポート中に新しい患者を自動的に作成するかどうか
- インポートされたデータの中に、まだ実施されていないイベントのデータが含まれている場合、データのインポート中にイベントを実施するかどうか
- インポートしたファイルを読み込む時、どの文字エンコーディングを使用するのか
- インポートされたファイルを解析する時、どの区切り文字を使用するのか
構成ファイルは任意のテキストエディターで作成できるXMLファイルです。1つの構成ファイルに、複数のインポート案件および複数試験のインポートを含めることができます。
構成ファイルの作成方法については、3.5 構成ファイルを作成し、作業フォルダーを準備するのセクションを参照してください。
Viedocデータインポートアプリケーションを使用してViedocにデータをインポートする
はじめに
このセクションでは、Viedocデータインポートアプリケーションを使用してViedocにデータをインポートする手順を説明します。
データマッピングファイルを作成する
データインポート用のデータマッピングを作成するの手順に従って、Viedoc Designerでデータマッピングファイルを作成します。データマッピングファイルではデータファイルの各列を、それらに対応するViedocのフォーム項目にマッピングする必要があります。また、インポートするデータファイルのタイプごとに1つのデータマッピングファイルが必要となります。
データファイルのすべての列がマッピングできたら、データマッピングを保存し、グローバルデザイン設定ウィンドウで変更を確定します。
データマッピングファイルをダウンロードする
以下の通り、データマッピングファイルをダウンロードしてください（eラーニングのデータインポート用のデータマッピングの手順も参照してください）。
| 1 |
データマッピングフィールドで変更をクリックし、データマッピングの概要を開きます。 |
| 2 |
先ほど作成したデータマッピングの右側にあるダウンロードアイコンをクリックします。データマッピングを含むXMLファイルがダウンロードされます。 |
Viedoc APIクライアントキーの作成
API設定を参照ください。
構成ファイルを作成し、作業フォルダーを準備する
PCにフォルダー構成を作成する
構成ファイル、データマッピングファイル、およびインポートするデータを保存するフォルダー構成を作成するには：
- PC上で作業フォルダーを作成します。
このドキュメントで使用する例では、"helipad"という作業フォルダーをCドライブに直接作成しています。セクション3.5.3 正しいフォルダー構成の例も参照してください。 - 作業フォルダー内で、インポート案件ごとに1つのサブフォルダー（プロジェクトフォルダー）を作成します（
例： "ProjectFolder1"）。 - 作業フォルダー内の各プロジェクトフォルダーにデータマッピングファイルを保存します。
構成ファイルを作成する
構成ファイルを作成するには：
| 1 |
選択したテキストエディターで、以下の例に従ってXMLファイルを作成します（必要に応じて、以下のテキストをコピーして貼り付けてください）。 |
| 2 |
XMLタグを編集し、以下の情報を指定します。XMLタグでは大文字と小文字が区別されることに注意してください！ < ImportConfiguration > セクションで以下の情報を指定します。 a) < FolderName > ：データマッピングファイルとインポートするデータファイルが保存されているプロジェクトフォルダーの名前。このフォルダーは作業フォルダー内のサブフォルダーであることが必要です。 b) <DefineXmlFileName>: データマッピングファイルの名前。 c) <ApiUrl>: データのインポート先のViedoc APIインスタンスのURL。URLは次のように命名されます。アプリケーション+インスタンス+国（ストックホルムのインスタンスでは、国名は使用されていません）。 欧州向け URL:
日本向け URL:
中国向け URL:
米国向け URL:
d) <ClientGuid>: Viedoc APIのクライアントID e) <UserName>: ログインに使用するViedocユーザーのユーザーネーム f) <Password>: ユーザーのパスワード。アプリケーションを初めて実行した後、パスワードは暗号化されたパスワードに置き換えられます。 g) <AllowCreatingSubjects>: これがtrueに設定されていると、データファイルにまだ試験に追加されていない患者のデータが含まれている場合、インポート中に新しい患者が自動的に作成されます。デフォルトはtrueです。 h) <AllowInitiatingStudyEvents>: これがtrueに設定されていると、データファイルにまだ実施されていないイベントのデータが含まれている場合は、インポート中にイベントが自動的に実施されます。デフォルトはtrueです。 i) <FileDelimiter>: インポートされたファイルを解析するときに使用される区切り文字を設定します。デフォルトは"、"（カンマ）です。利用可能なすべてのシンボルおよびタブがファイルの区切り文字としてサポートされています。 j) <FileEncoding>: インポートされたファイルを解析するときに使用する文字エンコーディングのタイプを指定します。サポートされているすべてのエンコーディングのリストについては、表2を参照してください。デフォルトはutf-8です。 なお、<ClientGuid>、<UserName>と<Password> はすべて、<ApiUrl> タグによって指定されたViedoc APIに属している必要があります。 <AllowCreatingSubjects>、<AllowInitiatingStudyEvents>、<FileDelimiter>および<FileEncoding>タグの指定はオプションです。何も指定されていない場合、アプリケーションはデフォルトを使用します。 |
| 3 |
複数タイプのデータファイルをインポートする場合は、各データファイルタイプに新しい<ImportConfiguration>セクションを追加し、ステップ2の説明に従ってXMLタグを編集してください。 |
| 4 |
構成ファイルを作業フォルダーに保存します。 |
|
名称 |
エンコードの種類 |
|
|---|---|---|
| gb2312 |
簡体字中国語（GB2312） |
|
| utf-16 |
Unicode |
|
| unicodeFFFE |
Unicode（ビッグエンディアン） |
|
| Winodws-1252 |
西ヨーロッパ言語（Windows） |
|
| x-mac-korean |
韓国語（Mac） |
|
| x-mac-chinesesimp |
簡体字中国語（Mac） |
|
| utf-32 |
Unicode（UTF-32） |
|
| utf-32BE |
Unicode（UTF-32ビッグエンディアン） |
|
| us-ascii |
US-ASCII |
|
| x-cp20936 |
簡体字中国語（GB2312-80） |
|
| x-cp20949 |
韓国語 Wansung |
|
| iso-8859-1 |
西ヨーロッパ言語（ISO） |
|
| iso-8859-8 |
ヘブライ語（ISO-Visual） |
|
| iso-8859-8-1 |
ヘブライ語（ISO Logical） |
|
| iso-2022-jp |
日本語（JIS） |
|
| csISO2022JP |
日本語 (JIS-Allow 1 byte Kana) |
|
| iso-2022-jp |
日本語 (JIS-Allow 1 byte Kana - SO/SI) |
|
| iso-2022-kr |
韓国語（ISO） |
|
| x-cp50227 |
簡体字中国語（ISO-2022） |
|
| euc-jp |
日本語（EUC） |
|
| EUC-CN |
簡体字中国語（EUC） |
|
| euc-kr |
韓国語（EUC） |
|
| hz-gb-2312 |
簡体字中国語（HZ） |
|
| GB18030 |
簡体字中国語（GB18030） |
|
| x-iscii-de |
ISCIIデーヴァナーガリー |
|
| x-iscii-be |
ISCIIベンガル |
|
| x-iscii-ta |
ISCIIタミル |
|
| x-iscii-te |
ISCIIテルグ |
|
| x-iscii-as |
ISCIIアッサム |
|
| x-iscii-or |
ISCIIオリヤー |
|
| x-iscii-ka |
ISCIIカンナダ |
|
| x-iscii-ma |
ISCIIマラヤラム |
|
| x-iscii-gu |
ISCIIグジャラート |
|
| x-iscii-pa |
ISCIIパンジャブ |
|
| utf-7 | Unicode (UTF-7) | |
| utf-8 | Unicode (UTF-8) |
正しいフォルダー構成の例
上記の構成ファイルの例では、作業フォルダーはC:\helipad.になっています。作業フォルダーには、プロジェクトフォルダーのProjectFolder1と構成ファイルのViedocImportConfiguration.xmlが入っています。
プロジェクトフォルダーProjectFolder1には、データマッピングファイルのDemoStudy -DataMapping.xml が含まれています。
インポートするデータが入っているデータファイルもプロジェクトフォルダーに保存する必要があります。
Viedocデータインポートアプリケーションをダウンロードする
Viedocデータインポートアプリケーションをダウンロードして、インストールするには：
| 1 |
Viedoc Designerのグローバルデザイン設定で、 データマッピングフィールドの変更アイコンをクリックして、 データマッピングウィンドウを開きます。 |
| 2 |
Viedocのインポートアプリケーションをダウンロードをクリックして、インストールファイルをダウンロードします。zipファイルがダウンロードされます。 
|
| 3 |
zipファイルをコンピューター上の任意の場所に保存し、ファイルを展開します。 |
データをプロジェクトフォルダーに投入する
インポートするデータが入っているデータファイルを、プロジェクトフォルダーに保存します。
Viedocデータインポートアプリケーションを実行する
アプリケーションを実行してデータをインポートするには：
| 1 |
Viedocデータインポートアプリケーションのアイコンをダブルクリックして、アプリケーションを起動します。 
|
| 2 |
詳細をクリックし、 実行をクリックします。 
|
| 3 |
構成ファイルのパスを入力して（例：c：¥helipad¥ViedocImportConfiguration.xml）、Enterキーを押します。 |
実行すると、このアプリケーションは構成ファイルで指定されているすべてのプロジェクトフォルダーを通過し、これらのプロジェクトフォルダーで見つかったすべてのデータファイルのデータをインポートします。特定のプロジェクトフォルダーにデータファイルが見つからない場合、そのプロジェクトはスキップされます。
インポート後、アプリケーションは自動的に閉じます。
Viedoc Adminでインポートのステータスを確認することが可能です。まず、Viedoc AdminのAPI設定フィールドの変更アイコンをクリックして、API設定ウィンドウを開きます。データの送信履歴リストに、インポートに使用されたクライアントID、インポートの日付と時刻、およびステータスが表示されます。データインポートの内容とログファイルをダウンロードすることが可能です。
追加でデータをインポートする
新しいデータをインポートする場合は、それぞれのプロジェクトフォルダーにデータファイルを保存し、Viedocデータインポートアプリケーションのアイコンをダブルクリックして、アプリケーションを再度実行します。
構成ファイルはいつでも編集することができ、インポート案件を追加、編集、または削除することができます。
パスワードについて
構成ファイルでパスワードを指定した場合、Viedocデータインポートアプリケーションはアプリケーションの初回実行時に、このパスワードを暗号化されたパスワードに置き換えます。暗号化されたパスワードは構成ファイルに保存されます。
構成ファイルでパスワードを指定していない場合、アプリケーションの起動時にパスワードが要求されます。
パスワードを入力するには、Y（Yes）を押し、パスワードを入力してからEnterキーを押します。もう一度パスワードを入力して、Enterキーを押します。パスワードが暗号化されたパスワードとして構成ファイルに保存されます。
N (No)を押すか、15秒間何も押さない状態が続く、または間違ったパスワードが入力されると、アプリケーションにログインできず、データのインポートも行われません。アプリケーション上にError logging in: Invalid userName or password.と表示されます。
Viedocのパスワードを変更した場合は、構成ファイル内の古いパスワードを新しいパスワードに置き換え、構成ファイルを保存します。次回のViedocデータインポートアプリケーションの実行時、ログインとデータのインポートには新しいパスワードが使用されます。
タスクスケジューラを使用したインポートの自動化
タスクスケジューラを使用してインポートを自動化する方法については、こちらのリンクを参照ください。