IMPORT GRCRESULTS 命令
概念信息
通过导入一个 HighBond 结果应用程序表或者解释来创建 Analytics 表。
语法
IMPORT GRCRESULTS TO 表 导入文件名 PASSWORD 数值 FROM 结果资源路径 <FIELD 名称 AS 显示名称 <...n>> <CHARMAX 最大字段长度>
参数
| 名称 | 描述 | |||||||
|---|---|---|---|---|---|---|---|---|
| TO 表 |
数据要导入到的 Analytics 表的名称。 说明 表名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ )，但不能包括其他特殊字符或任何空格。该名称不能以数字开头。 |
|||||||
|
导入文件名 |
要创建的 Analytics 数据文件的名称。 将导入文件名指定为具有 .FIL 文件扩展名的带引号的字符串。例如，"Invoices.FIL"。 默认情况下，数据文件 (.fil) 被保存到包含 Analytics 项目的文件夹。 请使用绝对或相对文件路径将该数据文件保存到另外的现有文件夹：
|
|||||||
| PASSWORD 数字 |
要使用的密码定义。 您不使用 PASSWORD 数字 提示用户提供或者指定实际密码。密码定义是指先前使用 PASSWORD 命令、SET PASSWORD 命令或 PASSWORD 分析标记提供或设置的密码。 数字是密码定义的编号。例如，如果之前已在脚本中或在调度分析脚本时提供或设置了两个密码，则 PASSWORD 2 指定使用密码 #2。 有关提供或设置密码的详细信息，请参见： 所需的密码值是 HighBond 访问令牌。有关详细信息，请参见创建密码定义并指定密码值。 可能需要也可能不需要 PASSWORD 数值，具体取决于脚本运行的环境。
|
|||||||
|
FROM Results 资源路径 |
您所导入的数据的路径。 该路径的形式因您所导入的数据的不同而不同。有关路径形式的详细信息，请参见结果应用程序路径。 说明 结果应用程序路径的形式由 API 提供，并且会发生变化。获得该路径的正确和最新语法的最容易、最可靠的方式是手动导入目标数据，并且从命令日志复制该路径。 |
|||||||
| FIELD 名称 AS 显示名称 <...n> 可选 |
源数据中要导入的单个域。请指定名称。 如果您省略 FIELD，则会导入所有域。 名称名称必须完全匹配结果应用程序表中的物理域名称，包括匹配大小写。要查看物理域名称，请执行以下操作之一：
说明 结果应用程序物理域名称不是用于表视图中的列标题的显示名称。 显示名称显示名称（备选列标题）是新 Analytics 表中的视图中的域的显示名称。您必须为每个 FIELD 名称指定一个显示名称。请将显示名称指定为带引号的字符串。 如果您希望列标题包含换行符，请在单词之间使用分号 (;)。 与 Analytics 中的某些其他 IMPORT 命令不同，您不能指定空白显示名称作为将 FIELD 名称用作显示名称的一种方式。 |
|||||||
| CHARMAX 最大域长度 可选 |
Analytics 表中所有字段的最大字符长度，源自结果表或解释中的字符数据。 结果表或解释中超过最大字段长度的数据，在导入 Analytics 时会被截断。 截断字段这项功能，可防止偶尔出现的长值将整体记录长度扩展到超过导入流程支持的长度范围：
|
示例
从结果应用程序中的表中导入指定的域
您将指定的域从结果应用程序中的表导入到一个名为 T and E exceptions 的 Analytics 表：
IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD 1 FROM "results/api/orgs/11594/control_tests/185699/exceptions" FIELD "metadata.status" AS "状态" FIELD "EmpNo" AS "员工编号" FIELD "DATE" AS "日期" FIELD "CARDNUM" AS "卡号" FIELD "CODES" AS "经销商代码" FIELD "AMOUNT" AS "金额" FIELD "DESCRIPTION" AS "描述"
导入结果应用程序中的表中的所有域
您将结果应用程序中的表中的所有域导入到一个名为 T and E exceptions 的 Analytics 表：
IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD 1 FROM "results/api/orgs/11594/control_tests/185699/exceptions"
从结果表导入时，限制字段长度
将结果表中的所有字段导入名为 T 和 E 异常 的 Analytics 表。使用 CHARMAX 参数限制字段长度。
IMPORT GRCRESULTS TO T_and_E_exceptions "C:\Secondary Analysis\T_and_E_exceptions.fil" PASSWORD 1 FROM "results/api/orgs/11594/control_tests/185699/exceptions" CHARMAX 200
在生成的 Analytics 表中，源自结果应用程序的字符数据的所有字段长度均限制为指定的 200 个字符。超出限制的所有字段值都将被截断为 200 个字符。
从结果应用程序中的解释导入数据
您将结果应用程序中的解释导入到一个名为 T and E exceptions filtered 的 Analytics 表：
IMPORT GRCRESULTS TO T_and_E_exceptions_filtered "C:\Secondary Analysis\T_and_E_exceptions_filtered.fil" FROM "results/api/orgs/11594/control_tests/185699/interpretations/22699/exceptions"
备注
有关此命令工作方式的详细信息，请参见导入 HighBond 结果应用程序数据。
保留排序顺序和过滤器
当您从结果应用程序导入数据时，根据您导入数据的方式的不同，任何数据自定义（如排序或过滤器）都会被在生成的 Analytics 表中保留下来或者被忽略：
- 导入表数据自定义被忽略。该表中的所有数据都被导入，但您选择省略的任何域除外。
- 导入解释数据自定义被保留
结果应用程序路径
说明
结果应用程序路径的形式由 API 提供，并且会发生变化。获得该路径的正确和最新语法的最容易、最可靠的方式是手动导入目标数据，并且从命令日志复制该路径。
FROM 参数中的结果应用程序路径采用以下一般形式：
FROM "results <-地区代码>/api/orgs/<组织 ID>/control_tests/<控制测试 ID>/exceptions
例如：
FROM "results/api/orgs/11594/control_tests/4356/exceptions"
当您登录启动面板时，组织 ID 将显示在浏览器地址栏中。当您在结果应用程序中查看这些表时，控制测试 ID 和解释 ID 将显示在地址栏中。
下表提供了结果应用程序路径的变体。
| 要导入： | 使用以下形式的结果应用程序路径： |
|---|---|
| 控制测试（表）数据 | FROM "results/api/orgs/11594/control_tests/4356/exceptions" |
| 控制测试（表）审计轨迹 | FROM "results/api/orgs/11594/control_tests/4356/audit_trail" |
| 控制测试（表）注释 | FROM "results/api/orgs/11594/control_tests/4356/comments" |
| 解释 | FROM "results/api/orgs/11594/control_tests/4356/interpretations/1192/exceptions" |
| 来自除默认地区 — 北美（美国）以外的 HighBond 地区的数据 |
|
系统生成的信息列
当您从结果应用程序导入数据时，可以选择导入下列一个或多个由系统生成的信息列。
系统生成的列是下列两种情形之一：
- 结果应用程序表的一部分，并且包含与单个记录有关的处理信息
- 其他信息——集合名称、表名称或记录身份证号
您必须完全如下所示指定系统生成列的域名称。当您通过 Analytics 用户界面从结果应用程序导入时，将应用默认显示名称。如果您要编写导入脚本，则可以任意更改显示名称。
|
域名称 |
默认显示名称 |
|---|---|
|
metadata.priority |
优先级 |
|
metadata.status |
状态 |
|
metadata.publish_date |
发布日期 |
|
metadata.publisher |
发布者名称 |
|
metadata.assignee |
被分配人 |
| metadata.group | 组 |
| metadata.updated_at | 已更新 |
| metadata.closed_at | 已关闭 |
| extras.collection | 集合 |
| extras.results_table | 结果表 |
| extras.record_id | 记录 ID |
导入和导出结果应用程序数据时的域名称注意事项
如果您要在结果应用程序和 Analytics 之间双向传输数据，您需要确保结果应用程序表中的所有域名称都满足更严格的 Analytics 域名称要求。否则，您会承担 Analytics 和结果应用程序数据不匹配的风险。
例如，当结果应用程序域名称被导入到 Analytics 时，其中包含的任何特殊字符都被自动转换为下划线，这意味着这些域名称不再匹配结果应用程序中的原始名称。如果您随后将 Analytics 数据重新导出到结果应用程序中的原始表，则这些域不再被正确匹配。
要使您打算双向传输的数据避免出现该问题，请您在将数据从 CSV 或者 Excel 文件上传到结果应用程序之前，数据满足下列 Analytics 域名称要求：
- 不包含特殊字符或者空格
- 不以数字开头
- 只包含字母数字字符或者下划线字符 ( _ )
创建密码定义并指定密码值
在可导入 HighBond 结果表或解释的机器人中运行脚本时，需要使用 IMPORT GRCRESULTS 命令添加密码定义。如果您使用离线激活，则同样的要求适用于在 Analytics 中运行的脚本。
无论您使用哪种方法创建密码定义，必填的密码值都是 HighBond 访问令牌，您可以在启动面板中生成该令牌。有关详细信息，请参见获取 HighBond 访问令牌。
密码定义方法
| 方法 | 描述 |
|---|---|
|
PASSWORD 分析标记 （适用于在机器人中运行的脚本） |
如果使用 PASSWORD 分析标记创建用于连接至 HighBond 的编号密码定义，且脚本中未指定密码值。当您创建一个要在机器人中运行脚本的任务时，任务设计器中的输入字段允许您或其他用户指定实际密码。 有关更多信息，请参阅 PASSWORD 分析标记。 |
|
PASSWORD 命令 （适用于在 Analytics 中运行的脚本，离线激活） |
如果使用 PASSWORD 命令创建用于连接至 HighBond 的编号密码定义，且脚本中未指定密码值。当脚本试图连接时，会显示密码提示。 有关详细信息，请参见PASSWORD 命令。 |
|
SET PASSWORD 命令 （适用于在 Analytics 中运行的脚本，离线激活） |
如果您使用 SET PASSWORD 命令创建用于连接至 HighBond 的编号密码定义，且在脚本中指定了密码值，则不会显示密码提示。这种方法适用于以无人看管方式运行的脚本，但它会在脚本中以明文形式显示实际密码，这可能不适合您的情况。 有关详细信息，请参见 SET PASSWORD 命令。 |
获取 HighBond 访问令牌
注意
生成的访问令牌与用于登录 HighBond 的账户匹配。 作为脚本编写者，如果该脚本将供他人使用，则在脚本中指定您自己的访问令牌可能不适当。
像保护任何账户密码一样保护访问令牌。
除非有充分的理由创建新令牌，否则请使用现有令牌。如果现有令牌不工作，请创建一个新的令牌。使用现有令牌可削减您需要管理的令牌数。
-
执行以下操作之一：
-
从 Analytics 主菜单中，选择工具 > HighBond 访问令牌。
-
在脚本编辑器中，右键单击并选择插入 >HighBond 令牌。
浏览器中会打开管理 API 令牌页面。您可能需要先登录 HighBond。
通过 Analytics 访问管理 API 令牌页面是一项便利功能。您还可以登录 HighBond，然后通过用户个人资料访问该页面，无需使用 Analytics。
-
-
执行以下操作之一：
-
使用现有令牌
-
在令牌列中，单击要使用的已部分掩码的令牌。
-
输入您的 HighBond 帐户密码，然后单击确认。
未屏蔽的令牌被显示。
-
单击复制以复制该令牌。
提示
在成功粘贴该令牌之前，请勿关闭包含该令牌的对话框。
-
-
创建新令牌
-
单击添加令牌 > Analytics。
-
在新建 Analytics 令牌侧面板中，指定以下信息：
域或选项 描述 描述 输入提供有用信息的描述，例如：
- 令牌的用途
- 令牌的使用场景 – 例如，分析脚本的名称和位置，或者机器人任务的名称和位置
令牌有效期 - 已启用令牌将在您指定的天数之后到期
- 已禁用令牌永不过期
说明
贵组织可能制定了一项安全政策，要求令牌在一定时间之后到期。创建包含有效期的令牌是一种好做法。HighBond 会在到期日之前，向您发送一封自动电子邮件通知。
即将在…到期 指定距离令牌到期日之前的天数（1 到 365 天）。 密码 输入您的 HighBond 帐户密码。 -
单击生成令牌。
-
单击复制以复制该令牌。
提示
在成功粘贴该令牌之前，请勿关闭包含该令牌的侧面板。
-
-
-
根据您使用的密码定义方法，执行以下操作之一：
-
PASSWORD 分析标记在 ACL 机器人的任务设计器中，将复制的令牌粘贴到密码参数字段中。
-
PASSWORD 命令在 Analytics 中，将复制的令牌粘贴到执行脚本过程中出现的密码提示中。
-
SET PASSWORD 命令在 Analytics 中，将复制的令牌粘贴到脚本中 SET PASSWORD 命令语法的适当位置。
-
-
在启动面板中，关闭包含该令牌的对话框或侧面板。
如果您创建了新令牌，则该令牌的部分屏蔽版本被添加到您的令牌列表的顶部。
有关更多信息，请参阅创建和管理 HighBond 访问令牌。
导入调试功能
对于从 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 导入时，该文件都会被覆盖。
导入大型表
包含大量域的表可能无法使用单个 IMPORT GRCRESULTS 命令成功导入。如果您需要使用单个位于结果应用程序外部且包含大量域的表，请使用下列方法之一：
- 拆分表使用两个或更多个 IMPORT GRCRESULTS 命令导入域的一个子集，然后使用 JOIN 命令联接 Analytics 中的结果表
- 将表导出到文件使用导出至 CSV 格式功能，然后使用 IMPORT DELIMITED 命令将生成的文件导入 Analytics
