将外部API与核心组件Forms中的可视规则编辑器集成

自适应表单中的可视化规则编辑器支持​ 调用服务 ​功能，使您能够通过为您的实例配置的表单数据模型(FDM)连接到外部API。 您可以将表单字段直接映射到服务的输入参数，并使用事件有效负载选项来映射输出参数。 可视规则编辑器还允许您根据服务的响应定义成功和失败处理程序的规则：成功处理程序处理成功的API调用，而失败处理程序管理错误。

这样，您就可以轻松地从表单发送API请求、处理API响应并在表单中动态显示或使用返回的数据。 它可确保自适应表单与外部系统或数据源之间的无缝集成。

在表单的规则编辑器中使用“调用服务”的优势

在自适应表单的规则编辑器中使用“调用服务”操作的优点很少：

为成功和失败响应调用服务处理程序

可视规则编辑器允许您基于其输出响应为​ 调用服务 ​操作创建成功和失败处理程序的规则。 下图描述了自适应表单的可视化规则编辑器中的​调用服务：

添加成功处理程序和失败处理程序

要添加成功或失败处理程序，请分别单击​ 添加成功处理程序 ​或​添加失败处理程序。

单击​ 添加成功处理程序 ​后，将显示​ 调用服务成功处理程序 ​规则编辑器，允许您指定规则或逻辑来管理操作成功时的​ 调用服务 ​输出响应。 即使不定义条件，您也可以指定规则；但是，您可以通过单击​ 添加条件 ​选项为成功处理程序添加条件。

您可以添加多个规则以处理​ 调用服务 ​操作的成功响应：

{width="50%,"}

同样，您可以添加规则以在操作不成功时处理​ 调用服务 ​输出响应。 下图显示了​ 调用服务失败处理程序 ​规则编辑器：

您还可以添加多个规则来处理来自​ 调用服务 ​操作的不成功响应。

在服务器​上启用错误验证}功能允许作者在设计要在服务器上运行的自适应表单时添加验证。

在规则编辑器中使用调用服务的先决条件

在规则编辑器中使用​ 调用服务 ​之前，必须满足以下先决条件：

通过不同的用例探索调用服务

可视规则编辑器的​ 调用服务 ​允许您执行若干有用的操作。 您可以使用此插件填充下拉选项、设置可重复或简单的面板以及验证表单字段，所有这些操作都基于​ 调用服务 ​的输出响应。 因此，可增强表单的灵活性和交互性。

下表描述了一些可使用​ 调用服务 ​的情况：

创建一个Get Information表单，该表单根据在Pet ID文本框中输入的输入检索值。 下面的屏幕截图显示了以下用例中使用的表单：

表单字段

将以下字段添加到表单：

NOTE

在表单字段的​ 属性 ​对话框的​ 绑定引用 ​字段中，选择 ，然后导航以选择您在表单数据模型(FDM)中添加的二进制属性。

配置面板

将面板设置为具有以下约束的重复面板：

您可以根据自己的需要调整重复面板的值。

数据源

在此示例中，Swagger Petstore API用于配置数据源。 已为getPetById服务配置表单数据模型，该服务根据输入的ID检索宠物详细信息。

让我们使用Swagger Petstore API中的addPet服务发布以下JSON：

{
        "id": 101,
        "category": {
            "id": 1,
            "name": "Labrador"
        },
        "name": "Lisa",
        "photoUrls": [
            "https://example.com/photos/lisa1.jpg",
            "https://example.com/photos/lisa2.jpg"
        ],
        "tags": [
            {
                "id": 1,
                "name": "vaccinated"
            },
            {
                "id": 2,
                "name": "friendly"
            },
            {
                "id": 3,
                "name": "house-trained"
            }
        ],
        "status": "available"
    }

规则和逻辑是使用​ 文本框上的规则编辑器中的 ​调用服务Pet ID操作实现的，用于演示上述用例。

现在，让我们详细探讨每个用例的实施。

用例1：使用调用服务的输出填充下拉值

此用例演示了如何根据Invoke Service的输出动态填充下拉选项。

实施

要实现此目的，请在Pet ID文本框上创建规则以调用getPetById服务。 在规则中，将enum添加成功处理程序photo-url中photoUrls下拉列表的​属性设置为。

输出

在101文本框中输入Pet ID以根据输入的值动态填充下拉选项。

用例2：使用调用服务的输出设置可重复面板

此用例演示如何根据​ 调用服务 ​的输出动态填充可重复面板。

注意事项

实施

在Pet ID文本框上创建规则以调用getPetById服务。 在​ 添加成功处理程序 ​中，添加另一个成功处理程序响应。 在规则中将tags面板的值设置为tags。

输出

在101文本框中输入Pet ID以根据输入值动态填充可重复面板。

用例3：使用调用服务的输出设置面板

此用例演示了如何根据​ 调用服务 ​的输出动态设置面板的值。

注意事项

实施

在Pet ID文本框上创建规则以调用getPetById服务。 在​ 添加成功处理程序 ​中，添加另一个成功处理程序响应。 在规则中将categoryname文本框的值设置为category.name。

输出

在101文本框中输入Pet ID以根据输入值动态填充面板。

用例4：使用调用服务的输出参数验证其他字段

此用例演示如何使用​ 调用服务 ​的输出来动态验证其他表单字段。

实施

在Pet ID文本框上创建规则以调用getPetById服务。 在​ 添加失败处理程序 ​中，添加失败处理程序响应。 如果输入的​ 不正确，请隐藏 ​提交Pet ID按钮。

输出

在102文本框中输入Pet ID，且​ 提交 ​按钮已隐藏。

用例5：在导航到调用服务中的操作时使用事件有效负荷

此用例演示了如何在​ 提交 ​按钮上配置规则，该按钮调用​调用服务，然后使用​ 导航到 ​操作将用户重定向到其他页面。

实施

在​ 提交 ​按钮上创建规则以调用redirect-api API服务。 此服务负责将用户重定向到​ 联系我们 ​表单。

您可以使用下面提供的JSON数据将API作为redirect-api API服务直接集成到规则编辑器中：

{
  "id": "1",
  "path": "/content/dam/formsanddocuments/contact-detail/jcr:content?wcmmode=disabled"
}

在​ 添加成功处理程序 ​中，配置​ 导航到 ​操作以使用​ 参数将用户重定向到 ​联系我们Event Payload页面。 在此，用户可以提交其联系详情。

（可选）将失败处理程序配置为在服务调用失败时显示错误消息。

输出

单击​ 提交 ​按钮时，将调用redirect-api API服务。 成功后，用户将被重定向到​ 联系我们 ​页面。

常见问题解答

问：如果我使用Invoke Service创建了规则，然后升级到核心组件的最新版本，会发生什么情况？

A：​升级到最新版本的核心组件时，调用服务​规则会自动更新到最新的用户界面，因为它向后兼容。

问：我是否可以添加多个规则来处理调用服务操作的成功或失败响应？

A：​是，您可以添加多个规则来处理​ 调用服务 ​操作的成功或失败响应。

相关文章

其他资源