Documentation AEM as a Cloud Service User Guide

Using Invoke Service in the Visual Rule Editor for forms based on Core Components

Last update: April 17, 2025

Applies to:
Experience Manager as a Cloud Service

CREATED FOR:

Beginner
Intermediate
User
Developer

The Visual Rule Editor in an Adaptive Form supports the Invoke Service feature, which allows you to select a service from the list of Form Data Models (FDM) configured for your instance. You can map form fields directly to the input parameters of the service. To map form fields to the output parameters, use the event payload option for the specified Form Data Model service. Additionally, the Visual rule editor allows you to create rules for success and failure handlers for Invoke Service operations based on its output responses. Success handlers manage the successful execution of the Invoke Service operation, while failure handlers address any errors that occur.

Advantages of using the Invoke Service in the form’s rule editor

Here are few advantages of using Invoke Service operation in the rule editor of an Adaotive Form:

Streamlined integration: Visual Rule Editor simplifies the process of integrating external services or APIs into your Adaptive Forms. By using the Invoke Service, you can easily connect forms to various data sources and services without the need for complex coding, making form integration more efficient.
Dynamic response handling: You can manage success and error responses based on the output responses of the Invoke Service, allowing forms to react dynamically to different scenarios. It ensures forms handle various conditions appropriately, improving flexibility and control.
Enhanced user interaction: Using the Invoke Service in the rule editor enables real-time validation within your forms, providing a better user experience. It also ensures that data is accurately validated on the server side, reducing errors and improving form reliability.

Invoke Service handlers for success and failure responses

NOTE

You can use the Invoke Service success and failure handlers only for forms based on core components. Forms based on foundation components do not support Invoke Service success and failure handlers.

Visual rule editor allows you to create rules for success and failure handlers for Invoke Service operations based on its output responses. Below image depicts the Invoke Service in Visual rule editor for an Adaptive Form:

Invoke service handlers

To add success or failure handler, click Add Success Handler or Add Failure Handler, respectively.

When you click Add Success Handler, the Invoke Service Success Handler rule editor appears, allowing you to specify rules or logic to manage the Invoke Service output response when the operation is successful. You can specify rules even without defining conditions; however, you can add conditions for the success handler by clicking the Add Condition option.

Invoke service success hadler

You can add multiple rules to handle successful responses for the Invoke Service operation:

Multiple success handler

Similarly, you can add rules to handle the Invoke Service output response when the operation is not successful. The image below displays the Invoke Service Failure Handler rule editor:

Invoke service failure hadler

You can also add multiple rules to handle unsuccessful responses from the Invoke Service operation.

The Enable Error Validation on Server feature allows validations added by the author while designing an Adaptive Form to run on the server also.

Prerequisites for using the Invoke Service in the rule editor

Below are the prerequisites you must satisfy before using Invoke Service in the rule editor:

Make sure you have configured a data source. For instructions on configuring a data source, click here.
Create a Form Data Model using the configured data source. For guidance on creating a Form Data Model, click here.
Ensure that Core Components are enabled for your environment. For detailed instructions on how to enable Core Components for your environment, click here.

Exploring Invoke Service through different use cases

The Visual rule editor’s Invoke Service allows you to perform several useful operations. You can use it to populate dropdown options, set repeatable or simple panels, and validate form fields, all based on the output response of the Invoke Service. Thus, enhancing the flexibility and interactivity of your forms.

The table below describes a few scenarios in which the Invoke Service can be used:

Use Case

Description

Populate dropdown options using output of Invoke Service

Populates dropdown options dynamically based on data retrieved from the Invoke Service output. Click here, to see the implementation.

Set repeatable panel using output of Invoke Service

Configures a repeatable panel by using data from the Invoke Service output, allowing for dynamic panels. Click here, to see the implementation.

Set panel using output of Invoke Service

Sets the content or visibility of a panel using specific values from the Invoke Service output. Click here, to see the implementation.

Use output parameter of Invoke Service to validate other fields

Uses specific output parameters from the Invoke Service to validate the form fields. Click here, to see the implementation.

Create a Get Information form that retrieves values based on the input entered in the Pet ID text box. The screenshot below shows the form used in these use cases:

Get information form

