How do I edit a workflow?

Purpose

Use this procedure to modify a workflow.

When you put a workflow into DRAFT status to edit it, it is locked for your edits. Other users can’t modify the workflow, or see the changes being made. When the workflow is PUBLISHED, it’s no longer locked.

If any schedules or executions are running at the time you put the workflow into Draft status, they are completed according to the last published version of the workflow. That is, the executions are not affected by your changes.

Workflows that are imported from GitHub and signed workflows cannot be edited. You can clone these workflows and make changes but the cloned versions are not signed.

You must have write privileges for the workflow you want to modify.

Steps
 

Open Workflows, All Workflows.


Open the Definition page of the workflow:

  1. Click on a workflow and choose png1.png (Table row actions), Definition.

  2. Double-click on a workflow and choose Definition from the Info drop-down list.


Change the workflow state to Draft:

  1. Click png15.pngModify State.

  2. In the form that opens, choose Draft and click UPDATE.


In the YAML (DRAFT) tab, make changes as needed.

You can click on the PUBLISHED tab at any time to see the previous published YAML description.


Click VALIDATE & UPDATE FLOW.

If the validation fails, fix any problems and validate again.


When the validation succeeds, click PUBLISH to publish the edited workflow, or SAVE DRAFT to keep it in DRAFT status.


When you complete your edits and publish the workflow, check to see if any schedules or Kafka triggers are affected by your changes. For example, if you added a parameter to a workflow, any schedules that run the workflow must be updated to provide input for the new parameter.

End of steps