Skip to content

How to Edit a Workflow Step

First: learn the workflow before you change it

When a form change requires touching its workflow, brief yourself on that workflow first — its trigger, steps, and branching — instead of editing blind. Run:

versaa-rag\.venv\Scripts\python.exe versaa-rag\ms_workflow_info.py "<workflow name>"

It prints the live structure (trigger message → ordered steps with type + key params → each step's transitions, including the XPath branch conditions) plus a runtime summary of recent instances. Add --structure-only, --version latest, --local (offline, from extracted XML), or --sample errored to drill into a failing run. A partial name lists matching workflows. Full endpoint detail: platform/management-studio-api.md §5.

Key Things to Know

  • Each step can only be executed once per workflow instance.
  • Changes to step properties can affect workflow execution — validate after every change.
  • Back up the workflow before making significant changes (export a package before editing).

Step-by-Step

  1. Open the Workflow Designer in Management Studio.
  2. Navigate to and open the workflow.
  3. Click the specific step you want to edit.
  4. In the Properties Editor, update:
  5. Category — categorises the step
  6. Name — reflects the step's function/purpose
  7. Any other relevant properties
  8. Save the workflow.
  9. Validate — use the validation feature to check for errors.
  10. Test — trigger a form submission and verify the step fires correctly.

Quick Tips

  • Back up before significant changes (export a package).
  • Review adjacent steps for compatibility before editing.
  • Use Undo/Redo if you make a mistake.
  • Always validate after editing — don't leave unvalidated changes.