Skip to main content

介绍

Client API 是什么​

在企企的表单系统中，为了满足用户个性化业务需求。我们的低代码平台需要提供可编程能力。目前我们提供的可编程能力分为后端脚本编程和前端脚本编程。这篇文章是前端脚本编程指南。后端编程指南请参考 JSF函数开发说明。

Client API 是和企企管理系统集成的在线脚本语言。它使我们的用户能够逐步向应用程序添加逻辑，使其更加强大和健壮。在 脚本编写时，整个数据库层是被高度抽象的，你不需要了解数据库相关技能，只需要通过表单和字段就可以完成编程。

Client API 是采用 Javascript 语言提供的。

为什么要使用 Client API？​

在一个模型驱动的应用形式中，客户端脚本不应该是应用自定义业务流程逻辑的首选方案。在我们对象和字段管理功能的自定义规则中为不了解 JavaScript 且不是开发人员的人提供了一种更好使用的方法方法以应用业务流程逻辑。

然而，在发现 自定义规则 不能满足用户业务需求的时候，您会发现使用客户端 API 对象模型的客户端脚本提供了一种强大的方法来扩展应用程序的行为并在客户端中启用自动化。

在模型驱动的应用中使用客户端脚本​

模型驱动应用中的表单有助于向用户显示和编辑数据。模型驱动应用程序中的表单可以包含字段和表格等项目。您可以将 JavaScript 代码附加到表单事件的 “响应”中，以便在表单上发生事件时执行代码。

同时，模型驱动的应用程序为您提供了丰富的客户端API，以与表单对象和事件进行交互，以控制在表单上显示的内容和何时显示：

  • 执行表单动作

    • 表单加载时动态修改表单内容。添加和编辑行时都可以修改表单内容。
    • 在持久化之前验证表单数据。例如，在招聘申请中，只接受具有两年以上经验的申请人。

  • 执行字段动作

    • 每当表单中的字段值发生更改时，动态修改表单内容。例如，在问题跟踪应用程序中，仅显示属于在模块选项列表字段中选择的模块的团队成员。

  • 创建复杂的过滤规则

    • 你可以在运行时根据不同的业务需求，给一个关联对象增加条件来仅显示特定记录。比如，在企企提供的系统单据的一些关联字段条件（比如报销单中的项目）的系统过滤条件也许不满足用户的特殊要求。

如何创建一个前端脚本？​

  • 登录我们的企企应用后，如果你的企业开通了开发者权益并且你也被授予了 开发者角色。那么你登录系统后，在这里可以切换到开发者环境。

img.png

  • 切换到开发者环境后，进入 对象和字段 功能 ，找到我们希望创建脚本的业务对象。点击操作列中配置，进入到对象配置页面。如下图：

    img

  • 在对象配置页面中，找到 前端脚本 页签，点击列表右上角的 新增 按钮，开始创建脚本。

    img

    这里可以看到，运行时机有四个：输入脚本名称后，点击 创建脚本。创建脚本成功后，会自动进入脚本代码编写界面。关于代码编写的细节，在下面的 开发指南 中有详细说明。

    • 新增或编辑：表示业务对象在新增表单或者编辑一个已存在表单时，该脚本会加载运行。

    • 新增：表示业务对象仅在新增表单时，该脚本会加载运行。

    • 编辑：表示业务对象仅在编辑一个已存在表单时，该脚本会加载运行。

    • 查看：表示业务对象仅在浏览查看一个已存在表单时，该脚本会加载运行。

  • 创建脚本的时候，脚本默认是没有发布的。只有发布了的脚本才会在表单中生效。要发布脚本，需要进入前端脚本页签，执行脚本列表操作列中的 发布 或者在脚本编辑器中点击 “发布” 按钮。

s

脚本编写的时候，每隔 5 秒钟会自动保存编写的代码，避免丢失。你也可以在编写代码过程中通过热键：Ctrl/Cmd + S 保存。