动态过滤引用字段：基于关联数据和另一引用字段的选择

落辰同学_5250

发布时间：2025-09-01 19:41:01

536人浏览过

来源于php中文网

原创

动态过滤引用字段：基于关联数据和另一引用字段的选择

本文详细介绍了如何在ServiceNow中实现动态过滤引用字段的功能。通过配置高级引用限定符（Reference Qualifier）并结合服务器端脚本（Script Include），可以根据当前表单中已选择的另一个引用字段的值，智能地过滤出未被关联的记录，从而提升数据输入的准确性和用户体验。

1. 业务场景与挑战

在企业应用开发中，经常需要处理多表关联的数据，并要求在用户输入数据时提供智能化的选择列表。一个典型的场景是：存在用户（Users）和商品（Goods）两种主数据，以及一个记录用户与商品关联关系的链接表（LinkTbl）。现在，我们需要在一个新的表单（NewLinkTbl）中创建新的用户与商品关联。当用户首先选择一个特定的“用户”后，其对应的“商品”选择列表应只显示那些尚未与该用户建立关联的商品。

具体到数据模型，我们有以下四张表：

UsersTbl: 存储用户信息（UserID, UserName, UserEmail等）。
GoodsTbl: 存储商品信息（GoodsID, GoodsName等）。
LinkTbl: 存储用户与商品的现有链接关系，字段包括 GoodsRef (引用GoodsTbl) 和 UserRef (引用UsersTbl)。
NewLinkTbl: 用于创建新的用户与商品链接，同样包含 UserRef 和 GoodsRef 字段。

我们的目标是：在 NewLinkTbl 表单中，当 UserRef 字段被选中后，GoodsRef 字段的查找列表（Lookup List）应仅显示那些在 LinkTbl 中未与当前选定用户关联的商品。

2. 解决方案概述：高级引用限定符与脚本包含

ServiceNow提供了“引用限定符”（Reference Qualifier）功能来过滤引用字段的查找结果。对于需要根据表单中其他字段动态变化的复杂过滤逻辑，最有效的方法是使用“高级”（Advanced）引用限定符，并结合“脚本包含”（Script Include）来执行服务器端逻辑。

初始尝试使用客户端脚本（Client Script）通过 g_form.setValue() 来修改字段值，但这并不能直接过滤引用字段的查找列表。引用字段的查找列表过滤必须通过引用限定符来实现。

3. 实现步骤

3.1 配置引用字段的“高级引用限定符”

首先，我们需要修改 NewLinkTbl 表中 GoodsRef 字段的配置。

jm-jsjkxyjs02-zlm-405

使用约定式提交（Conventional Commits）生成标准化的 Git 提交信息。适用于以下场景： (1) 暂存更改时需要提交信息； (2) 审查 diff 时希望获得结构化摘要； (3) 编写 PR 描述或变更日志（changelog）条目； (4) 用户明确要求“为本次更改编写提交信息”。该功能会分析已暂存/未暂存的 diff，并生成按类型（type）划分范围的提交信息。

下载

导航到字段定义： 在ServiceNow Studio中，找到 NewLinkTbl 表，然后定位到 GoodsRef 字段。
设置引用限定符类型：
- 点击 GoodsRef 字段，打开其配置面板。
- 将“使用引用限定符”（Use reference qualifier）设置为“高级”（Advanced）。
输入引用限定符脚本： 在“引用限定符”（Reference qual）字段中，输入以下JavaScript代码：
```
javascript:(new ScriptIncludeJS()).getNotLinkedGoods(current.user_name);
```
- 解释：
  - javascript:：表明这是一个JavaScript表达式。
  - (new ScriptIncludeJS())：创建 ScriptIncludeJS 脚本包含的一个实例。
  - .getNotLinkedGoods(current.user_name)：调用该实例中的 getNotLinkedGoods 方法，并将当前表单记录的 user_name 字段值作为参数传递。这里的 current.user_name 指的是 NewLinkTbl 表单中 UserRef 字段的实际数据库字段名（通常是 sys_id 或 name，根据配置）。为了清晰起见，假设 UserRef 字段的实际数据库字段名为 user_name。如果 UserRef 是引用字段，current.user_name 会传递其 sys_id。

3.2 创建或修改脚本包含（Script Include）

接下来，我们需要创建一个名为 ScriptIncludeJS 的脚本包含，并在其中实现 getNotLinkedGoods 方法。

创建脚本包含：
- 在ServiceNow Studio中，导航到“服务器开发” -> “脚本包含”。
- 点击“新建”创建一个新的脚本包含。
- 名称 (Name): ScriptIncludeJS
- 客户端可调用 (Client callable): 勾选此项，因为引用限定符会从客户端调用它。
- 可从以下范围访问 (Accessible from): 设置为“所有应用程序范围”或您的应用程序范围。

编写脚本： 在脚本字段中输入以下代码：

