IMPORT GRCPROJECT 命令

通过导入一个 HighBond 项目应用程序表来创建 Analytics 表。

语法

IMPORT GRCPROJECT TO 表 导入文件名 PASSWORD 数字 FROM 组织 ID/类型 ID <FIELD 名称 AS 显示名称 <...n>>

参数

名称 描述
TO 表

数据要导入到的 Analytics 表的名称。

说明

表名称被限制为不超过 64 个字母数字字符。 该名称可以包括下划线字符 ( _ )，但不能包括其他特殊字符或任何空格。 该名称不能以数字开头。

导入文件名

要创建的 Analytics 数据文件的名称。

将导入文件名指定为具有 .FIL 文件扩展名的带引号的字符串。 例如，"发票.FIL"。

默认情况下，数据文件 (.fil) 被保存到包含 Analytics 项目的文件夹。

请使用绝对或相对文件路径将该数据文件保存到另外的现有文件夹：

  • "C:\data\Invoices.FIL"
  • "data\Invoices.FIL"
PASSWORD 数字

要使用的密码定义。

您不使用 PASSWORD 数字 提示用户提供或者指定实际密码。 密码定义是指先前使用 PASSWORD 命令、SET PASSWORD 命令或 PASSWORD 分析标记提供或设置的密码。

数字是密码定义的编号。 例如，如果先前已在脚本中或者在调度分析时提供或设置了两个密码，则 PASSWORD 2 指定使用密码 #2。

有关提供或设置密码的详细信息，请参见：

所需的密码值是 HighBond 访问令牌。 有关详细信息，请参见创建密码定义并指定密码值。

说明

PASSWORD 未必是必需的，具体取决于该脚本的运行环境：

Analytics

（在线激活）

PASSWORD 不是必需的。

当前用户的 HighBond 访问令牌被自动使用。

Analytics

（离线激活）

PASSWORD 是必需的。
机器人
Analytics Exchange
分析应用程序窗口

FROM 组织 ID/类型 ID

定义所导入的数据的信息的组织和类型：

  • 组织 ID 您要从中导入数据的项目应用程序组织
  • 类型 ID 您要导入的信息的类型

必须使用反斜杠来分隔组织 ID 值和类型 ID 值，并且两者之间不能有空格，例如：FROM "125@eu/audits"。

整个字符串必须用引号围起来。

组织 ID

组织 ID 必须包括组织 ID 号码，并且如果您要从北美以外的数据中心导入，则必须包括数据中心代码。 组织 ID 编号和数据中心代码必须使用 @ 符号加以分隔，例如：FROM "125@eu"。

数据中心代码指定您要从哪个地区的 HighBond 服务器导入数据：

  • ap – 亚太地区
  • au – 澳大利亚
  • ca – 加拿大
  • eu – 欧洲
  • us – 北美

您只能使用为您的组织的 HighBond 实例授权的数据中心代码。 北美数据中心是默认的，因此指定 "@us" 是可选操作。

如果您不知道组织 ID 号码，请使用 Analytics 用户界面从项目应用程序导入表。 组织 ID 编号包含在日志中的命令中。 有关详细信息，请参阅导入 HighBond 项目数据。

类型 ID

类型 ID 指定您要导入的信息的类型。 项目应用程序中的信息被包含在一系列相关表中。

对于类型 ID，请使用下列值之一。 请严格按照如下所示输入值，并且包括下划线（如果适用）：

  • audits - 项目
  • control_test_plans - 控制测试计划
  • control_tests - 控制测试
  • controls - 控制
  • finding_actions - 操作
  • findings - 问题
  • mitigations - 风险控制关联
  • narratives - 叙述
  • objectives- 对象
  • risks - 风险
  • walkthroughs - 排查

提示

有关如何关联项目应用程序中的表以及在将这些表导入 Analytics 后可使用哪些键域来联接这些表的信息，请参见导入 HighBond 项目数据。
FIELD 名称 AS 显示名称 <...n>

可选

源数据中要导入的单个域。 请指定名称。

如果您省略 FIELD，则会导入所有域。

  • 名称必须完全匹配项目应用程序表中的物理域名称，包括匹配大小写
  • 显示名称（备选列标题）是新 Analytics 表中的视图中的域的显示名称。 您必须为每个 FIELD 名称指定一个显示名称。 请将显示名称指定为带引号的字符串。

    如果您希望列标题包含换行符，请在单词之间使用分号 (;)。

    与 Analytics 中的某些其他 IMPORT 命令不同，您不能指定空白显示名称作为将 FIELD 名称用作显示名称的一种方式。

提示

要获取物理域名称，请使用 Analytics 用户界面从项目应用程序中导入适当的表。 物理域名称被包含在日志内的命令中。

后续导入可以被脚本化。

示例

从项目应用程序表导入所有域

