Vault ローダコマンドラインツールを使用すると、ターミナルからアクションの作成、エクスポート、更新、削除が一括して行えます。Vault のファイルステージングサーバ上のファイルとフォルダを表示および管理することもできます。
プロセスには次の 3 つの基本的な手順があります:
- コマンドラインコンソールを開きます。
- コマンドラインツールを使用して Vault で認証します。
- コマンドラインツールを使用して、入力ファイル経由でデータを読み込むか、Vault からデータをエクスポートします。
読み込みの基礎
Vault にコンテンツとデータを読み込む場合:
- CSV 形式で入力ファイルを指定する必要があります。ファイル拡張子は CSV または TXT です。
- 入力ファイルには、すべての必須フィールドを含める必要があり、更新したい編集可能なフィールドを追加することができます。
- 任意の作業: ドキュメントソースファイルおよびレンディションをファイルステージングサーバにアップロードします。ソースファイルを追加しない場合、プレースホルダーとしてドキュメントが作成されます。
- 任意の作業: マッピングファイルを使用して、既存のデータファイルのフィールドと入力ファイルを一致させることができます。
マッピングファイルでのキーフィールドの使用
マッピングファイルを使用してオブジェクトレコードの更新、挿入/更新、または削除する場合、CSV の KeyField列名を使用することができます。指定されている場合、Vault はこのフィールドをルックアップの idParam として使用します。idParam と Keyfield の両方を指定すると、Vault はルックアップに Keyfield を使用します。
抽出の基礎
Vault から情報を取得する場合:
-csvフラグを使用して出力ファイルにファイル名を指定する必要があります。すべての出力ファイルはプレーンテキストで CSV 形式です。- 任意の作業: 特定のフィールド値で
""コマンドを使用して、抽出データに含まれるアイテムをフィルタリングすることができます。 - 任意の作業: 出力ファイルの場所を指定することができます。指定しない場合、ファイルは現在のディレクトリに作成されます。
- 任意の作業: 列のレイアウトを指定することができます。指定しない場合、ファイルにはすべてのフィールドとその値が含まれます。
現在、コマンドラインツールは、オブジェクトレコード、ドキュメントメタデータ、ドキュメントタイプ、ユーザおよびグループをエクスポートすることができます。
回答
コマンドラインツールでコマンドを処理した後に、Vault はさまざまなレスポンスファイルを現在のディレクトリに作成します。
- 成功ログ: 読み込みが成功したレコードのフィールドおよび値を含む CSV ファイル。
- 失敗ログ: 読み込みに失敗した各レコードに関するエラーメッセージを含む CSV ファイル。
- 出力ファイル: エクスポートデータを含む CSV ファイル。
成功ファイル、失敗ファイルおよびエクスポートファイルを使用して、必要に応じてレコードを編集および再読み込みすることができます。
-async フラグを使用してアクションを実行している場合、以下のコマンドを使用してステータス情報を取得することができます:
| アクション | 説明 |
| -jobstatus | このアクションを使用して、VL-Config ファイルからコマンドラインツール経由で実行したすべての操作に関するステータス情報 (ジョブ ID、進捗状況、開始時間、終了時間など) を取得します。 |
| -jobstatus [JOB_ID] | このアクションを使用して、特定の操作に関するステータス情報 (進捗状況、開始時間、終了時間など) を取得します。 |
| -jobresults [JOB_ID] | このアクションを使用して、成功ログまたは失敗ログおよびジョブ詳細を含むテキストファイル (進捗状況、開始時間、終了時間を含む) を作成します。 |
はじめに
コマンドラインツールは、単一の JAR ファイル (VaultDataLoader.jar) として配布され、インストールは不要です。Zip ファイルをダウンロードして抽出し、コマンドラインコンソールから実行するだけです。これには Vault ローダ権限が必要です。
お使いの Vault のローダタブからコマンドラインツールをダウンロードします。Vault が新規バージョンをリリースしたら、最新のファイルをダウンロードする必要があります。ダウンロードしたファイルを抽出 (展開) します。
Java JDK V7 以降がインストールされていることを確認します。インストールされていない場合は、最新バージョンをダウンロードします。
推奨: Vault Loader 関連ファイル用にローカルディレクトリを作成します。これで、さまざまなファイルを追跡することができます:
- コマンドラインツール (VaultDataLoader.jar)
- Vault DNS および認証情報 (vl-config.xml)
- CSV 入力ファイル
- CSV 成功および失敗ログ
- CSV または TXT エクスポートファイル
Note: コマンドラインツールは、Vault ローダ v21.3 以降のバージョンを使用します。
- Vault バージョン 21R3.0 以前からダウンロードしたコマンドラインツールは、Vault ローダ v21.3 を使用していて、基盤となる API に v21.3 が渡します。例えば、21R2.0 コマンド ラインツールは、Vault ローダ v21.3 と v21.3 Vault オブジェクト、ドキュメント、および VQL API を使用します。
- Vault バージョン 22R1.0 以降からダウンロードしたコマンドラインツールは、Vault ローダの同等バージョンを使用し、基礎となる API に Vault のバージョンを渡します。例えば、22R2.0 コマンド ラインツールは、Vault ローダ v22.2 と v22.2 Vault オブジェクト、ドキュメント、および VQL API を指定どおりに使用します。
コマンドライン引数
コマンドライン引数は Vault Loader に渡される引数です。Vault ローダ の使用時、引数には、実行する操作を定義するコマンド (-createdocuments など) とその操作に対する修飾子の両方が含まれます。修飾子には、削除の操作がすべてのオブジェクトレコードに影響することを示す -all や、指定の CSV ファイル内の情報に基づいて Vault ローダでドキュメントを作成するよう指示するための -csv filename.csv などが含まれます。
引数の全リストは、-h または –help を使用してコマンドラインツール経由で取得できます。
Vault ローダコマンドラインツールリファレンスで、Vault ローダコマンドライン引数の詳細をご覧ください。
コマンドライン引数を使用して Vault のステージングサーバ上のファイルとフォルダを表示および管理するには、Vault ローダファイルステージングコマンドラインツールリファレンスをご覧ください。
認証および VL-Config ファイル
他のコマンドを実行する前に、Vault ユーザ名とパスワードを使用して Vault と認証します。
java -jar VaultDataLoader.jar -username steve@veepharm.com -password p@$$w0Rd -dns https://veepharm.veevavault.com
このコマンドを初めて実行する場合、コマンドラインツールは今後のコマンド用に DNS とユーザ名を保存するファイル vl-config.xml を作成します。複数の Vault または複数のユーザアカウントで作業する場合、このファイルを削除して、Vault またはユーザを切替えるたびに認証コマンドを再実行する必要があります。
注: 認証するには、以下の権限を付与するセキュリティプロファイルを有している必要があります:
- Vault 所有者アクション: Vault Loader
- API: すべての API