Vault ローダのコマンドラインツール参照

Vault にデータを読み込んだり、Vault からデータを一括抽出したりするには、この参照のコマンドライン引数とパラメータを使用します。この記事では、Vault ローダコマンドラインツールで使用できるアクションとパラメータを一覧表示します。Vault Loader コマンドラインツールに関する詳細については、Vault ローダコマンドラインツールを使用するをご覧ください。Vault ローダコマンドラインツールを使用して Vault のファイルステージングサーバを管理する詳細については、Vault ローダのファイルステージングコマンドラインツール参照をご覧ください。

ドキュメントの作成

始める前に、ドキュメントソースファイルまたはレンディションをステージングサーバにアップロードします。ソースファイルを提供しない場合、ドキュメントはプレースホルダーとして作成されます。CSV 入力ファイルを準備します。

アクション	パラメータ	例
-createdocument	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -createdocument -csv docs_for_upload.csv -m vault_vph_fields.csv`

ドキュメントの更新

このアクションは、CSV に提供する値を使用して既存のドキュメントのドキュメントフィールドを更新します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-updatedocuments	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -updatedocuments -csv docs_for_upload.csv -m vault_vph_fields.csv`

ドキュメントバージョンの追加

このアクションは、既存のドキュメントに新規バージョンを作成します。始める前に、ソースファイルをステージングサーバにアップロードして、CSV 入力ファイルを準備します。

アクション	パラメータ	例
-createversions	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -createversions -csv docs_for_upload.csv -m vault_vph_fields.csv`

ドキュメントレンディションの追加

このアクションは既存のドキュメントに新規レンディションを追加します。始める前に、すべてのファイルをステージングサーバにアップロードして、CSV 入力ファイルを準備します。

アクション パラメータ 例

-createrenditions

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -createrenditions
-csv new_renditions.csv
-m vault_vph_fields.csv

ドキュメント添付ファイルの作成

このアクションは既存のドキュメントに新規添付ファイルを追加します。添付ファイルが既にある場合、Vault は既存の添付ファイルの新規バージョンとして添付ファイルをアップロードします。始める前に、すべてのファイルをステージングサーバにアップロードして、CSV 入力ファイルを準備します。

アクション パラメータ 例

-createdocumentattachments

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -createdocumentattachments

-csv new_attachments.csv

-m vault_vph_fields.csv

ドキュメント添付ファイルの削除

このアクションは既存のドキュメントから添付ファイルを削除します。始める前に CSV 入力ファイルを準備します。

アクション

パラメータ

例

-deletedocumentattachments

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -deletedocumentattachments

-csv attachments_to_delete.csv

-m vault_vph_fields.csvs

ドキュメント関係の作成

このアクションは、ユーザが提供する CSV ファイルの詳細を使用して新規ドキュメント関係を作成します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-createrelationships	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -createrelationships -csv supporting_docs_2017.csv`

ドキュメント関係のエクスポート

このアクションは、ドキュメント関係メタデータをエクスポートします。

アクション パラメータ 例

-exportrelationships

-csv [CSV]

-type [タイプ]

-subtype [サブタイプ]

-classification [分類]

-noneditable

-headers

-where [WHERE]

-columns [列]

java -jar VaultDataLoader.jar createrleationships -exportrelationships -csv supporting_doc_relationships.csv -type 参照 -where "product__v='wonderDrug"-columns created_by__v

ドキュメント関係の削除

このアクションは、CSV ファイルで特定された既存のドキュメント関係を削除します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-deleterelationships	-csv [CSV] -includefields	`java -jar VaultDataLoader.jar -deleterelationships -csv delete_supporting_doc_relationships.csv`

ドキュメントロールの更新

このアクションは、特定のドキュメントのロールに割り当てられたユーザを更新します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-updateroles	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -updateroles -csv new_doc_roles.csv -m vault_vph_fields.csv`

ドキュメントロールからユーザを削除

このアクションは特定のドキュメントのロールからユーザを削除します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-deleteroles

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -deleteroles
-csv remove_from_doc_roles.csv
-m vault_vph_fields.csv

ドキュメントのエクスポート

このアクションは、すべてのドキュメントまたはユーザの条件を満たすドキュメントのドキュメントフィールド値、レンディションおよび/またはソースファイルをエクスポートします。抽出されたメタデータは指定された CSV ファイルを使用します。エクスポートされたファイルはファイルステージングサーバに置かれます。このアクションを使用して、データを含めずドキュメントフィールド名を列の見出しとしてエクスポートすることもできます。

アクション パラメータ 例

-exportdocuments

-csv [CSV]

-type [タイプ]

-subtype [サブタイプ]

-classification [分類]

-headers

-columns [列]

-source

-renditions

-allversions

java -jar VaultDataLoader.jar -exportdocuments -csv doc_extract.csv-source -type リソース -where "product__v='wonderDrug'" -columns created_by__v,title__v

ソースファイルとレンディションのエクスポート

-renditions および/または -source を使用してファイルをエクスポートする際に、Vault Loader は一回のアクションで 2,000 ファイルしかエクスポートできません。ドキュメントタイプごとにエクスポートを絞り込むか、WHERE 句を使用してエクスポートを絞り込むことができます。エクスポートに複数のレンディションタイプがあるドキュメントが含まれており、ユーザに -renditions が含まれる場合、CSV 出力にはレンディションタイプごとに個別の行が含まれます。

ユーザの作成

このアクションは、ユーザが提供する CSV ファイルの詳細を使用して新規ユーザを作成します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-createusers	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -createusers -csv user_onboarding.csv -m vault_vph_fields.csv`

