Overview
After a Custom Service is published, you can invoke it from a form using Form Actions.
The Invoke custom service action allows you to:
Execute reusable business logic from a form
Pass form data into a Custom Service
Receive returned values
Use the results in later action steps
Before using this action, make sure you have a published Custom Service.
For more information about Form Actions, see:
For information about creating and publishing Custom Services, see:
Add Invoke Custom Service Action
Before adding the Invoke custom service step, create or open a Form Action.
For more information about creating and configuring Form Actions, see:
Form Actions
Steps
Open the form you want to configure.
Open the Form Designer.
Click the Action icon in the top navigation bar.
Create a new action or open an existing action.
Click Add a step.
Select: Invoke custom service
Configure Invoke Custom Service Action
The Invoke custom service step includes:
Execution Condition
Service
After selecting a Custom Service, additional configuration sections will appear based on the variables defined in that service:
Connection variables
Input variables
Output variables
Configure Execution Condition
The Execution Condition controls when the Invoke custom service step is executed.
For more information, see:
Select Service
In the Service field, select the Custom Service you want to invoke.
The service selector displays available services from:
All
App (This application)
Shared
You can search for a service by name.
Only published Custom Services can be selected.
If you need to create or manage Custom Services, click Manage services.
You can also access Custom Services from:
Application Settings → Integrations → Custom services
For more information, see:
Configure Service Variables
After selecting a Custom Service, the configuration panel displays the variables defined in that service.
These variables are configured when creating the Custom Service and are used to pass data into the service and receive returned results.
The available sections include:
Connection variables
Connection variables provide connection information required by the Custom Service.
If the selected service does not require connections, this section will not display any variables.
Input variables
Input variables define the data passed from the Form Action to the Custom Service.
The available input variables depend on the selected Custom Service.
You can map form values to these inputs, including:
Form fields
Sub List fields
Other action outputs
Dynamic values
You can also use the Expression Editor to create dynamic values.
The Expression Editor allows you to:
Reference form data
Combine multiple values
Create dynamic expressions
Generate values required by the Custom Service
Configure Output Variables
Output variables store the values returned by the Custom Service.
The output variables are defined in the selected Custom Service.
After the Custom Service executes, returned values can be mapped and used by later Form Action steps.
Output values can be used for:
Updating form data
Passing values to another action
Generating notifications
Other follow-up actions
Add Additional Action Steps
Form Actions support multiple steps.
After invoking a Custom Service, you can add additional actions to continue processing.
For example:
Invoke custom service ↓ Next action ↓ Complete form action
The output from the Custom Service can be used by following steps.
For more information about adding and managing Form Action steps, see:
Save and Publish Form Action
After configuring the Invoke custom service step:
Save the Form Action.
Test the form behavior if needed.
Publish the form.
The Custom Service will execute when the configured Form Action is triggered.
Troubleshooting
The Custom Service is not available
Check that:
The Custom Service has been published.
You have permission to access the service.
The service exists in the current application or has been shared.
Input variables cannot be mapped
Check that:
The selected Custom Service has the required input variables.
The form contains available values.
The value type matches the input variable type.
Output values are empty
Check that:
The Custom Service returns output values.
Output variables are mapped correctly.
The service execution completes successfully.