Comment on page
Workflow Deployment
Edit your operationalized workflows by switching from Live to Draft mode
Cascade workflows are often used in operational, productionized ways. For example, your workflow may be scheduled to import and transform records from a live database, every night. This kind of automation makes it risky to edit or change a workflow, for fear of a pending schedule. To alleviate this anxiety, Cascade workflows can be placed into Draft mode or Live mode to suit the need.
Switch to Draft mode, edit your workflow without affecting schedules and data apps.
In short, workflow deployment is version control for your operational workflows. It will allow you to tinker in Draft Mode. Then, when your workflow is perfect, you can deploy an updated version as you see fit.
Live Mode
The default setting for a new workflow, Live mode, will deploy changes as you make them.
- Any dependent elements, like Data Apps or Dynamic Workflows, will interact with your most recent revision to the workflow
If your workflow does not have triggers (Schedules, Webhooks) or dependent elements (Data Apps, Dynamic Workflows), we recommend working in Live mode.
Draft Mode
Put your workflow into Draft mode, by flipping the switch in your top-nav from Live to Draft. You are now working on a draft version of your workflow that is detached from your triggers and dependent elements.
- Dependent elements, Data Apps or Dynamic Workflows, will interact with a previously deployed version of the workflow.
When in Draft mode, deploy any updates or changes by clicking the "Deploy" button in the top-nav. Likewise, you can switch back to Live mode to deploy your workflow. This will point any triggers or dependent elements at the new, recently deployed version of the workflow.
If your workflow has Daily/Hourly Schedules or a connected Data App, you may want to work in Draft mode when you are editing or making updates.
When initially building an operational workflow, you will most likely want to work in Live mode. In fact, we recommended working in Live mode right up until the moment you create a dependency on that workflow. Dependencies include Schedules, Webhooks, Data Apps, and Dynamic Workflows.
In short, if triggers or dependent elements rely on your workflow, you may be best off working in Draft mode. Here's a few examples of workflows that would call for Draft mode:
- This workflow runs when pinged by a Webhook, I don't know when it might be pinged... but I need to update/edit it
- My workflow powers a Data App that partner-users are expecting to see... but I need to update/edit it
- This workflow is linked to another workflow, it is a Dynamic Workflow, and other workflows depend on it... but I still need to update/edit it
Let's assume you've built a three step workflow: 1) it imports from an integration, then 2) transforms it, and finally 3) it publishes the results back to a database. Let's also assume you have added a schedule, triggering this workflow to run every day.
We'd like to make some edits to our transformation logic. However, we have partners looking at the published data and don't want to disrupt the previously scheduled workflow run.
A hypothetical situation, user has a workflow that is triggered by a schedule.
Here's what you can do:
- From the top nav, flip the switch from "Live" to "Draft". The canvas will load in Draft mode and a new "Deploy" button will appear in the top-nav.
- Does it look like graph-paper? Good. You're in Draft mode.
- Your schedule is now interacting with the previous version of the workflow
- In Draft mode you are free to edit, update, revise. Let's imagine you add new transformation to the same workflow while you are in Draft mode.
- When editing in Draft mode, your workflow should behave as it normally would. Add tools, run it, build a Data App... should be familiar.
- Once you have made your updates, you are ready to deploy. Clicking the "Deploy" button will update your deployed version, which will connect to any triggers or dependent elements.
- Triggers (Schedules, Webhooks) will now respond to the newly deployed version
- Dependent elements (Data Apps, Dynamic Workflows) will now respond to the newly deployed version.
In Draft mode, user makes edits, deploys their new version, then returns to Draft mode.
- From here, you may choose to remain in Draft mode, deploying only when you are satisfied with changes and updates made.
- This is an ideal way to treat an operational workflow.👍
- Alternately, you may return to Live mode by flipping the switch in the top-nav to "Live".
- in Live mode your changes are continuously deployed, which may have an unintended impact on triggers and dependent elements.⚠
Hint: When working in Draft mode you are responsible for your own deployment. If changes aren't taking affect, ask yourself... have I deployed recently?
Teams working in Cascade can collaborate on the same workflow, adding tools side-by-side, in the same canvas. All collaborating team members must work within the same mode, either Draft or Live. When one team member switches deployment mode, other members will be notified and asked to switch modes accordingly.
Last modified 1yr ago