您将属于组织 286 的所有活动项目的项目应用程序表中的所有域导入到一个名为 All_Projects 的 Analytics 表。 您包括一个编号的密码定义以对该连接进行认证：

IMPORT GRCPROJECT TO All_Projects "C:\HighBond Projects Data\All_Projects.fil" PASSWORD 1 FROM "286@us/audits"

从项目应用程序表导入指定的域

您将属于组织 286 的所有活动项目的项目应用程序表中的指定域导入到一个名为 All_Projects 的 Analytics 表：

IMPORT GRCPROJECT TO All_Projects "C:\HighBond Projects Data\All_Projects.fil" FROM "286@us/audits" FIELD "id" AS "Id" FIELD "description" AS "Description" FIELD "name" AS "Name" FIELD "start_date" AS "Start date" FIELD "status" AS "Status" FIELD "created_at" AS "Created at"

从 Issues 表导入所有域

您将属于组织 286 的所有活动项目的 Issues 表中的所有域导入到一个名为 All_Issues 的 Analytics 表：

IMPORT GRCPROJECT TO All_Issues "C:\HighBond Projects Data\All_Issues.fil" FROM "286@us/findings"

备注

说明

有关此命令工作原理的详细信息，请参见 Analytics 帮助。

创建密码定义并指定密码值

PASSWORD 命令

如果您使用 PASSWORD 命令创建用于连接至 HighBond 的编号密码定义，且未指定密码值，则在脚本试图连接时，将显示密码提示窗口。

有关详细信息，请参见PASSWORD 命令。

SET PASSWORD 命令

如果您使用 SET PASSWORD 命令创建用于连接至 HighBond 的编号密码定义，且指定密码值，则不会显示密码提示窗口，这对于旨在以无人看管方式运行的脚本而言是适当的。

有关详细信息，请参见 SET PASSWORD 命令。

获取 HighBond 访问令牌

无论您使用哪个方法来创建密码定义，所需的密码值都是用户可在 Launchpad 中生成的 HighBond 访问令牌。

注意

生成的访问令牌与用于登录 Launchpad 的账户匹配。 作为脚本编写者，如果该脚本将供他人使用，则在脚本中指定您自己的访问令牌可能不适当。

  1. 执行以下操作之一：
    • 从 Analytics 主菜单中选择工具 > HighBond 访问令牌。
    • 在脚本编辑器中，右键单击并选择插入 >HighBond 令牌。

    管理 API 令牌页面在您的浏览器中打开。 您可能需要首先登录启动面板。

  2. 执行以下操作之一：
    • 使用现有令牌在令牌列中，单击您想要使用的部分屏蔽令牌并输入您的 HighBond 账户密码。 未屏蔽的令牌被显示。

      提示

      除非您有理由创建新的令牌，请使用现有令牌。 如果现有令牌不工作，请创建一个新的令牌。

      使用现有令牌可削减您需要管理的令牌数。

    • 创建新令牌单击创建令牌 > Analytics 并输入您的 HighBond 账户密码。

      一个新的 Analytics 令牌被创建。

      说明

      如果您是启动面板系统管理员，您还可以选择创建 API 令牌。 您应该保留 API 令牌以用于其预期用途，即对 HighBond 平台进行编程访问。

  3. 单击复制以复制该令牌。

    提示

    在成功粘贴该令牌前，请勿关闭包含该令牌的对话框。

  4. 在 Analytics 中，执行下列操作之一：
    • 将该令牌粘贴到密码提示窗口中
    • 将该令牌粘贴到脚本中 SET PASSWORD 命令语法的适当位置
  5. 在启动面板中，关闭包含该令牌的对话框。

    如果您创建了新令牌，则该令牌的部分屏蔽版本被添加到您的令牌列表的顶部。

    有关详细信息，请参见创建和管理访问令牌。

导入调试功能

对于从 HighBond 进行的导入操作，存在简单的调试功能。

导入的数据被暂时存储在包含目标 Analytics 项目的文件夹中的一个 JSON 中间文件中。 在任何包含 Analytics 项目的文件夹中，您都可以创建一个文本文件，以使该 JSON 文件得以保留，而不是在数据被导入到 Analytics 之后被删除。

  • 存在 JSON 文件如果从 HighBond 导入失败，但 JSON 文件存在于您的计算机上，则您可以断定问题出在 Analytics 身上，而不是出在 HighBond 身上。
  • 不存在 JSON 文件如果从 HighBond 导入失败，而 JSON 文件不存在于您的计算机上，则您可以断定问题出在 HighBond 身上。

该信息可以帮助排除故障。

配置 JSON 中间文件的保留

在包含目标 Analytics 项目的文件夹中，创建一个具有此名称的空文本文件：_grc_import_debug.txt

当您从 HighBond 中的结果应用程序或者项目应用程序中导入时，JSON 中间文件会被使用名称 results.json 保留下来。 此后，每当从 HighBond 导入时，该文件都会被覆盖。