Vault 加载程序命令行工具引用

使用此引用中的命令行引数和参数，批量地将数据加载到您的 Vault 中或从您的 Vault 中提取数据。本文列出了 Vault 加载程序命令行工具中可用的操作和参数。如需了解如何开始使用 Vault 加载程序命令行工具，包括安装和身份验证，请参阅使用 Vault 加载程序命令行工具。如需了解如何使用 Vault 加载程序命令行工具管理 Vault 文件暂存服务器，请参阅 Vault 加载程序文件暂存命令行工具引用。

创建文档

在开始之前，请将文档源文件或格式副本上传到暂存服务器。如果您不提供源文件，文档将被作为占位符创建。准备 CSV 输入文件。

操作	参数	示例
-createdocument	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createdocument -csv docs_for_upload.csv -m vault_vph_fields.csv`

更新文档

此操作将使用您在 CSV 中提供的值，更新现有文档上的文档字段。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-updatedocuments	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updatedocuments -csv docs_for_upload.csv -m vault_vph_fields.csv`

添加文档版本

此操作将为现有的文档创建新的版本。在开始之前，请将所有源文件上传到暂存服务器，并准备 CSV 输入文件。

操作	参数	示例
-createversions	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createversions -csv docs_for_upload.csv -m vault_vph_fields.csv`

添加文档格式副本

此操作将为现有的文档添加新的格式副本。在开始之前，请将所有文件上传到暂存服务器，并准备 CSV 输入文件。

操作参数示例

-createrenditions

-csv [CSV]

-m [MAPPING]

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

创建文档附件

此操作将为现有的文档添加新的附件。如果附件已经存在，Vault 会将附件作为现有附件的一个新版本上传。在开始之前，请将所有文件上传到暂存服务器，并准备 CSV 输入文件。

操作参数示例

-createdocumentattachments

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -createdocumentattachments

-csv new_attachments.csv

-m vault_vph_fields.csv

删除文档附件

此操作将从现有的文档中移除附件。在开始之前，请准备 CSV 输入文件。

操作

参数

示例

-deletedocumentattachments

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -deletedocumentattachments

-csv attachments_to_delete.csv

-m vault_vph_fields.csvs

创建文档关系

此操作将使用来自您提供的 CSV 文件的详细信息创建新的文档关系。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-createrelationships	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createrelationships -csv supporting_docs_2017.csv`

导出文档关系

此操作将导出文档关系元数据。

操作参数示例

-exportrelationships

-csv [CSV]

-type [TYPE]

-subtype [SUBTYPE]

-classification [CLASSIFICATION]

-noneditable

-headers

-where [WHERE]

-columns [COLUMNS]

java -jar VaultDataLoader.jar createrleationships -exportrelationships -csv supporting_doc_relationships.csv -type References -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 [MAPPING]	`java -jar VaultDataLoader.jar -updateroles -csv new_doc_roles.csv -m vault_vph_fields.csv`

从文档角色中移除用户

此操作将从特定文档上的角色中移除用户。在开始之前，请准备 CSV 输入文件。

操作参数示例

-deleteroles

-csv [CSV]

-m [MAPPING]

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

导出文档

此操作将为所有文档或符合您条件的文档导出文档字段值、格式副本和/或源文件。提取的元数据使用指定的 CSV 文件。导出的文件将转移到您的文件暂存服务器。您还可以使用此操作，将文档字段名称导出为不含数据的列标题。

操作参数示例

-exportdocuments

-csv [CSV]

-type [TYPE]

-subtype [SUBTYPE]

-classification [CLASSIFICATION]

-headers

-columns [COLUMNS]

-source

-renditions

-allversions

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

导出源文件和格式副本

当使用 -renditions 和/或 -source 来导出文件时，Vault 加载程序单次操作只能导出 2,000 个文件。您可以按文档类型或使用 WHERE 子句来细化您的导出内容。当导出内容中包含具有多种格式副本类型的文档，而且您包含了 -renditions 时，CSV 输出中将为每种格式副本类型包含一个单独的行。

创建用户

此操作将使用来自您提供的 CSV 文件的详细信息创建新的用户。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-createusers	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -createusers -csv user_onboarding.csv -m vault_vph_fields.csv`

更新用户

此操作将使用您提供的 CSV 文件更新现有用户的详细信息。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-updateusers	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updateusers -csv user_update.csv -m vault_vph_fields.csv`

更新和插入用户

此操作将使用您提供的 CSV 文件创建新的用户，并更新现有用户的详细信息。在开始之前，请准备 CSV 输入文件。

操作参数示例

-upsertusers

-csv [CSV]

-m [MAPPING]

-idParam [FIELD]

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

导出用户

此操作将导出用户元数据。

操作参数示例

-exportusers

-csv [CSV]

-columns [FIELD]

-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 [MAPPING]	`java -jar VaultDataLoader.jar -creategroups -csv group_import.csv -m vault_vph_fields.csv`

更新组

