IMPORT GRCRESULTS 命令
通过导入一个 HighBond 结果应用程序表或者解释来创建 Analytics 表。
语法
IMPORT GRCRESULTS TO 表 导入文件名 PASSWORD 数字 FROM 结果资源路径 <FIELD 名称 AS 显示名称 <...n>>
参数
名称 | 描述 | |||||||
---|---|---|---|---|---|---|---|---|
TO 表 |
数据要导入到的 Analytics 表的名称。 说明 表名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ ),但不能包括其他特殊字符或任何空格。该名称不能以数字开头。 |
|||||||
导入文件名 |
要创建的 Analytics 数据文件的名称。 将导入文件名指定为具有 .FIL 文件扩展名的带引号的字符串。例如,"Invoices.FIL"。 默认情况下,数据文件 (.fil) 被保存到包含 Analytics 项目的文件夹。 请使用绝对或相对文件路径将该数据文件保存到另外的现有文件夹:
|
|||||||
PASSWORD 数字 |
要使用的密码定义。 您不使用 PASSWORD 数字 提示用户提供或者指定实际密码。密码定义是指先前使用 PASSWORD 命令、SET PASSWORD 命令或 PASSWORD 分析标记提供或设置的密码。 数字是密码定义的编号。例如,如果先前已在脚本中或者在调度分析时提供或设置了两个密码,则 PASSWORD 2 指定使用密码 #2。 有关提供或设置密码的详细信息,请参见: 说明 PASSWORD 未必是必需的,具体取决于该脚本的运行环境:
|
|||||||
FROM Results 资源路径 |
您所导入的数据的路径。 该路径的形式因您所导入的数据的不同而不同。有关路径形式的详细信息,请参见结果应用程序路径。 说明 结果应用程序路径的形式由 API 提供,并且会发生变化。获得该路径的正确和最新语法的最容易、最可靠的方式是手动导入目标数据,并且从命令日志复制该路径。 |
|||||||
FIELD 名称 AS 显示名称 <...n> 可选 |
源数据中要导入的单个域。请指定名称。 如果您省略 FIELD,则会导入所有域。 名称名称必须完全匹配结果应用程序表中的物理域名称,包括匹配大小写。要查看物理域名称,请执行以下操作之一:
说明 结果应用程序物理域名称不是用于表视图中的列标题的显示名称。 显示名称显示名称(备选列标题)是新 Analytics 表中的视图中的域的显示名称。您必须为每个 FIELD 名称指定一个显示名称。请将显示名称指定为带引号的字符串。 如果您希望列标题包含换行符,请在单词之间使用分号 (;)。 与 Analytics 中的某些其他 IMPORT 命令不同,您不能指定空白显示名称作为将 FIELD 名称用作显示名称的一种方式。 |
示例
从结果应用程序中的表中导入指定的域
您将指定的域从结果应用程序中的表导入到一个名为 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 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"
备注
说明
有关此命令工作原理的详细信息,请参见 Analytics 帮助。
保留排序顺序和过滤器
当您从结果应用程序导入数据时,根据您导入数据的方式的不同,任何数据自定义(如排序或过滤器)都会被在生成的 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 域名称要求:
- 不包含特殊字符或者空格
- 不以数字开头
- 只包含字母数字字符或者下划线字符 ( _ )
创建密码定义并指定密码值
PASSWORD 命令
如果您使用 PASSWORD 命令创建用于连接至 HighBond 的编号密码定义,且未指定密码值,则在脚本试图连接时,将显示密码提示窗口。
要了解更多信息,请参考PASSWORD 命令。
SET PASSWORD 命令
如果您使用 SET PASSWORD 命令创建用于连接至 HighBond 的编号密码定义,且指定密码值,则不会显示密码提示窗口,这对于旨在以无人看管方式运行的脚本而言是适当的。
要了解更多信息,请参考 SET PASSWORD 命令。
HighBond 访问令牌
无论您使用哪个方法来创建密码定义,所需的密码值都是 HighBond 访问令牌:
- PASSWORD 方法 – 用户可以通过选择 ,然后登录 HighBond 获得访问令牌。将返回一个访问令牌,用户可以将其复制并粘贴到密码提示窗口中。
- SET PASSWORD 方法 – 要将访问令牌插入到 Analytics 脚本中的 SET PASSWORD 命令语法中,请右键单击脚本编辑器,选择 ,然后登录 HighBond。访问令牌被插入到脚本中的光标位置。
注意
返回的访问令牌与用于登录 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