Form Fields

Add the following fields to the form:

Enter Pet ID: Textbox
Select Photo URLs: Dropdown
Tags: Panel
- Name: Textbox
- ID: Textbox
Category: Panel
- Name: Textbox
Submit: Submit button

NOTE

In the Bind Reference field in the Properties dialog of the form fields, select

and navigate to select the binary property you added in the Form Data Model (FDM).

Configuring panels

Set the panels as repetitive with the following constraints:

Minimum value: 1
Maximum value: 4

You can adjust the values of the repetitive panels to suit your requirements.

Data source

In this example, the Swagger Petstore API is used to configure a data source. The Form Data Model is configured for the getPetById service, which retrieves pet details based on the entered ID.

Let’s post the following JSON using the addPet service in the Swagger Petstore API:

{
        "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"
    }

Rules and logic are implemented using the Invoke Service action in the rule editor on the Pet ID textbox to demonstrate the mentioned use cases.

Let’s now explore the implementation of each use case in detail.

This use case demonstrates how to populate dropdown options dynamically based on the output of an Invoke Service.

Implementation

To achieve this, create a rule on the Pet ID text box to invoke the getPetById service. In the rule, set the enum property of the photo-url dropdown to photoUrls in Add Success Handler.

Set drop-down value

Output

Enter 101 in the Pet ID text box to dynamically populate the dropdown options based on the entered value.

Result

Use Case 2: Set repeatable panel using output of Invoke Service

This use case demonstrates how to populate repeatable panels dynamically based on the output of an Invoke Service.

Considerations

Ensure the name of the repeatable panel matches the parameter of the Invoke Service for which you want to set the panel.
The panel repeats for the number of values returned by the corresponding Invoke Service field.

Implementation

Create a rule on the Pet ID text box to invoke the getPetById service. In Add Success Handler, add another success handler response. Set the value of the tags panel to tags in the rule.

Create rule for repeatable panel

Output

Enter 101 in the Pet ID text box to populate the repeatable panel dynamically based on the input value.

Output

Use Case 3: Set panel using output of Invoke Service

This use case demonstrates how to dynamically set the value of a panel based on the output of an Invoke Service.

Considerations

Ensure the name of the panel matches the parameter of the Invoke Service for which you want to set the panel.
The panel repeats for the number of values returned by the corresponding Invoke Service field.

Implementation

Create a rule on the Pet ID text box to invoke the getPetById service. In Add Success Handler, add another success handler response. Set the value of the categoryname text box to category.name in the rule.

Create rule for repeatable panel

Output

Enter 101 in the Pet ID text box to populate the panel dynamically based on the input value.

Output

Use Case 4: Use output parameter of Invoke Service to validate other fields

This use case demonstrates how to use the output of an Invoke Service to dynamically validate other form fields.

Implementation

Create a rule on the Pet ID text box to invoke the getPetById service. In Add Failure Handler, add a failure handler response. Hide the Submit button if an incorrect Pet ID is entered.

Failure Handler

Output

Enter 102 in the Pet ID text box, and the Submit button is hidden.

Output

Frequently asked questions

Q: What happens if I have created a rule using the Invoke Service and then upgrade to the latest version of the core components?

A: When you upgrade to the latest version of the core components, the Invoke Service rule automatically updates to the latest user interface, as it is backward compatible.

Q: Can I add multiple rules to handle successful or failure responses for the Invoke Service operation?

A: Yes, you can add multiple rules to handle successful or failure responses for the Invoke Service operation.

Additional resources

recommendation-more-help

Using Invoke Service in the Visual Rule Editor for forms based on Core Components

Advantages of using the Invoke Service in the form’s rule editor

Invoke Service handlers for success and failure responses

Prerequisites for using the Invoke Service in the rule editor

Exploring Invoke Service through different use cases

Use Case 1: Populate dropdown values using the output of Invoke Service

Implementation

Output

Use Case 2: Set repeatable panel using output of Invoke Service

Considerations

Implementation

Output

Use Case 3: Set panel using output of Invoke Service

Considerations

Implementation

Output

Use Case 4: Use output parameter of Invoke Service to validate other fields

Implementation

Output

Frequently asked questions

Related articles

Additional resources