This page displays workflow definition components, including state and transition definition names, types, actions, descriptions, and various links to create additional transitions and state definitions, define access control, run the workflow, and so on. You can view any previously defined workflow objects and create new properties too.
When you open the Graph view, your first glance at this page should appear similar to the following:
Links and actions on the graph view:
-
Above the Workflow Definition Details page title you see (in this example) "Project: Upgrade-End to End". This breadcrumb information tells you which project you are viewing or working with and provides a link back to the project, itself.
-
Immediately after the page title, you see "workflow_9", which (for our example) is the name of this workflow.
-
Track Changes:
Select to open the Change History page. -
Run:
Select to run the workflow definition. Hover over the drop-down arrow to review these choices:-
Run: Allows you to pick the "starting state" to run the workflow. After selecting OK from the Run Workflow dialog, the Run Workflow page is displayed. If you previously created parameters for this workflow, they are also displayed. You can accept the parameter values or change them before running the workflow.
-
Run Immediately: This option uses the first, default, "starting state" to run the workflow.
Selecting Run, without using the down-arrow to make a selection, is the same as selecting Run Immediately. -
Edit: Select to go to the Edit Workflow Definition page to make any necessary changes.
-
-
Access Control: Select to set privileges for this workflow definition. For details, refer to Access control.
-
The star icon allows you to save this workflow definition to your home page.
Navigation and view summary
Each button has its own expanded description section following this summary.
-
Graph: The page opens in this view. The main portion of this view contains the work area for visually creating your workflow.
-
List: This view provides a table displaying states, transitions, and so on in list form.
-
Properties: this view provides a table displaying previously created properties and provides links to create additional properties.
-
Show Legend: Displays a legend for workflow objects.
-
Create State: This button produces the State Definition panel where you can create new states as you build or modify your workflow.
-
The multi-square directional icons allow you to change your workflow graph from vertical to horizontal, depending on how you choose to see the graph.
-
The drop-down menu for percentages allows you to diminish or expand the workflow graph size.
Graph view
To create a workflow, minimally you need to create state definitions and transition definitions. Optimally, those objects have parameters and properties, and you will want to create or enforce access control and perhaps create one or more email notifiers too. To begin, the following sections describing functionality in this view will familiarize you with how to create workflow objects and end with exploring the graph’s quick-access features.
Select Create State to create a new state using the State Definition panel.
You can use the DSL Export 
button to download the objects as a DSL file.
Create a new state
After selecting Create State, enter information in the State Definition panel as follows:
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
|
| Field Name | Description |
|---|---|
Name |
(Required) Provide any name of your choice. The name must be unique to this workflow definition. If you do not provide a name, a system-generated name is created: New State, New State 2, and so on. |
Description |
(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with
|
Startable |
Select this checkbox if you want this state to be your workflow "starting" state. The first state in any workflow definition is saved as Startable, but you can change this later. |
Select OK and the State Definition panel provides options to configure your new state definition.
Configure the new state definition
In the State Definition panel, the state name appears at the top. Configure the following settings.
Links at the top of the panel
-
Access Control: Use this link to add or modify access control privileges for this state (link not illustrated in the State Definition panel example above).
-
Edit: Use this link to modify this state’s name, description, or whether the state is Startable.
-
View in list: Displays the List view to see the state definition in the Workflow Definition Details table. This state will be highlighted in the List view.
-
Create Transition: Displays the Transition Definition panel to create a transition for this state.
Action
As each state in a workflow becomes active, it performs an action. The state’s action can be to create a job from a procedure or to start a workflow from a workflow definition. When the job or called workflow completes, On Completion transitions are evaluated to see if the workflow should change to a different state, possibly based on the outcome of the action.
Selecting No action, Procedure, or Workflow changes the fields that appear under these choices.
-
No action: If selected, no other information is required. Select OK.
-
Procedure: This selection displays the following fields:
-
Current: This selection refers to the project that contains the workflow definition.
-
Project: If selected to call a different project, start typing in the text box to display a list of (non-plugin) projects from which to select. Only the first 10 matches are displayed. Type more characters to refine the list.
-
Plugin: If selected, start typing in the text box to display a list of plugin projects from which to choose. Only the first 10 matches are displayed. Type more characters to refine the list.
-
Procedure: Start typing in this field to see a list of available procedures from which to select, depending on your previous choice of Current, Project, or Plugin. Only the first 10 matches are displayed. Type more characters to refine the list.
-
Workflow: This selection displays the following fields:
-
Similar to selecting Procedure (above), select Current, Project, or Plugin.
-
Workflow: If selected to call another workflow definition, start typing in this text box to display a list of workflow definitions from which to choose. Only the first 10 matches are displayed. Type more characters to refine the list.
-
Starting State: Start typing in this field to see a list of available starting states definitions in the workflow definition you selected. Only the first 10 matches are displayed. Type more characters to refine the list.
After selecting the procedure or starting state, press the TAB key to leave the field and view a list of parameters for the selected action. After entering any procedure values, select OK to save the changes.
Notifiers
Select this tab to see a list of email notifiers previously created for this state definition or to create an email notifier. Notifiers are commonly used to inform interested parties about transitions to the state being defined.
| Before you can set up an email notifier, you need an email configuration. If you have not already defined an email configuration, you can do it now. Go to Administration > Email Configurations and select the Add Configuration link. |
The Notifiers table contains a list of all previous created notifiers for this state definition.
Column descriptions
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
|
| Column Name | Description / Actions |
|---|---|
Name |
The name of the email notifier. Select a name to go to the "edit" page for that notifier if you need to make changes. |
Type |
The type of email notifier specified during creation. |
Description |
(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with
|
Actions |
Delete: Use this link to delete the notifier on that row. |
To create an email notifier, select the Create Notifier link to access the Email Notifier panel.
Enter information into the fields as follows:
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
|
| Field Name | Description |
|---|---|
Name |
(Required) This name can be any text string you choose. The name must be unique among other notifier names in this project, on procedures or workflow definitions called from other projects. |
Description |
(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with
|
Type |
Use the pull-down menu to choose a type:
|
Condition |
Use the pull-down menu to select the type of condition you need for this email notifier. Edit the auto-supplied condition in the text box or add a completely new script for your purpose. The condition specifies whether the notifier should send a message depending on the result of a property expansion. If the result is empty or non-zero, the message is sent. If the result is "0", the message is not sent. |
Template |
Use the pull-down menu to select from a list of global, ready-to-use formatting templates. Depending on the type of email notifier you are creating, the available template choices in the drop-down menu will be different. (Required) To customize your template, edit the auto-supplied text in the text box, or you can add a completely new script for your purpose. Any edits made in this text box will not be saved to the global template. To create a custom template, the basic structure is:
|
Email Configuration |
Click inside this field or start typing to bring up a list of possible email configuration names. An email notifier that does not specify an email configuration will use the configuration named 'default' if it exists. |
Destinations |
Required. This is a space-separated list of valid email addresses, email aliases, or CloudBees CD/RO user or group names, or a property reference that expands into such a list, or you can enter an LDAP DL name (group name). |
Select OK to save your email notifier configuration. The next time you view the Notifier table, you can view this notifier in the list.
Parameters
Similar to Notifiers, a parameter table is displayed containing all formal parameters defined for this state definition. Parameters are presented when launching the workflow definition (if it is startable), or when taking a manual transition to the state. A transition may enter values for some or all of the formal parameters defined by the state definition, in which case only the unmapped parameters are presented to the user.
-
Create Parameter: Use this link to go to the New Parameter page to create a parameter for this state definition.
Properties
Similar to the Notifiers and Parameters table, a properties table is displayed containing available properties for this state definition. If no properties were defined for this state definition, the table does not exist.
Select one of the available links to create one or more properties that will be displayed in the table when created:
-
Create Property: Navigate to the New Property pop-up box to create a new property for this state definition.
-
Create Nested Sheet: Navigate the New Nested Property Sheet pop-up box to create a nested property.
-
Access Control: Navigate to the Access Control page for the property sheet.
The property pop-up boxes contain a Help link if you need assistance creating a property.
Create a transition definition
On the State Definition panel, select the Create Transition link to see the Transition Definition panel.
Enter information into the fields as follows:
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
|
| Field Name | Description | ||
|---|---|---|---|
Name |
(Required) Enter a unique name for the transition definition. It can be any name you choose, but the name must be unique within the state definition. If you do not provide a name, a system-generated name is created: New Transition, New Transition 2, and so on. |
||
Description |
(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with
|
||
Target State |
This field displays the "best guess" for the target state. If not correct, or you intended to create a transition for a different state, use the down-arrow to choose an available target state from the list. |
||
Trigger |
Use the drop-down menu to choose the transition type. The four types of transitions are:
|
||
Condition |
Use the drop-down menu to choose a condition. After selection, the text box is populated with a sample JavaScript string to edit for your purposes.
|
Select OK to save your transition definition.
Notice the new links and options available now:
-
Access Control: Use this link to add or modify access control privileges to this transition definition.
-
Edit: Use this link to modify the transition definition.
-
View in list: Use this link to see the new transition definition in the List view (table) on the Workflow Definition Details page. You can use the List view to move the transition to a different position within the state definition.
-
Parameters: If parameters were defined on the State Definition Details page, you will not see them here. If parameters are defined on this page, you need to enter values. Manual transitions allow you to defer parameter assignment until transition time.
-
Properties: Displays properties available for this object, or you can create one or more properties at this time.
Using quick-access features
The following screen example is a portion of a workflow graph. In the graph, states and transitions are links:
-
Select a state to open the State Definition panel to modify that state.
-
Select a transition to open the Transition Definition panel to modify that transition. (Hover your mouse over a transition or transition name and select when it changes color.)
However, if you right-click on a state or transition, a context-sensitive menu with other options is available. In the following example, right-clicking on the "group_1" state provided the quick-link pop-up menu.
Available pop-up links include:
-
Edit: opens the State Definition panel to make modifications. This is the same as selecting the Edit link on the State Definition panel.
-
Create Transition: Opens the Transition Definition panel.
-
Delete: Deletes the state.
-
Copy: Makes a copy of the state with all associated transitions preserved.
-
Go to Action Definition: For states calling a procedure, the Procedure Details page is opened. For states calling a workflow, the Workflow Definition Details page for the "subworkflow" is opened.
-
For states with "No action", the choices are the same, except the Go to Action Definition option is not available.
-
For transitions, menu options include: Rename, Delete, and Copy.
-
Right-clicking anywhere on the graph canvas provides two more choices:
-
Create State: Allows you to quickly create a new state. This is the same as select the Create State at the top of the graph.
-
Rotate Graph: Acts as a "toggle", rotating the graph from a vertical to horizontal view and back again.
-
Show legend
The following screen is another example of a workflow graph. Depending on your workflow, your graph could be very simple or much more complex than the example below.
Notice the transition line-endings and different shapes used for states.
The legend is available for reference anytime to help you become familiar with state shapes and line-ending definitions.
List view
This view will be empty until you build a workflow in the Graph view. You can view this page at any time to see a list of states and transitions in your workflow definition.
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].
|
| Column Name | Description / Actions |
|---|---|
Name |
This column displays state definition and transition definition names currently defined for this workflow definition.
|
Type |
This is the type of action or trigger currently assigned to the state definition or transition definition.
|
Action |
This is the action previously defined for the state or transition.
|
Startable |
A check mark in this column shows this state was defined as startable, which means this state is the beginning point for your workflow. |
Description |
(Optional) Plain text or HTML description for this object. If using HTML, you must surround your text with
|
Actions |
You can perform some or all of these actions:
|
Properties view
Select the Properties view button to see the Properties table. If no properties were defined for this workflow definition, no table appears. The following links and actions are available in the Properties table:
-
Links and actions at the top of the table:
-
Create Property: Navigate to the New Property pop-up box to create a new property for this workflow definition.
-
Create Nested Sheet: Navigate the New Nested Property Sheet popup to create a nested property.
-
Access Control: Change access control privileges on the property sheet.
-
-
Column descriptions
IPv6 addresses are only supported for Kubernetes platforms. If using an IPv6 address, enclose the address in square brackets. Example: [<IPv6-ADDRESS>].Column name Description / actions Property Name
Select a property name to edit that property. You can change its name, value, or add/change its description. If the property name is preceded by a folder icon, this is a property sheet. Select the property name to open the "folder".
Value
The value currently assigned to the property.
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:
<i>Note</i>: For more information about the <b>abc</b> object, see https://www.google.com.
Actions
Delete: Select this link to delete the property on that row.
-