Workflows
Last updated
Last updated
This guide covers how to deploy, test, and manage workflows on the Dynamiq platform. It provides instructions on creating deployments, using workflows via API, tracking and tracing operations, and reviewing deployment history.
Navigate to the Deployments tab:
From the main navigation menu, select Deployments.
In the Workflows section, click Deploy a workflow to deploy the workflow.
Select deployment type:
In the side panel, choose Workflow. This option allows you to deploy workflows and integrate them into your application using API.
Configure the workflow deployment:
Name: Assign a meaningful name to your deployment to help identify it in the future.
Description: Optionally, add a description for better context on the deployment's purpose.
Source Workflow: Select the workflow you want to deploy from the dropdown menu.
Source Version: Choose the version of the workflow to deploy. This helps manage different workflow iterations and ensures consistent deployment.
Runtime: Choose the appropriate runtime version. The platform will default to the latest version if not specified.
Create Deployment:
Once configured, click Create to deploy the workflows. The new deployment will be listed under Deployments with its status and details.
Once your workflow is deployed. Go to the Endpoint tab. You will see a Python code example to interact with it. The provided code sample illustrates how to make a request to the endpoint, including options for configuring request headers, payload, and handling streaming responses if enabled.
All workflow deployments are private. You will need to use the access key to access the deployment. The example code snippet in the Endpoint tab shows how to include the authorization token using DYNAMIQ_ACCESS_KEY environment variable.
Navigate to the Test tab within the deployment details. This interface allows you to interact with the deployed workflow by sending inputs and viewing responses directly in the UI.
In the Input section of the Test tab, you can provide a JSON object to simulate data being sent to the workflow's endpoint. This input should follow the expected schema defined by your workflow. Once you’ve entered the input data:
Click Run: This triggers the workflow to process the input and returns the result.
Observe the Output: The Result section displays the JSON output generated by the workflow.
The platform provides a real-time response, allowing you to iteratively test various inputs and review how the workflow handles them.
