创建和编辑脚本
您具有多个用于创建脚本的选择:
- 脚本编辑器 在脚本编辑器窗口中键入脚本语法
- 脚本日志 从命令日志复制脚本语法
- 脚本记录器 在您执行命令的同时记录它们的语法
- 语法捕获 在您在用户界面中选择命令的同时插入这些命令的语法而不执行它们
- 表历史记录 从输出表的历史记录中复制脚本语法
您可以组合使用上述选项。例如,您可以通过从命令日志复制语法来开始一个脚本,然后直接在脚本编辑器窗口中添加其他语法行。
要在 Analytics 中编辑现有脚本,您必须使用脚本编辑器。
您还可以选择使用您喜欢的文本编辑器,并且将语法复制并粘贴到 Analytics 脚本中。
代码完成
在脚本编辑器中输入脚本语法时,Analytics 会执行不同的代码完成类型。代码完成减少了与输入语法相关的劳动,还提供了 ACLScript 命令、函数、关键字和参数的有效形式。
-
自动补全命令、函数和关键字 随着您开始输入,自动完成功能会提供一个逐步更新的,且与输入的字符相匹配的 ACLScript 命令、函数和与关键字的选择列表。您可以从列表中选择一个条目来自动完成语法条目。
-
函数参数的弹出式帮助窗口 在有效函数名后输入左括号时,弹出式帮助窗口会显示函数返回的输出的数据类型,以及函数参数所需的格式。
-
自动关闭成对的语法条目当您输入以下任何成对语法条目的开头字符时,会自动提供结束字符:
-
双引号 ""
-
单引号 ''
-
反撇号 ``
-
括号 ()
-
您可以通过在选项对话框(工具 > 选项)的界面选项卡中选择在脚本中禁用自动完成功能来关闭命令、函数和关键字的自动完成功能。
无法禁用函数参数的弹出式帮助窗口和常用语法条目的自动关闭。
从 ScriptHub 导入脚本或代码片段
用于创建脚本的另一个选项是利用 ScriptHub 中的内容。ScriptHub 是由 Diligent 员工和 Diligent 用户社区开发的、基于 Web 的 Analytics 脚本化条目库。作为您的订阅的一部分,您可以下载并使用 ScriptHub 中的任何内容。
有关详细信息,请参见从 ScriptHub 导入。
在脚本编辑器中创建或编辑脚本
通过直接在脚本编辑器中键入所需的 ACLScript 语法,或者使用其他受支持的语法输入方法之一来创建或编辑脚本。
说明
当创建或编辑脚本时,必须确保每个 ACLScript 命令都在单独一行中输入。
创建或编辑脚本
- 执行以下操作之一,在脚本编辑器中打开脚本:
- 要创建新脚本,请选择文件 > 新建 > 脚本。
新建脚本的名称为 New_Script。右键单击该名称并选择重命名可重命名该脚本。
说明
脚本名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ ),但不能包括其他特殊字符或任何空格。该名称不能以数字开头。
- 要打开现有的脚本,请在导航器的概览选项卡中右键单击该脚本。
- 要创建新脚本,请选择文件 > 新建 > 脚本。
- 在脚本编辑器中添加、修改或删除 ACLScript 语法。
提示
您可以使用下列快捷键执行常见操作:
- Ctrl+Z 撤销一个或多个操作
- Ctrl+Y 重做一个或多个操作
- Ctrl+S 保存 Analytics 项目(包括已打开的脚本)
- (可选)将光标放置在脚本中的适当位置,然后完成下列任一步骤以插入一个或多个特定条目:
条目 步骤 项目条目名称
(表、脚本、视图、工作空间或索引)
- 右键单击并选择插入 > 项目条目。
- 从条目类型下拉列表中,选择条目类型。
- 选择一个或多个条目名称,然后单击确定。
域名称 - 在脚本编辑器工具栏中单击插入域
。 - 选择一个或多个域名称,然后单击确定。
表达式 - 在脚本编辑器工具栏中单击插入表达式
。 - 创建一个表达式,然后单击确定。
对话框 - 在脚本编辑器工具栏中单击生成新对话框
。 - 创建一个自定义对话框,单击关闭,然后单击确定。
有关详细信息,请参阅创建自定义对话框。
日期和时间 - 右键单击并选择插入 > 日期和时间。
- 输入或选择日期、日期时间或时间,然后单击确定。
Diligent One令牌 有关更多信息,请参阅获取 Diligent One 访问令牌。
- 选择文件 > 保存项目。
- 在确认对话框中单击是。
突出显示重复的术语或语法条目
您可以在整个脚本中突出显示重复的术语,如表、域、变量或关键字名称。您还可以突出显示重复的语法条目,如括号或引号。
突出显示所有出现的特定术语或语法条目是一个非常有用的脚本开发和调试功能。
-
术语 要突出显示某个术语的多个实例,请在脚本中的任何位置双击该术语的单个实例。
-
短语 要突出显示某个短语的多个实例,请在脚本中的任何位置选择该短语的单个实例。
说明
突出显示的行为可能并不总是符合您的期望。例如,如果您选择变量名称被百分号 % 包围的实例,则该变量的其他实例可能不会突出显示。双击变量的名称,以便在整个脚本中实现更一致的突出显示。
突出显示匹配的括号
您可以在表达式(如包含嵌套参数的函数)中突出显示匹配的括号。能够在复杂表达式中突出显示匹配的左括号和右括号不仅加快了编程速度,并降低了因创建括号不匹配的表达式而引入错误的可能性。
要突出显示匹配的括号,请将光标正好放置在脚本中单个括号的前面或后面。左括号和右括号都突出显示。如果匹配的括号未突出显示,则表示括号对中缺少一个括号。
使用对话框编辑命令语法
您可以使用关联的对话框编辑命令,而不是在脚本中手动编辑它们。
说明
只能对具有对话框的命令使用此方法。
- 在该脚本中选择一个现有的 ACLScript 命令。
- 在脚本编辑器工具栏中单击编辑命令
。该命令对话框将打开。
- 在该对话框中,对命令参数进行所需的更改,然后单击确定。
脚本语法将被更新。
并排打开两个脚本
您可以在脚本编辑器中并排打开两个脚本,这样可以轻松地来回比较和复制脚本语法。
-
在导航器的概述选项卡中,选择要并排打开的两个脚本。
您可以使用 Ctrl+单击以选择两个不相邻的脚本,或使用 Shift+单击以选择相邻的脚本。
-
右键单击选中的脚本之一,然后选择并排编辑。
这两个脚本以并排模式打开。
-
单击任一脚本的正文以在脚本之间移动。
如果在脚本编辑器中使用默认背景颜色,则当前活动的脚本会具有颜色较浅的背景。
-
要保存对一个或两个脚本的更改,请执行以下操作之一:
-
按 Ctrl+S,然后在出现的确认对话框中单击是。
- 在 Analytics 工具栏上,单击保存打开的项目
,然后在出现的确认对话框中单击是。
-
-
要退出并排模式,请单击“脚本”选项卡上的关闭图标
。这两个脚本在单独的脚本编辑器选项卡中打开。
测试该脚本
如果您想要通过运行脚本或通过单步执行脚本来测试脚本,请单击脚本编辑器工具栏中的运行
或单步执行
。
说明
如果您运行或单步执行脚本,则所有已打开的脚本都会被自动保存。
从命令日志创建脚本
您可以从导航器的日志选项卡中复制日志条目作为创建新脚本的起点,或者将其添加至现有脚本。Analytics 中以前执行的每个命令的语法都被记录在单个日志条目中。
您可以选择以下类型的日志条目并将其复制到一个新的或现有的脚本:
- 单个条目
- 与某个表相关联的一系列条目
- 与某个会话或者时段相关联的大型条目组
- 在导航器中,单击日志选项卡以显示日志。
- 选择您想要包括在脚本中的日志条目或者条目组。
如果您选择了树状视图中的较高级别的条目,则子条目会被自动选择。
- 执行下列操作之一:
创建一个新脚本 - 右键单击日志选项卡并选择保存选定的条目 > 脚本。
- 在脚本另存为对话框中输入新脚本的名称并单击确定。
说明
脚本名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ ),但不能包括其他特殊字符或任何空格。该名称不能以数字开头。
新脚本被添加到导航器中的概览选项卡。该脚本被保存在包含活动 Analytics 表的文件夹中,如果没有表被打开,则被保存项目根文件夹中。
复制语法到现有脚本 - 在日志选项卡中右键单击,然后选择复制。
- 如果尚未有脚本被打开,请打开一个现有脚本。
- 在脚本编辑器中,将光标放在您想要插入所复制语法的位置。
- 右键单击并选择粘贴。
使用脚本记录器创建脚本
Analytics 脚本记录器可在您在 Analytics 用户界面中处理表和命令时记录下您的操作,从而使您可以创建脚本。使用脚本记录器的优点是,您无须为每个 ACLScript 命令输入所需的语法,甚至无须了解该语法,即可创建脚本。
脚本记录器仅可捕获命令。一般来说,如果命令出现在命令日志中,则脚本记录器可以捕获它。
提示
脚本记录器也是一种对学习 ACLScript 很有用的工具。您可通过脚本记录器记录一系列的分析步骤,然后查看所得脚本,弄清完成脚本中的操作所需的各种命令和语法。
- 从 Analytics 主菜单中选择工具 > 打开脚本记录器。
脚本记录器图标
显示在状态栏中,而显示在菜单条目左侧的复选框指示脚本记录器已开启。 - 执行要记录的分析步骤或处理。
Analytics在一个新脚本中记录每个已处理的命令。
- 当您分析或处理完数据时,请再次选择工具 > 打开脚本记录器以关闭脚本记录器。
Analytics会提示您保存该脚本。
- 为文本框中的脚本输入一个有意义的名称,然后单击确定。
说明
脚本名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ ),但不能包括其他特殊字符或任何空格。该名称不能以数字开头。
使用语法捕获创建脚本
语法捕获使您可以使用 Analytics 菜单和对话框将 ACLScript 语法自动插入到脚本中。
- 打开您想要使用的脚本。
- (可选)打开您想要使用的表。
提示
如果您在打开表之前启动语法捕获,则该表不会被在视图选项卡中实际打开,因为命令在语法捕获期间不会被实际执行。如果没有打开的表作为指导,您可能会发现要直观地显示后续的命令会很困难。
- 从脚本编辑器工具栏中单击开始语法捕获
。 - 执行您想要记录的分析步骤或处理。
关联的语法被自动插入到该脚本中。这些命令本身并不被执行。
- 单击结束语法捕获
可停止在脚本中插入命令语法。
从表历史记录创建脚本
您可以根据与 Analytics 输出或者结果表相关联的历史记录来创建脚本。
例如,如果您向 Analytics 项目添加月度库存表并且将相关的部门和货物提取至一个新的表,则可以根据与您创建的第一个输出表相关联的表历史记录将此过程脚本化。
每个作为 Analytics 命令输出而创建的表都会保留用来创建该表的命令的记录,包括在原始 Analytics 表和输出表之间创建任何中间表的命令。您可以将此表历史记录复制到一个新的脚本,然后可以使用它来自动创建后续输出表。
-
打开一个输出表。该输出表是您想要在脚本中自动完成的过程的结果。
-
选择工具 > 从表历史记录创建脚本。
如果默认视图处于活动状态,则 Analytics 会提示您重命名该视图,以防止您在运行新脚本时覆盖默认视图。
-
如果 Analytics 提示您重命名该视图,请单击重命名并输入一个新名称,然后单击确定。
-
在另存为对话框中,输入新脚本的名称并单击确定。
说明
脚本名称被限制为不超过 64 个字母数字字符。该名称可以包括下划线字符 ( _ ),但不能包括其他特殊字符或任何空格。该名称不能以数字开头。
-
(可选)如果您想要调整任何脚本行为,请打开并编辑新脚本。
例如,您可以选择将输出保存到一个具有不同名称的表,而不是覆盖原始表。
获取 Diligent One 访问令牌
注意
生成的访问令牌与用于登录 Diligent One 的账户匹配。 作为脚本编写者,如果该脚本将供他人使用,则在脚本中指定您自己的访问令牌可能不适当。
像保护任何账户密码一样保护访问令牌。
除非有充分的理由创建新令牌,否则请使用现有令牌。如果现有令牌不工作,请创建一个新的令牌。使用现有令牌可削减您需要管理的令牌数。
-
执行以下操作之一:
-
从 Analytics 主菜单中,选择工具 > Diligent One 访问令牌。
-
在脚本编辑器中,右键单击并选择插入 > Diligent One 令牌。
管理 API 令牌页面将在您的浏览器中打开。您可能需要先登录到 Diligent One。
通过 Analytics 访问管理 API 令牌页面是一项便利功能。您还可以登录到 Diligent One,然后通过用户个人资料访问该页面,而无需使用 Analytics。
-
-
执行以下操作之一:
-
使用现有令牌
-
在令牌列中,单击要使用的已部分屏蔽的令牌。
-
输入您的 Diligent One 账户密码,然后单击确认。
未屏蔽的令牌被显示。
-
单击复制以复制该令牌。
提示
在成功粘贴该令牌之前,请勿关闭包含该令牌的对话框。
-
-
创建新令牌
-
单击添加令牌 > Analytics。
-
在新建 Analytics 令牌侧面板中,指定以下信息:
域或选项 描述 描述 输入提供有用信息的描述,例如:
- 令牌的用途
- 令牌的使用场景 – 例如,分析脚本的名称和位置,或者机器人任务的名称和位置
令牌有效期 - 已启用令牌将在您指定的天数之后到期
- 已禁用令牌永不过期
说明
贵组织可能制定了一项安全政策,要求令牌在一定时间之后到期。创建包含有效期的令牌是一种好做法。Diligent One 会在到期日之前,向您发送一封自动电子邮件通知。
即将在…到期 指定距离令牌到期日之前的天数(1 到 365 天)。 密码 输入您的 Diligent One 账户密码。 -
单击生成令牌。
-
单击复制以复制该令牌。
提示
在成功粘贴该令牌之前,请勿关闭包含该令牌的侧面板。
-
-
-
根据您使用的密码定义方法,执行以下操作之一:
-
PASSWORD 分析标记在 ACL 机器人的任务设计器中,将复制的令牌粘贴到密码参数字段中。
-
PASSWORD 命令在 Analytics 中,将复制的令牌粘贴到执行脚本过程中出现的密码提示中。
-
SET PASSWORD 命令在 Analytics 中,将复制的令牌粘贴到脚本中 SET PASSWORD 命令语法的适当位置。
-
-
在启动面板中,关闭包含该令牌的对话框或侧面板。
如果您创建了新令牌,则该令牌的部分屏蔽版本被添加到您的令牌列表的顶部。
有关更多信息,请参阅创建和管理 Diligent One 访问令牌。