var ScriptIncludeJS= Class.create();
ScriptIncludeJS.prototype = Object.extend(global.AbstractAjaxProcessor, {

    /**
     * 获取未与指定用户关联的商品列表的引用限定符字符串。
     *
     * @param {string} userID - 当前选定用户的sys_id。
     * @returns {string} - 一个GlideRecord查询字符串，用于过滤GoodsTbl。
     */
    getNotLinkedGoods: function(userID) {
        var linkedGoodsSysIDs = []; // 用于存储已关联商品的sys_id

        // 1. 验证传入的userID是否有效
        if (!userID) {
            return 'sys_idISNOTEMPTY'; // 如果没有选择用户，则显示所有商品
        }

        // 2. 查询LinkTbl，找到所有已与该用户关联的商品
        // 假设 'x_1234_pro_0_linkedtbl' 是 LinkTbl 的表名
        // 假设 LinkTbl 中的用户引用字段名为 'user_name' (存储sys_id)
        // 假设 LinkTbl 中的商品引用字段名为 'goods_name' (存储sys_id)
        var grLink = new GlideRecord('x_1234_pro_0_linkedtbl'); // 替换为您的LinkTbl表名
        grLink.addQuery('user_name', userID); // 查询与传入userID关联的记录
        grLink.query();

        while(grLink.next()) {
            // 将已关联商品的sys_id添加到数组中
            linkedGoodsSysIDs.push(grLink.getValue('goods_name')); // 替换为LinkTbl中商品引用字段的数据库名
        }

        // 3. 构建引用限定符字符串
        if (linkedGoodsSysIDs.length === 0) {
            // 如果没有已关联的商品，则显示所有商品（即不进行过滤）
            return 'sys_idISNOTEMPTY';
        } else {
            // 返回一个 'sys_id NOT IN' 查询字符串，排除已关联的商品
            return 'sys_idNOT IN' + linkedGoodsSysIDs.join(',');
        }
    },

    type: 'ScriptIncludeJS'
});

代码解释：
- getNotLinkedGoods(userID) 方法接收 NewLinkTbl 表单中 UserRef 字段的 sys_id。
- linkedGoodsSysIDs 数组用于收集所有已与该 userID 关联的商品的 sys_id。
- new GlideRecord('x_1234_pro_0_linkedtbl')：创建一个 GlideRecord 对象来查询 LinkTbl（请务必替换为您的实际 LinkTbl 表名）。
- grLink.addQuery('user_name', userID)：根据传入的 userID 过滤 LinkTbl 中的记录。请确保 'user_name' 是 LinkTbl 中引用 UsersTbl 的字段的数据库名称。
- grLink.getValue('goods_name')：获取 LinkTbl 中引用 GoodsTbl 的字段的 sys_id。请确保 'goods_name' 是 LinkTbl 中商品引用字段的数据库名称。
- return 'sys_idNOT IN' + linkedGoodsSysIDs.join(',')：这是关键部分。它返回一个标准的GlideRecord查询字符串。当 GoodsRef 字段的查找列表被打开时，ServiceNow会使用这个字符串来过滤 GoodsTbl，只显示那些 sys_id 不在 linkedGoodsSysIDs 列表中的商品。
- sys_idISNOTEMPTY：这是一个通用的查询，表示 sys_id 不为空，即显示所有记录。当没有已关联商品时，返回此值以确保所有商品都可选。

4. 效果验证

完成上述配置后：

在 NewLinkTbl 表单中，首先选择一个“用户名称”（UserRef）。
然后，点击“商品名称”（GoodsRef）字段的查找图标。
此时，弹出的商品列表将只会显示那些尚未与您在第一步中选择的用户关联的商品。

5. 注意事项与最佳实践

表名和字段名准确性： 在 ScriptIncludeJS 中使用的表名（如 x_1234_pro_0_linkedtbl）和字段名（如 user_name, goods_name）必须与您的ServiceNow实例中的实际数据库名称完全匹配。可以通过右键点击字段 -> “显示XML”或“配置字典”来确认。
性能考虑： 脚本包含在服务器端运行，通常比客户端脚本性能更优。但如果 LinkTbl 包含大量数据，并且 getNotLinkedGoods 方法执行的查询非常复杂，可能会对性能产生影响。确保查询条件优化，并考虑添加索引。
用户体验： 这种动态过滤机制显著提升了数据输入的准确性，减少了用户选择错误或重复关联的可能性。
错误处理： 在实际生产环境中，可以考虑在 ScriptIncludeJS 中添加更健壮的错误处理和日志记录机制，以便于调试和监控。
引用字段的显示值与实际值： current.user_name 如果 user_name 是引用字段，通常会传递其 sys_id。在 ScriptIncludeJS 中，如果您的 LinkTbl 中的 user_name 字段存储的是 sys_id，则直接使用即可。如果存储的是 UserName 字符串，则需要调整查询逻辑。本教程假设 user_name 和 goods_name 在 LinkTbl 中存储的是引用记录的 sys_id。