自定义工作流脚本
您可以编辑项目工作流脚本,以自定义可执行的操作和 Web Runner 用户界面中可供您使用的字段。
备注: 确保您拥有用于自定义工作流脚本的“设置工作流”权限。
概述
您可以编写工作流脚本,以自定义可执行的操作以及 Web Runner 中可供您使用的字段。
Example: 您可以在编辑或提交缺陷时控制以下内容:
-
可用字段
-
必填字段
-
字段的默认自动填充值
-
字段的唯一一个有效值
项目工作流脚本按模块分组。您可以通过将 JavaScript 代码添加到工作流脚本中包含的事件来编辑工作流脚本。
Example: 在“缺陷”模块脚本下,您可以编辑 Bug_New 事件以自定义提交缺陷时的用户操作。例如,您可以在提交缺陷时为必填字段分配默认值。
交叉项目自定义的注意事项
如果您处理模板或链接的项目,工作流脚本树将显示以下部分:
模板脚本 |
此部分中列出的工作流脚本是从模板应用于链接项目的脚本。 如果使用链接的项目,仅当有模板中定义的模板脚本时才显示此部分。模板脚本不能在链接的项目中编辑。如果从模板删除项目,则模板脚本保留在项目中,且可编辑。 前缀 Template_ 添加到模板脚本的事件中。 |
项目脚本 |
此部分中列出的工作流脚本只应用于正在使用的模板或链接的项目。此部分中的模板脚本不应用于链接的项目。 运行链接项目的工作流脚本时,ALM 将模板脚本和项目脚本组合到一个脚本中。模板脚本和项目脚本中重复的变量或函数可能导致冲突。 |
默认情况下,ALM 触发模板事件。如果模板事件不存在或指示模板事件调用项目事件,将触发项目事件。
每个模板事件都包括对并行项目事件的带注释的调用。
编辑脚本
要编写工作流脚本,将 JavaScript 代码添加到由用户操作触发的事件过程。
要编辑脚本,请执行以下操作:
-
在 Web Runner 的右上角,单击“设置”
>“自定义”。
-
在工作流脚本树中目标模块的节点下,根据您希望何时触发代码,选择要将代码添加到的脚本。
“公用脚本”节点包含可从多个模块访问的脚本。
有关事件过程的详细描述,请参阅 ALM 事件的参考。
-
将 JavaScript 代码添加到脚本。
-
单击“保存”。
SharedFunction 事件
您可以在 SharedFunction 事件中定义全局变量或函数。此事件中包含的脚本可以由任何其他事件调用。
如果脚本调用 SharedFunction 事件,则对该事件的函数或变量的更改仅在当前脚本中生效。
调试工作流脚本
您可以调试工作流脚本以解决其错误。
要调试工作流脚本,请执行以下操作:
-
从工作流脚本树中,选择工作流脚本。
-
在编辑器区域中,添加以下语句:
Copy codedebugger
console.log("<script_name> triggered")例如:
Copy codefunction Bug_New() {
debugger
console.log("Bug_New triggered")
} -
按 F12 键打开浏览器控制台。
-
在 ALM 中触发脚本。
例如,单击“新建缺陷”窗口中的“创建”按钮。
-
在浏览器控制台中调试脚本。
限制
工作流脚本包括以下限制:
-
并非所有在编辑脚本时自动建议的对象或方法都可以被调用。如果调用不受支持的对象或方法,则会发生错误。
-
工作流脚本树中列出的某些脚本不可使用。它们以灰色显示。
另请参见: