管理 CDB 部署

临床程序员在试验的整个生命周期内不断更新供数据管理员使用的列表、检查和视图。借助 CDB 的部署功能，组织可以通过审查、批准和部署来跟踪这些更改。

可以将已批准的自定义列表、检查和视图从其 TST 环境部署到其生产环境。在 TST 环境中，可以审查每个对象并将其标记为已批准（Approved），以确认其可供部署。对于每个对象，都有一个可供下载的批准日志，跟踪该对象在批准工作流中的进度。获批后，可以通过将其添加到部署包中，从 TST 部署到生产环境。

先决条件

功能启用

对于在 21R3 版本发布（2021 年 12 月）之前创建的研究，此功能必须在 CDB Workbench 的 TST 环境中启用。请参见下面的详细信息。

对于在 21R3 版本发布后创建的研究中，此功能自动启用。

可以从 TST 环境中研究列表的启用部署列确定研究是否启用了此功能。如果 Workbench 显示启用（Enabled）图标（rocket_launch），则该功能已启用。

所需权限

默认情况下，具有标准 CDMS 超级用户（CDMS Super User）研究角色的用户可以执行下述操作。具有标准 CDMS 首席数据管理员（CDMS Lead Data Manager）和 CDMS 数据管理员（CDMS Data Manager）研究角色的用户可以执行下述批准工作流功能。如果贵组织使用自定义研究角色，则你的角色必须授予以下权限：

类型 权限标签 控制
“标准”选项卡 工作台选项卡

能够通过工作台（Workbench）选项卡访问和使用 Data Workbench 应用程序
功能权限 管理部署

能够创建和管理研究环境 并从 EDC 工具（EDC Tools）部署研究，从工具（Tools）> 系统工具（System Tools）管理和部署 Vault 级配置，以及在 CDB 中管理和部署列表、检查与视图
功能权限

启用部署（21R3 和更早版本）&

如果研究是在 21R3 版本发布（2021 年 12 月）之前创建的，则必须为研究启用部署功能。如果研究是在 21R3 版本发布之后创建的，此功能会自动为研究启用。

Workbench 在研究列表中包括启用部署列。如果在此列中显示部署（Deployment）图标（rocket_launch），则表示该功能在研究中已启用。请注意，Workbench 仅在 TST 环境中显示此列。

可以从包含研究 TST 环境的 Workbench 实例中启用此功能。

  1. 登录到包含研究 TST 环境的 Vault。
  2. 单击工作台（Workbench）选项卡打开 CDB 应用程序。
  3. 在研究（Studies）页面，在列表中找到研究。
  4. 将鼠标悬停在研究（Study）上以显示研究菜单（）。
  5. 从研究菜单中，选择部署（Deployment）。这将打开启用部署（Enable Deployment）页面。
  6. 单击继续。
  7. 选择要用作列表和视图主集的研究实例（环境）。Workbench 将在研究的所有 TST 环境中创建这些列表和视图，删除所选主集中不存在的任何列表或视图。
  8. 单击启用（Enable）。

访问部署

可以在选择研究（Study）后从导航抽屉（Navigation Drawer）（），或从研究页面上的研究菜单（）导航到部署区域。

部署选项卡有三个子选项卡：

  • 已批准列表：此子选项卡列出了所有处于已批准（Approved）状态的列表和检查。
  • 分层已批准视图：此子选项卡列出了所有处于已批准状态的视图。
  • watch_later 数据包：此子选项卡列出了已部署的数据包。

批准状态

只能部署处于已批准状态的列表和视图。有三种批准状态：

状态 描述 徽章
草稿 列表、检查或视图尚未获得批准。这是所有新列表或视图的起始状态。
可供批准 此列表、检查或视图已经过审查，可供批准。
已批准 此列表、检查或视图已经过批准，可供部署。

返回到草稿状态：如果用户保存对列表、检查或视图的更改，Workbench 会将其返回到草稿状态。如果列表、检查或视图已部署，则将其返回到草稿状态的唯一方法是保存更改。

批准工作流

要部署，该对象必须处于已批准状态。对象初始为草稿状态，用户可以从状态（Status）菜单中将其移动到可供批准（Ready for Approval）和已批准（Approved）状态。可以将对象从任何状态移动到任何其他状态。当前版本中没有强制的状态顺序。建议的工作流是在部署完成后将对象从草稿（Draft）移动到可供批准（Ready for Approval），然后在审查完成并可供部署时将其从可供批准（Ready for Approval）移动到已批准（Approved）。

要将对象从草稿移动到可供批准，请执行以下操作：

  1. 导航到要移动到可供批准状态的列表、检查或视图。
  2. 从状态（Status）菜单中，选择可供批准（Ready for Approval）。
  3. 可选：输入原因（Reason）。
  4. 点击保存。

要将对象从可供批准移动到已批准，请执行以下操作：

  1. 导航到要移动到已批准状态的列表、检查或视图。
  2. 从状态（Status）菜单中，选择已批准（Approved）。
  3. 可选：输入原因（Reason）。
  4. 点击保存。

要将对象从已批准移动到草稿，请执行以下操作：

  1. 导航到要返回到草稿状态的列表、检查或视图。
  2. 从状态菜单中，选择草稿。
  3. 可选：输入原因（Reason）。
  4. 点击保存。