ユーザの更新

このアクションは、ユーザが提供する CSV ファイルを使用して既存のユーザの詳細を更新します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-updateusers	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -updateusers -csv user_update.csv -m vault_vph_fields.csv`

ユーザの挿入/更新

このアクションは、ユーザが提供する CSV ファイルを使用して、新規ユーザを作成し、既存のユーザの詳細を更新します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-upsertusers

-csv [CSV]

-m [マッピング]

-idParam [フィールド]

java -jar VaultDataLoader.jar -upsertusers
-csv user_update.csv
-m vault_vph_fields.csv

ユーザのエクスポート

このアクションはユーザのメタデータをエクスポートします。

アクション パラメータ 例

-exportusers

-csv [CSV]

-columns [フィールド]

-where [WHERE]

-headers

-noneditable

java -jar VaultDataLoader.jar -exportusers
-csv users_12-15-15.csv
-noneditable
-where "active__v='false'"

java -jar VaultDataLoader.jar -exportusers -csv users_names.csv -columns first_name__v,last_name__v

グループの作成

このアクションは、ユーザが提供する CSV ファイルの詳細を使用して新規グループを作成します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-creategroups	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -creategroups -csv group_import.csv -m vault_vph_fields.csv`

グループの更新

このアクションは、ユーザが提供する CSV ファイルの詳細を使用して既存のグループを更新します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-updategroups	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -updategroups -csv group_update.csv -m vault_vph_fields.csv`

グループの挿入/更新

このアクションは、ユーザが提供する CSV ファイルの詳細を使用して既存のグループを更新します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-upsertgroups

-csv [CSV]

-m [マッピング]

idParam [フィールド]

java -jar VaultDataLoader.jar -upsertgroups
-csv group_import.csv
-m vault_vph_fields.csv

エクスポートグループ

このアクションはグループのメタデータをエクスポートします。

アクション パラメータ 例

-exportgroups

-csv [CSV]

-columns [フィールド]

-headers

-noneditable

java -jar VaultDataLoader.jar -exportgroups
-csv groups_2015.csv
-noneditable

オブジェクトレコードのエクスポート

このアクションは特定のオブジェクトのレコードメタデータをエクスポートします。

アクション パラメータ 例

-export [オブジェクト名]

-csv [CSV]

-where [WHERE]

-columns [フィールド]

-headers

-noneditable

java -jar VaultDataLoader.jar
-export product__v
-csv prod_exp.csv
-where "name__v like 'Ad%'"
-columns name__v

java -jar VaultDataLoader.jar -export product__v -headers

オブジェクトレコードの作成

このアクションは特定のオブジェクトの新規オブジェクトレコードを作成します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-create [オブジェクト名]

-csv [CSV]

-m [マッピング]

-recordmigrationmode

java -jar VaultDataLoader.jar
-create product__v
-csv new_prods.csv
-m vault_vph_fields.csv

オブジェクトレコードの更新

このアクションは、提供されたファイルのデータを使用して既存のオブジェクトレコードを更新します。始める前に CSV 入力ファイルを準備します。

アクション	パラメータ	例
-update [オブジェクト名]	-csv [CSV] -m [マッピング]	`java -jar VaultDataLoader.jar -update product__v -csv update_prods.csv -m vault_vph_fields.csv`

オブジェクトレコードの挿入/更新

このアクションは、提供されたファイルから、既存のオブジェクトレコードを更新するか、あるいは新規レコードを作成します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-upsert [オブジェクト名]

-csv [CSV]

-m [マッピング]

-idParam

java -jar VaultDataLoader.jar
-upsert product__v
-csv update_prods.csv
-m vault_vph_fields.csv
-idParam external_id__v

オブジェクトレコードの削除

このアクションは、CSV ファイルで特定された既存のオブジェクトレコードを削除します。特定のレコードを削除する場合は、CSV 入力ファイルを準備します。すべてのレコードを削除する場合は、入力ファイルを提供する必要はありません。

アクション	パラメータ	例
-delete [オブジェクト名]	-csv [CSV] -all	`java -jar VaultDataLoader.jar -delete product__v -csv prods_to_delete.csv`
		`java -jar VaultDataLoader.jar -delete product__v -すべて`

注: すべてのオブジェクトレコードを削除すると、生成された成功ファイルの rowID で削除された各オブジェクトレコードの横に -1 が表示されます。これは予想通りの動作です。

オブジェクトレコード添付ファイルの作成

アクション パラメータ 例

-createattachments [オブジェクト名]

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -createattachments product__v

-csv new_attachments.csv

-m vault_vph_fields.csv

オブジェクトレコード添付ファイルの削除

このアクションは、オブジェクトレコードから既存の添付ファイルを削除します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-deleteattachments [オブジェクト名]

-csv [CSV]

-m [マッピング]

java -jar VaultDataLoader.jar -deleteattachments product__v

-csv attachments_to_delete.csv

-m vault_vph_fields.csv

ユーザおよびグループをオブジェクトレコードロールに割り当てる

このアクションは、カスタムルールまたは一致共有ルールを使用して、ユーザおよびグループをオブジェクトレコードに割り当てます。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-assignobjectroles [オブジェクト名]

-csv [CSV]

java -jar VaultDataLoader.jar -assignobjectroles object_name__c

-csv assign_object_roles.csv

ユーザおよびグループをオブジェクトレコードロールから削除する

このアクションは、カスタムルールまたは一致共有ルールを使用して、ユーザおよびグループをオブジェクトレコードから削除します。始める前に CSV 入力ファイルを準備します。

アクション パラメータ 例

-removeobjectroles [オブジェクト名]

-csv [CSV]

java -jar VaultDataLoader.jar -removeobjectroles object_name__c

-csv remove_object_roles.csv

パラメータ

以下のパラメータは、Vault がコマンドをどのように処理するかを修正するために、他の引数と使用される必要があります:

パラメータ	説明
-all	このフラグを削除アクションと使用して、アクションが指定されたオブジェクトのすべてのレコードに影響を及ぼすことを示します。
-async	このフラグをアクションに使用して、操作を非同期的に完了させます。このフラグを使うと、新しい操作を直ちに開始することができます。コマンドラインツールは、非同期的操作のステータスメッセージを表示しませんが、後でステータスを確認できるジョブ ID を直ちに返します。
-type [タイプ] -subtype [サブタイプ] -classification [分類]	これらのフラグを使用して、ドキュメントタイプ、サブタイプ、および/または分類ごとにエクスポート操作の結果をフィルタリングします。
-where [WHERE]	このフラグをエクスポートアクションと使用して、VQL クエリ (例: "product__v='wonderDrug'") に基づいてエクスポートを制限します。
-headers	このフラグをエクスポートアクションと使用して、列の見出しとしてフィールド名のみをエクスポートします。これは、CSV 入力ファイルのテンプレート作成に役立ちます。
-columns [列]	フィールド名を指定することでこのフラグをエクスポートアクションに使用して、それらのフィールドにのみエクスポートするように制限します。'-columns' フラグで列を指定する際には、列名の間にスペースを入れることはできません。
-noneditable	このフラグをエクスポートアクションに使用して、編集可能なフィールドと読取り専用フィールドの両方を抽出します。編集不可フィールドを含めると、CSV 入力フィールドのテンプレートとしてエクスポートを使用できなくなることにご注意ください。
-idParam [フィールド]	このフラグを更新、挿入/更新または削除アクションに使用して、ID フィールドではなく外部 ID でアイテムが CSV 入力ファイルに特定されることを指定します。
-allversions	ドキュメントのエクスポートアクションにこのフラグを使用して、エクスポートにすべてのドキュメントバージョンを含めます。
-includefields	読込みアクションにこのフラグを使用して、Vault が出力成功ログに入力フィールドを含める必要があることを指定します。
-recordmigrationmode	このフラグを使用して特定のライフサイクル状態にレコードを作成します。このフラグを設定すると、Vault は、バッチ内のユーザタスクの割り当て、再割り当て、完了時にメール通知を送信しません。
-documentmigrationmode	次のアクションとオブジェクトタイプにこのフラグを使用して、特定の状態または状態タイプのレコードを作成します。名前、ドキュメント番号、バージョン番号も設定できるようになります。ドキュメントの作成ドキュメントの更新ドキュメントレンディションの作成ドキュメントバージョンの作成ドキュメント、バージョン、ロールの作成