Overview
After a Custom Service is published, you can invoke it from a Workflow using the Invoke custom service action.
This allows workflows to:
Execute reusable business logic
Pass workflow data into a Custom Service
Receive returned values
Use the results in subsequent workflow steps
Before using this action, make sure you have a published Custom Service.
For information about creating and publishing Custom Services, see:
Add Invoke Custom Service Action
You can add the Invoke custom service action from the Workflow Designer.
Steps
Open the workflow you want to configure.
Open the Workflow Designer.
From the left action panel, go to:
Integration → Invoke custom service
Drag the Invoke custom service action into the workflow.
After adding the action, configure the service settings.
Configure Invoke Custom Service Action
The configuration panel includes:
Action name
Description
Service
Connection variables
Input variables
Output variables
Action Name
Enter a name for the workflow action.
The action name helps identify this step in the workflow.
Description
Add an optional description to explain the purpose of this action.
Select Service
In the Service field, select the published Custom Service you want to invoke.
The service selector displays available services from:
This application: Custom Services created in the current application.
Shared: Custom Services shared from other applications.
You can use the search box to quickly find a service.
Only published Custom Services can be selected and invoked in a workflow.
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.
The available variable types include:
Connection variables
Input variables
Output variables
These variables are configured when creating the Custom Service and are used to pass data into the service and receive returned results.
Configure Connection Variables
If the selected Custom Service requires external connections, the required Connection variables will be displayed.
Connection variables are defined in the Custom Service and provide the required connection information when the service is executed.
Configure the required connection values before running the workflow.
If the service does not require connections, this section will remain empty.
For more information about Connection variables, see:
Configure Input Variables
Input variables define the data passed from the Workflow to the Custom Service.
The input variables displayed here are defined in the selected Custom Service.
When a Custom Service is created, its required input variables are configured in the service settings. The Workflow then provides values for these inputs when the service is invoked.
You can provide input values in two ways:
Map Existing Workflow Values
You can map existing workflow data to the Custom Service input variables.
Available values may include:
Form fields
Data List fields
Workflow variables
Attachments
Previous action outputs
Use Expression Editor
If the required value needs to be generated dynamically, you can use the Expression Editor.
The Expression Editor allows you to:
Reference workflow data
Combine multiple values
Create dynamic values
Build custom input logic
Make sure all required input variables are mapped before publishing the workflow.
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 service execution completes, returned values can be mapped to workflow variables and used in later workflow steps.
Output values can be used for:
Updating Data Lists
Conditions
Notifications
Other workflow actions
Workflow Execution
When the workflow reaches the Invoke custom service action:
The workflow passes the configured input values to the Custom Service.
The Custom Service executes the defined logic.
The service returns output values.
The workflow continues using the returned results.
Place the action at the appropriate position in the workflow based on when the Custom Service needs to be executed.
Publish Workflow
After configuring the Invoke custom service action:
Save the workflow.
Test the workflow if needed.
Publish the workflow.
The Custom Service will execute automatically when the workflow reaches this action.
Troubleshooting
The Custom Service is not available in the Service list
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 with the application.
Input variables cannot be configured
Check that:
The selected Custom Service has the required input variables.
The workflow provides available values.
The value type matches the input variable type.
The workflow stops when invoking the Custom Service
Check that:
Required input values are provided.
The Custom Service works correctly in TEST RUN.
The service logic returns the expected output.
Output variables are empty
Check that:
The Custom Service returns output values.
Output variables are mapped correctly.
The service execution completed successfully.