SuperAPI AI 工具集

sn-sdk-fluent

编程与开发

查看项目

更新于 10-15 09:49

技能介绍

ServiceNow Fluent SDK 是一个基于 TypeScript 的 DSL,用于将应用元数据(sys_metadata)定义为代码。文件使用 .now.ts 扩展名,通过 now-sdk build 编译,并支持代码与 ServiceNow 实例之间的双向同步。所有 Fluent API 均从 @servicenow/sdk/core 导入。

用途: 该技能用于在涉及 ServiceNow Fluent DSL(.now.ts 文件)时,生成、审查或解释表、ACL、业务规则、UI 页面等元数据定义。

主要能力:

  • 提供参考文件,涵盖元数据类型、列类型、Now 全局对象、入门指南、项目结构、常见问题、CLI 参考等。
  • 提供示例资产,作为结构模板,包括表、ACL、业务规则、客户端脚本、脚本包含、UI 操作、UI 页面、REST API、流程等。
  • 定义硬性规则,确保代码生成和审查的准确性,例如:编写前阅读相关参考文件、仅使用文档化的 API、禁止使用 GlideRecord、必须从 @servicenow/sdk/core 导入、作用域前缀来自 now.config.json 等。
  • 提供构建与部署的预部署检查清单、部署序列、部署后验证步骤以及常见故障排除。
  • 针对生成、审查、解释 Fluent 代码分别给出具体步骤。

使用方式:

  • 生成 Fluent 代码时,需先收集作用域前缀、元数据类型和必填字段,阅读 references/metadata-types.md 和匹配的示例,然后按照示例结构编写代码。使用 Now.ID['descriptive_key'] 生成稳定 ID,使用 Now.include('./filename.ext') 引入外部脚本。表名、API 名和角色名需以 x_scope_ 为前缀(作用域来自 now.config.json)。
  • 审查 Fluent 代码时,阅读 references/metadata-types.md,对照参考检查每个字段和选项,标记不在参考中的选项、缺失的 $id、GlideRecord 使用以及从 @servicenow/sdk 的错误导入。
  • 解释 Fluent 代码时,阅读 references/metadata-types.md 的相关部分,对每个字段转述参考定义,对于 Now.ID、Now.include 或 script 标签问题,还需阅读 references/now-globals.md。
  • 构建与部署:运行 now-sdk auth --list 确认别名,保存所有 .now.ts 更改,运行 npm run build 成功后再运行 npm run deploy。部署后通过 sys_app.do 链接验证版本和状态。

适用场景: 适用于 ServiceNow 开发人员使用 Fluent SDK 定义应用元数据、生成或审查 .now.ts 文件、构建和部署 ServiceNow 应用等场景。

限制:

  • 不生成 ATF 测试代码,需引导用户至 github.com/ServiceNow/sdk-examples/tree/main/test-atf-sample。
  • 仅使用参考文件中记录的 API,不编造功能。
  • 禁止使用 GlideRecord。
  • 必须从 @servicenow/sdk/core 导入。
  • 作用域前缀必须来自 now.config.json,不可假设。
  • 部署前必须成功构建,并验证认证。
  • 其他未在资料中提及的功能、收费、价格、平台、效果或使用步骤暂未提供。