Stages Documentation

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revisionPrevious revision
Next revision		Previous revision
76:process_execution [2021/02/25 09:05] – mir76:process_execution [2024/02/15 00:00] (current) – external edit 127.0.0.1
Line 1: Line 1:
 ====== Model and Manage Process Execution ====== ====== Model and Manage Process Execution ======
  
-Find technical details for the Process execution systems here:+The principal idea of the Stages Process Execution concept is to use process information in Application Lifecycle Management (ALM) Systems to work process compliant and to automate workflows. 
 + 
 +Find technical details for the ALM Systems here:
  
 [[:76:process_execution_rtc|]] [[:76:process_execution_rtc|]]
  
-[[:76:process_execution_jira|]]+[[:76:process_execution_jira|]] (server version)
  
-===== General concept =====+=== Model Execution in Stages ===
  
-The principal idea of the Stages Process Execution concept is to use existing process information and attach execution information as an addition to it. Ideally this leads to the situation that whenever the process is changed or tailored, the execution changes behavior without changing the execution information.+In Stages the existing process information is used regularly. The execution information is attach as an addition to it. Ideally this leads to the situation that whenever the process is changed or tailored, the execution changes behavior without changing the execution information.
  
 Hence it is possible to attach execution information only to parts of a process, it can be taken into execution selectively. Hence it is possible to attach execution information only to parts of a process, it can be taken into execution selectively.
Line 17: Line 19:
 The Process space contains the process elements like activities, roles, work products etc. The Execution space contains elements like Activators, Execution Properties and Execution Scripts. Both spaces are part of a process version, so that also the execution information is subject of versioning. The Process space contains the process elements like activities, roles, work products etc. The Execution space contains elements like Activators, Execution Properties and Execution Scripts. Both spaces are part of a process version, so that also the execution information is subject of versioning.
  
-===== How to use =====+=== Run Execution in ALM Systems ===
  
-Top level steps to use the Stages Process Execution are:+After exporting the Stages Process into the ALM System, the System has access to process and execution elements. This leads to the advantage that events (like saving or changing the state) from within the System can run automation and follow the process. 
 + 
 +Also Stages is capable of triggering such events in the Workflow Management System with the Executable-Activator. 
 + 
 + 
 +===== How to start with Execution ===== 
 + 
 +Top level steps to use the Stages Process Execution in Stages are:
  
   * activate execution configuration in config.xml   * activate execution configuration in config.xml
-  * equip your process with execution information+  * equip your process with Execution Activators
   * create a process version and set this as valid version   * create a process version and set this as valid version
-  * export the process to the Excution system+  * export the process to the ALM system (see individual links above for a system specific howto)
  
-After export your Process execution will work in the Execution system and you can use Stages to run Executable Activators.+After export your Process execution will work in the ALM system and you can use Stages to run the Executable Activator.
  
 ===== Concept Example ===== ===== Concept Example =====
Line 37: Line 46:
  
 In this way every workflow in Stages can easily get ready to be executed by attaching an Activator to it. In this way every workflow in Stages can easily get ready to be executed by attaching an Activator to it.
 +
 +===== Activate Execution configuration in config.xml =====
 +
 +You have to activate process execution by adding the ALM system type to the config.xml. You can choose to activate Jira and/or RTC:
 +
 +<code xml>
 +<enactment>
 +    <enactment-system name="rtc">
 +    </enactment-system>
 +    <enactment-system name="jira">
 +    </enactment-system>
 +</enactment>
 +
 +</code>
 +
 +It’s recommended to add server configuration information:
 +
 +<code xml>
 +<enactment>
 +    <enactment-system name="jira">
 +        <enactment-server ident="jiraProduction" url="https://jira.example.com/jira" displayName="Jira Production">
 +            <enactment-property name="username" value="user" />
 +            <enactment-property name="password" value="secret" />
 +        </enactment-server>
 +    </enactment-system>
 +</enactment>
 +
 +</code>
  
 ===== Process execution Elementtypes ===== ===== Process execution Elementtypes =====
Line 44: Line 81:
 ==== Step-by-step Activator ==== ==== Step-by-step Activator ====
  
-The purpose of the step-by-step-Activator is to execute a workflow stepwise. When one activity is done, the object in the execution system for the next activity is created.+The purpose of the step-by-step-Activator is to execute a workflow step wise. When one activity is done, the object in the execution system for the next activity is created.
  
 The Activator is reactive, meaning that it gets into action when an execution object of type “issue Type” changes state from “Start State” to “End State”. This triggers the creation of the execution object for the first activity. This is created with type “Children Issue Type” The Activator is reactive, meaning that it gets into action when an execution object of type “issue Type” changes state from “Start State” to “End State”. This triggers the creation of the execution object for the first activity. This is created with type “Children Issue Type”
