Workflows

Workflows guide a user through creating a working gateway service and its related configuration in the correct order. They are especially useful for first-time setup because the wizard links the entity, service, route, and optional usage limits.

Screenshot note: This should show the workflow creation screen where the workflow is named.

When to use Workflows

Use Workflows when you need to:

• view existing workflows;
• create a new workflow;
• resume an incomplete service setup;
• create an entity, service, and route as one guided process; or
• add optional daily and monthly limits before finishing.

Workflows list

The Workflows list shows the workflows available to your user. Use the search and table controls to find the workflow you need.

Screenshot needed

Add a screenshot of the Workflows table with row actions visible.

Complete the workflow

1. Open Gateway Configuration.
2. Select Workflows.
3. Start a workflow and give it a unique, descriptive name.
4. Select an existing Entity, or create a new one when the service belongs to a new customer or business scope.
5. Complete Create Service, including the upstream destination and protocol settings required by your service owner.
6. Complete Add Route so the gateway knows which incoming requests should reach the service.
7. Configure daily and monthly service limits if the service requires usage controls; otherwise follow the wizard's option to continue without them.
8. Review the final summary and confirm completion.

The progress indicator shows the current step. Complete required fields before selecting the next step; leaving a required value empty can prevent the workflow from saving.

Screenshot note: This should show the workflow saving or loading state.

Save, close, and resume

Select Save & Close when you need to leave before completing all steps. Confirm the save option in the exit dialog, then reopen the workflow from the list later. Do not assume that values typed into the current step are retained until the portal confirms that the workflow was saved.

If you choose to exit without saving, changes since the last successful save can be lost.

If a step fails to save

Read the message shown on screen and correct highlighted fields before trying again. Common causes include a duplicate workflow or resource name, a missing required selection, an invalid URL or identifier, and a dependent record that was changed in another session.

Screenshot note: This should show a workflow error message that appears when something needs to be corrected.

Screenshot note: This should show the error state that appears when the workflow cannot be saved.

What each stage creates

Field	Required	What to enter	Notes
Stage	Result	Check before continuing
---	---	---
Workflow Name	A saved container for the guided setup.	The name is unique and identifies the service or purpose.
Entity	Selects or creates the owner/scope.	The service belongs to the correct entity.
Create Service	Creates the upstream gateway service.	Protocol, host, port, path, and timeout values match the upstream system.
Add Route	Creates the incoming request match.	Hosts, paths, methods, protocols, and stripping/preservation options produce the intended public URL.
Limits	Optionally controls daily/monthly usage.	Values, units, recipients, and limit-reached action have been approved.

After completion, verify the records on the Entities, Services, Routes, and Service Limits pages. The workflow creates configuration; it does not replace connectivity and end-to-end API testing.

Note

Workflow options and permissions may differ by environment and user group. If a step is visible but its create action is unavailable, ask an administrator to check permission for the resource created by that step.

Screenshot note: This should show the workflow exit or confirmation screen.