Automation Platform Tasks

Workflow Definition—create new or edit existing workflow definition

2 minute read

To create a new workflow definition

Enter information into the fields as follows:

Field NameDescription

Name

Enter a unique workflow definition name of your choice. You may want your workflow definition name to reflect the project where it belongs or its purpose. For example, you might set a name based on a product or team using this workflow.

Description

(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with <html> …​ </html> tags. Allowable HTML tags are <a>, <b>, <br>, <div>, <dl>, <font>, <i>, <li>, <ol>, <p>, <pre>, <span>, <style>, <table>, <tc>, <td>, <th>, <tr>, and <ul>.

For example, the following HTML:

<p>
<span style="font-family: Arial;">
  <i>Note:</i> For more information about the <b>abc</b> object, see
         <a href="https://www.google.com/">\https://www.google.com</a>.
</span>
</p>

renders as follows:

_Note:_ For more information about the *abc* object, see \https://www.google.com.

Workflow Name Template

This is the template used to determine the default name of jobs launched from the workflow definition. For example:

$$[/increment /myproject/workflowCounter]$[/timestamp]

(substitute your values for the names above)

Produces a workflow name like:

projectFoo_123_20140102130321

Enter any combination of elements to create workflow names more meaningful to you. For example, you could choose to include the build number.

CloudBees does not recommend using the CloudBees Flow-generated workflowId because it is no longer a human-readable integer so it does not provide any identifiable information and cannot be used as a counter.

Click OK to save the information you entered.

Your new workflow definition will appear on the Project Details > Workflow Definitions page.

To edit an existing workflow definition

  1. To rename the workflow definition, type a new name in the Name field and click OK.

  2. Change or add to the description or modify the template.

  3. Click OK when your edits are complete.