Line 54: Line 91:
 === Attributes === === Attributes ===
  
-Issue Type: defines the type of execution object which represents the workflow+**Issue Type**: defines the type of execution object which represents the workflow
  
-Start State & End State: defines the state transition from start to end state for which the activator is triggered (the first child Execution Object is created)+**Start State & End State**: defines the state transition from start to end state for which the activator is triggered (the first child Execution Object is created)
  
-Parent Next State: defines the state of the execution object which represents the workflow when all children are in end state (e.g. the workflow is finished)+**Parent Next State**: defines the state of the execution object which represents the workflow when all children are in end state (e.g. the workflow is finished)
  
-Bound-to-process: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).+**Bound-to-process**: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).
  
-Children Issue Type: defines the type of execution object a child-element is created with+**Children Issue Type**: defines the type of execution object a child-element is created with
  
-Children Issue Initial State: defines the state of execution object a child-element is created with (RTC only)+**Children Issue Initial State**: defines the state of execution object a child-element is created with (RTC only)
  
-Children Start State & Children End State: defines the state transition from start to end state for which a child is to be considered as done and the next child is created+**Children Start State & Children End State**: defines the state transition from start to end state for which a child is to be considered as done and the next child is created
  
-XXX State is a group: defines whether the given state is the name of a single state or a state group (RTC only)+**State is a group**: defines whether the given state is the name of a single state or a state group (RTC only)
  
 ==== All-at-once Activator ==== ==== All-at-once Activator ====
Line 82: Line 119:
 === Attributes === === Attributes ===
  
-Issue Type: defines the type of execution object which represents the workflow+**Issue Type**: defines the type of execution object which represents the workflow
  
-Start State & End State: defines the state transition from start to end state for which the activator is triggered (the children Execution Objects are created)+**Start State & End State**: defines the state transition from start to end state for which the activator is triggered (the children Execution Objects are created)
  
-Bound-to-process: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).+**Bound-to-process**: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).
  
-Children Issue Type: defines the type of execution object a child-element is created with+**Children Issue Type**: defines the type of execution object a child-element is created with
  
-Children Issue Initial State: defines the state of execution object a child-element is created with (RTC only)+**Children Issue Initial State**: defines the state of execution object a child-element is created with (RTC only)
  
-XXX State is a group: defines whether the given state is the name of a single state or a state group (RTC only)+**State is a group**: defines whether the given state is the name of a single state or a state group (RTC only)
  
 ==== Transition Workflow Activator ==== ==== Transition Workflow Activator ====
Line 106: Line 143:
 === Attributes === === Attributes ===
  
-Issue Type: defines the type of execution object which triggers the activator+**Issue Type**: defines the type of execution object which triggers the activator
  
-Start State & End State: defines the state transition from start to end state for which the activator is triggered and the Execution Script is executed+**Start State & End State**: defines the state transition from start to end state for which the activator is triggered and the Execution Script is executed
  
-Bound-to-process: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).+**Bound-to-process**: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).
  
-XXX State is a group: defines whether the given state is the name of a single state or a state group (RTC only)+**State is a group**: defines whether the given state is the name of a single state or a state group (RTC only)
  
 ==== Executable-Activator ==== ==== Executable-Activator ====
Line 119: Line 156:
  
 When an Executable-Activator is associated to a Process Element, in the Process Execution widget a “play-button” is visible to run the Executable-Activator (user triggered) When an Executable-Activator is associated to a Process Element, in the Process Execution widget a “play-button” is visible to run the Executable-Activator (user triggered)
 +
 +==== Legacy Activators ====
 +
 +The Activator-types with "legacy" in the name are for V6 migration purposes only.
  
 ==== Issue Property ==== ==== Issue Property ====
Line 126: Line 167:
 === Attributes === === Attributes ===
  
-Issue Type: defines the type of execution object for the Process Element+**Issue Type**: defines the type of execution object for the Process Element
  
-Issue Initial State: defines the state of execution object when it gets created (RTC only)+**Issue Initial State**: defines the state of execution object when it gets created (RTC only)
  
-Event Start State & Event End State: defines the state transition from start to end state for which the desired event is triggered+**Event Start State & Event End State**: defines the state transition from start to end state for which the desired event is triggered
  
-Bound-to-process: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).+**Bound-to-process**: indicates whether this activator triggers for every Execution Object of type “Issue Type” (bound to process = false) or only when the Process Element is associated to the Execution Object (bound to process = true).
  
-XXX State is a group: defines whether the given state is the name of a single state or a state group (RTC only)+**State is a group**: defines whether the given state is the name of a single state or a state group (RTC only)
  
 ==== Execution Scripts ==== ==== Execution Scripts ====