批准日志

Workbench 会记录列表或视图批准状态的更改日志。可以从列表、检查或视图中以 CSV 格式下载此日志。CSV 文件名为“批准日志<研究><列表/检查/视图标题><生成的日期时间>.csv”。

要下载批准日志，请执行以下操作：

  1. 导航到要下载批准日志的列表、检查或视图。
  2. 从列表、检查或视图菜单（）中，选择批准日志（Approval Logs）。
  3. Workbench 会生成 CSV 文件。下载并在所选的 CSV 查看器中查看。

批准日志包含每个状态更改的以下信息：

列 描述
Vault ID 包含列表或视图的 Vault 的 Vault ID。
研究名称 研究的名称。
对象 ID 列表或视图的唯一对象 ID。
类型 对象的类型：
  • 列表
  • 检查
  • 视图
源 与对象关联的源。
对象名称 对象的标题属性值。
对象短名称 对象的简短标题属性值。
类别 对象的类别属性值。
描述 对象的描述属性值。
目标 对象的目标属性值。
CQL 语法 对象的 CQL 语句。
创建者 创建该对象的用户的名称。
创建日期 最初创建该对象的日期和时间。
上次修改者 上次修改该对象的用户的名称。
上次修改日期 上次修改该对象的日期和时间。
上次修改月份 上次修改该对象的研究实例（环境）的名称。
当前状态 对象在此更改中移动到的状态：
  • 草稿
  • 可供批准
  • 已批准
过渡者 更改状态的用户的名称。
过渡时间 状态更改发生的日期和时间。
过渡备注 状态更改的原因。

查看批准日志：批准日志包含 CQL 语法列，其中包含列表、检查或视图的 CQL 语句。Microsoft Excel™ 对列字符的限制为 32,767 个。如果 CQL 语句的长度超过 32,767 个字符，Excel™ 会截断该值。Veeva 建议在没有此字符限制的查看器中查看批准日志 CSV。

如何部署

可以在单独的数据包中部署列表/检查和视图。至少有一个列表/检查或视图处于已批准状态后，就可以创建列表/检查或视图的部署包，将其部署到生产环境。

部署失败：如果部署失败，请联系 Veeva Services 寻求帮助解决问题。

列表和检查&

要部署列表和检查，请执行以下操作：

  1. 导航到研究的部署选项卡。
  2. 在已批准列表子选项卡中，选择要部署的列表和检查。
  3. 可选：选中全选（Select All）复选框以选择当前页面上的所有列表和检查（最多 25 个）。
  4. 单击部署图标 rocket_launch。
  5. 可选：输入原因（Reason）。
  6. 在确认对话框中，单击部署。
  7. Workbench 开始部署作业。可以从 Deployment > watch_later 数据包中查看进度。

更改名称、类别和源：CDB 使用&名称、类别和源来标识唯一列表。如果列表的名称、类别或源发生更改，CDB 在部署时会将其视为新列表，因此需要在生产中删除旧版本。

视图

要部署视图，请执行以下操作：

  1. 导航到研究的部署选项卡。
  2. 在分层已批准视图子选项卡中，选择要部署的视图。
  3. 可选：选中全选（Select All）复选框以选择当前页面上的所有视图（最多 25 个）。
  4. 单击部署图标 rocket_launch。
  5. 可选：输入原因（Reason）。
  6. 在确认对话框中，单击部署。
  7. Workbench 开始部署作业。可以从 Deployment > watch_later 数据包中查看进度。

部署包和日志&

可以从部署包 > watch_later 数据包查看所有部署包及其相关的部署日志。

对于每个部署包，Workbench 会显示以下信息：

列 描述
名称 部署包的名称（在当前版本中，始终为“Deploy”）以及部署发生的日期和时间。
发起人 发起部署的用户的名称以及他们执行此操作的日期和时间。可以将鼠标悬停在此值上，显示部署的原因（如果提供）。
当前状态 部署作业的状态以及此部署包中包含的列表或视图的数量。

部署状态

部署作业将经历以下状态：

状态 描述 显示
排队 部署当前位于作业队列中。当其他作业完成时，Workbench 将开始此部署。
进行中 部署当前正在进行中。
已部署 部署成功。
错误 部署作业失败。请联系 Veeva Services 代表寻求帮助。

下载部署包

要下载部署包，请执行以下操作：

  1. 导航到研究的部署> watch_later数据包。
  2. 在列表中找到要下载的部署包。
  3. 从数据包的数据包菜单中，选择下载数据包。
  4. Workbench 会生成数据包的压缩文件。完成后，Workbench 会在屏幕底部显示弹出通知。单击下载。

部署的最佳实践

部署的最佳实践包括：

  • 在启用研究部署之前，请下载每个 TST 实例的对象摘要日志。这样可以确保拥有这些对象的记录，以防不小心选择了错误的 TST 实例作为主实例。
  • 在部署之前，下载生产环境中的对象摘要日志。
  • 对审查列表 CQL 的更改将清除所有审查进度。因此，在部署审查列表的更改时，请在生产环境中下载列表的 CSV。