Workflow: Publish a Workflow

Use this action to publish a draft version of a Workflow. When a draft version is published, the existing published version is turned into its own draft. You must have Any user with build permissions for any Workflow you attempt to publish.

This action must be added to any approval Workflow you use with publish control requests. If you do not include this action in your publish control approval Workflow, drafts will not be published. See Using this action with publish control or the complete Require approval to publish a Workflow article for more information.

How to configure this action

If you use this action with publish control, you can reference three unique fields, and must select the Workflow by ID during configuration. See Using this action with publish control for more information.

Fields for this action

  • Workflow

    • Enter the Workflow ID of the Workflow to publish. You can select a Workflow by name, ID, or field.
    • If using this action with publish control, select Use Workflow via field and manually enter {{workflow-id}}. See Using this action with publish control for more information.
  • Output Field Prefix

    • To help keep output fields organized, choose an output field prefix to add to the beginning of each output field name as this action may output more than one field.
    • The step’s name is used as the prefix by default.

Using this action with publish control

If you use this action with the publish control feature, you have access to three unique fields.

Available Fields

  • Requesting User

  • Root Workflow ID

    • If available, the Workflow ID of the published version of the Workflow. Because of how Version Control works in Catalytic, each Workflow version has a unique ID. The Root Workflow ID here is the unique ID assigned to the Workflow when it is first created. Learn more about the Root ID.
  • Workflow ID

note
  • Note: The field picker does not display these unique fields, but they can still be referenced. If the field is not in the picker, type the field reference manually using the {{field-reference-name}} format. See How to manually type a field reference when using these fields.

What will this output?

This action will publish the selected Workflow and following fields.

This action may generate multiple fields. To help keep output fields organized, the prefix above will be added to the beginning of each of the output field names, separated by two dashes. Each field will result as:{{output-field-prefix--output-field}}. Learn more

Output fields for this action

  • Active Workflow ID

    • The Active Workflow ID is the historical ID of the draft version that was just published. When a draft is published, the ID is updated to the Root Workflow ID. The next time a draft is published, the prior published version will revert back to this ID.
  • Root Workflow ID

    • The Root Workflow ID here is the unique ID assigned to the Workflow when it is first created. This is the ID that points to the currently published version.
  • Previous Workflow ID

    • The Previous Workflow ID is the ID for the Workflow
    • When a draft version is published, the prior published version is turned into a draft. The Previous Workflow ID is the ID for that new draft.

Get help with a problem or question

If something’s not working as expected, or you’re looking for suggestions, check through the options below.

I am getting a fix task that the Workflow “is already active”

You cannot publish an already published Workflow. This error is common when using the Use Workflow by name option when setting the Workflow ID during configuration—if you select the Workflow by name, you always select the currently published version.

To publish a draft version, you must use the specific ID for the draft version.

Sorry about that. What was the most unhelpful part?









Thanks for your feedback

We update the Help Center daily, so expect changes soon.

Link Copied

Paste this URL anywhere to link straight to the section.

Need more help?

If you're signed in to Catalytic Community, you can ask other users a question. You'll be redirected to Community where you can add more info.