此操作将使用来自您提供的 CSV 文件的详细信息更新现有的组。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-updategroups	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -updategroups -csv group_update.csv -m vault_vph_fields.csv`

更新和插入组

此操作将使用来自您提供的 CSV 文件的详细信息更新现有的组。在开始之前，请准备 CSV 输入文件。

操作参数示例

-upsertgroups

-csv [CSV]

-m [MAPPING]

idParam [FIELD]

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

导出组

此操作将导出组元数据。

操作参数示例

-exportgroups

-csv [CSV]

-columns [FIELD]

-headers

-noneditable

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

导出对象记录

此操作将为特定的对象导出记录元数据。

操作参数示例

-export [OBJECT NAME]

-csv [CSV]

-where [WHERE]

-columns [FIELD]

-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 [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

-recordmigrationmode

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

更新对象记录

此操作将使用来自所提供的文件的数据更新现有的对象记录。在开始之前，请准备 CSV 输入文件。

操作	参数	示例
-update [OBJECT NAME]	-csv [CSV] -m [MAPPING]	`java -jar VaultDataLoader.jar -update product__v -csv update_prods.csv -m vault_vph_fields.csv`

更新和插入对象记录

此操作将更新现有的对象记录或从所提供的文件创建新的记录。在开始之前，请准备 CSV 输入文件。

操作参数示例

-upsert [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

-idParam

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

删除对象记录

此操作将删除 CSV 文件中确定的现有对象记录。要删除特定的记录，请准备 CSV 输入文件。要删除所有记录，您无需提供输入文件。

操作	参数	示例
-delete [OBJECT NAME]	-csv [CSV] -all	`java -jar VaultDataLoader.jar -delete product__v -csv prods_to_delete.csv`
		`java -jar VaultDataLoader.jar -delete product__v -all`

注意：当删除所有对象记录时，所生成的成功文件中的行 ID 会在已删除的每个对象记录旁边显示 -1。这是一个预期行为。

创建对象记录附件

此操作将为现有的对象记录添加新的附件。如果附件已经存在，Vault 会将附件作为现有附件的一个新版本上传。在开始之前，请将所有文件上传到暂存服务器，并准备 CSV 输入文件。

操作参数示例

-createattachments [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -createattachments product__v

-csv new_attachments.csv

-m vault_vph_fields.csv

删除对象记录附件

此操作将从对象记录中删除现有的附件。在开始之前，请准备 CSV 输入文件。

操作参数示例

-deleteattachments [OBJECT NAME]

-csv [CSV]

-m [MAPPING]

java -jar VaultDataLoader.jar -deleteattachments product__v

-csv attachments_to_delete.csv

-m vault_vph_fields.csv

向对象记录角色分配用户和组

此操作将使用自定义或匹配的共享规则，向对象记录角色分配用户和组。在开始之前，请准备 CSV 输入文件。

操作参数示例

-assignobjectroles [OBJECT NAME]

-csv [CSV]

java -jar VaultDataLoader.jar -assignobjectroles object_name__c

-csv assign_object_roles.csv

从对象记录角色中移除用户和组

此操作将使用自定义或匹配的共享规则，从对象记录上的角色中移除用户和组。在开始之前，请准备 CSV 输入文件。

操作参数示例

-removeobjectroles [OBJECT NAME]

-csv [CSV]

java -jar VaultDataLoader.jar -removeobjectroles object_name__c

-csv remove_object_roles.csv

参数

必须将以下参数与其他引数结合使用，以修改 Vault 处理命令的方式：

参数	描述
-all	将此标记与一个删除操作结合使用，以表明此操作将会影响所指定对象的全部记录。
-async	将此标记与任何操作结合使用，以异步完成此操作。使用此标记，您将能够立即启动一个新操作。此命令行工具将不会在异步操作上显示状态消息，但会立即返回一个作业 ID，以使您稍后能够检查状态。
-type [TYPE] -subtype [SUBTYPE] -classification [CLASSIFICATION]	使用这些标记，按文档类型、子类型和/或类别筛选导出操作的结果。
-where [WHERE]	将此标记与一个导出操作结合使用，以基于一个 VQL 查询来限制导出，例如“product__v='wonderDrug'”。
-headers	将此标记与一个导出操作结合使用，以便只将字段名称作为列标题导出。这样可以帮助您为 CSV 输入文件创建一个模板。
-columns [COLUMNS]	在一个导出操作上使用此标记，指定一些字段名称以便只导出这些字段。请注意，当使用“-columns”标记来指定列时，列名之间不能存在空格。
-noneditable	在一个导出操作上使用此标记，以同时提取可编辑的字段和只读字段。请注意，包含不可编辑的字段意味着，您无法将导出内容用作 CSV 输入文件的模板。
-idParam [FIELD]	在更新、更新和插入或删除操作上使用此标记，以指明在 CSV 输入文件中通过外部 ID 而非 ID 字段确定了项。
-allversions	在一个导出文档操作上使用此标记，以便在您的导出中包含所有文档版本。
-includefields	将此标记与一个加载操作结合使用，以指明 Vault 应当在输出成功日志中包含输入字段。
-recordmigrationmode	使用此标记，创建一个处于特定生命周期状态的记录。当设置此标志时，Vault 会在分配、重新分配或完成批次中的用户任务时跳过发送电子邮件通知这一操作。
-documentmigrationmode	将此标记与以下操作和对象类型结合使用，以创建处于特定状态或状态类型的记录。还使您能够设置名称、文档编号和版本号：创建文档更新文档创建文档格式副本创建文档版本创建文档、版本、角色