Workflow

Description

The Workflow type holds the name and other information about a workflow in SBM. The Workflow type parameters are listed below.

Parameters

Name	Type	Description
id	WorkflowIdentifier	Holds identification information for a workflow.
state	WorkflowState	Holds graphical workflow information for a state.
transition	WorkflowTransition	Holds graphical workflow information for a transition.
comment	WorkflowComment	Hold graphical workflow information for an annotation.
band	WorkflowBand	Holds graphical workflow information for a swimlane.
extendedData	ExtendedData	Placeholder for future arguments.

Usage

The Workflow type completely describes a graphical workflow in SBM. Use GetWorkflows to retrieve the graphical workflow for a specified project.

XML

The following XML snippet shows the Workflow type in the return element of the GetWorkflows response.

<ae:workflow>
   <ae:id xsi:type="ae:WorkflowIdentifier">
      <ae:displayName>IDM</ae:displayName>
      <ae:id>2</ae:id>
      <ae:uuid>5296c4b1-4bab-48a9-83b3-1f633894ef33</ae:uuid>
   </ae:id>
   <ae:state>
      <ae:id xsi:type="ae:StateIdentifier">
         <ae:displayName>None</ae:displayName>
         <ae:id>0</ae:id>
         <ae:uuid/>
         <ae:internalName/>
         <ae:isClosed>false</ae:isClosed>
      </ae:id>
      <ae:center>
         <ae:x>63</ae:x>
         <ae:y>0</ae:y>
      </ae:center>
      <ae:size>
         <ae:width>63</ae:width>
         <ae:height>63</ae:height>
      </ae:size>
      <ae:radius>0</ae:radius>
   </ae:state>
   <ae:state>
      <ae:id xsi:type="ae:StateIdentifier">
         <ae:displayName>E-mail</ae:displayName>
         <ae:id>-3</ae:id>
         <ae:uuid/>
         <ae:internalName/>
         <ae:isClosed>false</ae:isClosed>
      </ae:id>
      <ae:center>
         <ae:x>63</ae:x>
         <ae:y>-106</ae:y>
      </ae:center>
      <ae:size>
         <ae:width>63</ae:width>
         <ae:height>63</ae:height>
      </ae:size>
      <ae:radius>0</ae:radius>
   </ae:state>
...
   <ae:transition>
      <ae:id xsi:type="ae:TransitionIdentifier">
         <ae:displayName>Update</ae:displayName>
         <ae:id>1</ae:id>
         <ae:uuid>update</ae:uuid>
         <ae:internalName>UPDATE</ae:internalName>
      </ae:id>
      <ae:style>STYLE-POLYLINE</ae:style>
      <ae:point>
         <ae:x>38</ae:x>
         <ae:y>-381</ae:y>
      </ae:point>
      <ae:point>
         <ae:x>90</ae:x>
         <ae:y>-380</ae:y>
      </ae:point>
      <ae:point>
         <ae:x>90</ae:x>
         <ae:y>-450</ae:y>
      </ae:point>
      <ae:point>
         <ae:x>5</ae:x>
         <ae:y>-450</ae:y>
      </ae:point>
      <ae:point>
         <ae:x>6</ae:x>
         <ae:y>-406</ae:y>
      </ae:point>
      <ae:styleClass>NormalPath</ae:styleClass>
      <ae:labelPosition>
         <ae:x>88</ae:x>
         <ae:y>-400</ae:y>
      </ae:labelPosition>
   </ae:transition>
   <ae:transition>
      <ae:id xsi:type="ae:TransitionIdentifier">
         <ae:displayName>Delete</ae:displayName>
         <ae:id>2</ae:id>
         <ae:uuid>delete</ae:uuid>
         <ae:internalName>DELETE</ae:internalName>
      </ae:id>
      <ae:style>STYLE-STRAIGHT</ae:style>
      <ae:point>
         <ae:x>-31</ae:x>
         <ae:y>-406</ae:y>
      </ae:point>
      <ae:point>
         <ae:x>-31</ae:x>
         <ae:y>-519</ae:y>
      </ae:point>
      <ae:styleClass>NormalPath</ae:styleClass>
      <ae:labelPosition>
         <ae:x>-31</ae:x>
         <ae:y>-444</ae:y>
      </ae:labelPosition>
   </ae:transition>
...   
   <ae:comment>
      <ae:id>1020</ae:id>
      <ae:center>
         <ae:x>559</ae:x>
         <ae:y>-109</ae:y>
      </ae:center>
      <ae:size>
         <ae:width>169</ae:width>
         <ae:height>56</ae:height>
      </ae:size>
      <ae:text>The Fail transition will increment the QA Reject Count</ae:text>
      <ae:styleClass/>
      <ae:styleOverride>font: Arial;fontsize: 8;align: Near;valign: Near;
→cornerradius: 0;</ae:styleOverride>
   </ae:comment>
   <ae:comment>
      <ae:id>1021</ae:id>
      <ae:center>
         <ae:x>140</ae:x>
         <ae:y>269</ae:y>
      </ae:center>
      <ae:size>
         <ae:width>169</ae:width>
         <ae:height>38</ae:height>
      </ae:size>
      <ae:text>IDM Users cannot defer the Issue</ae:text>
      <ae:styleClass/>
      <ae:styleOverride>font: Arial;fontsize: 8;align: Near;valign: Near;
→cornerradius: 0;</ae:styleOverride>
   </ae:comment>
</ae:workflow>