Vault 加载程序命令行工具允许您从终端执行所有批量创建、导出、更新和删除操作。您还可以查看并管理 Vault 文件暂存服务器上的文件和文件夹。

该过程包含三个基本步骤:

  1. 打开命令行控制台。
  2. 使用命令行工具对您的 Vault 进行身份验证。
  3. 使用命令行工具通过输入文件加载数据或从 Vault 导出数据。

加载基础知识

将内容和数据加载到 Vault 中时:

  • 您必须指定 CSV 格式的输入文件。文件扩展名可以是 CSV 或 TXT。
  • 输入文件必须包含所有必填字段,并且可以包含您希望更新的任何其他可编辑字段。
  • 可选:将任何文档源文件和格式副本上传到文件暂存服务器。如果您不添加源文件,创建的文档将作为占位符。
  • 可选:您可以使用映射文件将现有数据文件中的字段与输入文件匹配。

在映射文件中使用关键字段

当使用映射文件更新、插入删除对象记录时,您可以在 CSV 中使用 KeyField 列名。指定后,Vault 使用此字段作为 idParam 进行查找。如果您指定了 IdParamKeyfield,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 加载程序相关文件创建本地目录。这样有助您跟踪各种文件:

  • 命令行工具 (VaultDataLoader.jar)
  • Vault DNS 和身份验证信息 (vl-config.xml)
  • CSV 输入文件
  • CSV 成功和失败日志
  • CSV 或 TXT 导出文件

命令行引数

命令行引数是指传递给 Vault 加载程序的参数。使用 Vault 加载程序时,引数包括用于定义要执行操作的命令,例如 -createdocuments,以及该操作的修饰符,例如 -all 用于指定删除操作将影响所有对象记录,或者 -csv filename.csv 用于指示 Vault 加载程序应根据指定的 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

首次运行此命令时,命令行工具会创建 vl-config.xml 文件,它会保存您的 DNS 和用户名以供将来的命令使用。如果您使用多个 Vault 或多个用户帐户,则在每次切换 Vault 或切换用户时必须删除此文件并重新运行身份验证命令。