summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-08-24 07:30:28 (EDT)
committer Stephan Born2012-08-24 07:30:28 (EDT)
commitca03c00ec7b8295fa670b45fee69bc38bf75f106 (patch)
tree545fda21d77aaac04d38c2455d9dff63f0936682
parent3f3db18d57985a3d00eaafabb470b79fef5d9fe3 (diff)
downloadorg.eclipse.stardust.documentation-ca03c00ec7b8295fa670b45fee69bc38bf75f106.zip
org.eclipse.stardust.documentation-ca03c00ec7b8295fa670b45fee69bc38bf75f106.tar.gz
org.eclipse.stardust.documentation-ca03c00ec7b8295fa670b45fee69bc38bf75f106.tar.bz2
CRNT-24946 - Added Process Definition chapter
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@58677 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--.project11
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/create-process.pngbin0 -> 8901 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-pro-confirm.pngbin0 -> 6608 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/delete-pro.pngbin0 -> 12575 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/display.pngbin0 -> 3589 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-proc-prop.pngbin0 -> 7900 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/new-name.pngbin0 -> 10470 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-attach.pngbin0 -> 11837 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-display-prop.pngbin0 -> 11474 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int-type.pngbin0 -> 5765 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int.pngbin0 -> 11365 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-process.pngbin0 -> 12432 bytes
-rw-r--r--org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm281
13 files changed, 156 insertions, 136 deletions
diff --git a/.project b/.project
new file mode 100644
index 0000000..f2acea7
--- /dev/null
+++ b/.project
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>stardust</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ </buildSpec>
+ <natures>
+ </natures>
+</projectDescription>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/create-process.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/create-process.png
new file mode 100644
index 0000000..2d481db
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/create-process.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-pro-confirm.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-pro-confirm.png
new file mode 100644
index 0000000..1ea5320
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-pro-confirm.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/delete-pro.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/delete-pro.png
new file mode 100644
index 0000000..7980981
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/delete-pro.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/display.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/display.png
new file mode 100644
index 0000000..ac3137e
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/display.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-proc-prop.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-proc-prop.png
new file mode 100644
index 0000000..5a77584
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/gen-proc-prop.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/new-name.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/new-name.png
new file mode 100644
index 0000000..3bc9f46
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/new-name.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-attach.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-attach.png
new file mode 100644
index 0000000..03780cc
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-attach.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-display-prop.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-display-prop.png
new file mode 100644
index 0000000..0517f03
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-display-prop.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int-type.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int-type.png
new file mode 100644
index 0000000..e400fc4
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int-type.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int.png
new file mode 100644
index 0000000..acd192a
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/proc-int.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-process.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-process.png
new file mode 100644
index 0000000..914431b
--- /dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-process.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
index 553ff47..eaa2504 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-process.htm
@@ -20,147 +20,156 @@
</script>
<h1>Working with Process Definitions</h1>
-<p>The @productname@ Workbench visualizes the existing process definitions in the
-<a href="model-views/views-outline.html">Outline view</a> area. You can view your list
-of process definitions there, add new or modify existing ones.</p>
-<p>&nbsp;</p>
+<p>The Business Process Modeling perspective visualizes the existing process definitions in the
+<strong>My Process Models</strong> panel under model element. You can create, rename and delete process definitions.
+Each process definition has its property panel wherein you can modify its properties.
+A typical process definition contains swim lanes, activities and gateways, applications, events, data and control flows.</p>
-<p class="image"><img src="images/mg-defdesk-15.png" alt=""> <br>
-<strong>Figure:</strong> Outline View with Process Definitions</p>
-<h2>Creating and Deleting Process Definitions</h2>
-<p>To create a new process definition you can either:</p>
+<p>You can perform following operations on any process definition in the Business Process Modeling perspective:</p>
<ul>
- <li>in the Default Diagram select the Process Definition icon from the toolbar
- palette or</li>
- <li>in the <a href="model-views/views-outline.html">Outline view</a> chose <strong>New
- Process Definition</strong> from the pop-up menu of the model element.</li>
-</ul>
-<p>&nbsp;</p>
-<p class="image"><img src="images/mg-defdesk-16.png" alt=""> <br>
-<strong>Figure:</strong> Creating a new Process Definition in the Outline View</p>
-<!-- <P >
- When deleting a process definition, you must make a distinction between deleting a process definition with all its contents from the model information or only deleting a symbol from a diagram.</P>-->
-<p>To delete a process definition from a model:</p>
-<ul>
- <li>select the symbol of the process definition in the <strong>Outline
- view </strong>and choose the option <strong>Delete </strong> in the pop-up menu of this process
- definition or</li>
- <li>right-click the process definition symbol in the default diagram and choose <strong>Delete</strong>
- from the pop-up menu.</li>
+ <li><a href="#create">Creating a Process Definition</a></li>
+ <li><a href="#rename">Renaming a Process Definition</a></li>
+ <li><a href="#del">Deleting a Process Definition</a></li>
+ <li><a href="#prop">Modifying Properties of a Process Definition</a></li>
+
</ul>
+<h2 id="create">Creating a Process Definition</h2>
+<p>Perform the following steps to create a new process definition.</p>
+<ol>
+ <li>Expand the <strong>My Process Models</strong> pane of the Business Process Modeling perspective</li>
+ <li>Create model under the Models node</li>
+ <li>Right-click the newly created model name and select <strong>Create Process</strong>.
+ The Process 1 gets created under the model node.
+ <p class="image"><img src="images/create-process.png" alt=""> <br>
+<strong>Figure:</strong> Creating a Process Definition</p></li>
+
+</ol>
+<h2 id="rename">Renaming a Process Definition</h2>
+
+<p>Perform the following steps to rename the process definition:</p>
+
+
+<ol>
+ <li>Under the Models node, right-click the process name and select <strong>Rename</strong></li>
+ <p class="image"><img src="images/rename-process.png" alt=""> <br>
+<strong>Figure:</strong> Renaming a Process Definition</p>
+
+ <li>Specify the new name. The process is renamed.</li>
+ <p class="image"><img src="images/new-name.png" alt=""> <br>
+<strong>Figure:</strong> Specify New name</p>
+</ol>
+
+<h2 id="del">Deleting a Process Definition</h2>
+<p>Perform the following steps to delete the process definition:</p>
+<ol>
+ <li>Under the Models node, right-click the process name and select <strong>Delete</strong>
+
+
+ <p class="image"><img src="images/delete-pro.png" alt=""> <br>
+<strong>Figure:</strong> Delete Process</p></li>
+ <li>Click <strong>Yes</strong> in the delete <strong>Confirm</strong> dialog box. The process gets deleted.
+ <p class="image"><img src="images/del-pro-confirm.png" alt=""> <br>
+<strong>Figure:</strong> Delete Process - Confirm dialog box</p></li>
+</ol>
+<h2 id="prop">Modifying Properties of a Process Definition</h2>
+<h3>General Properties</h3>
+
+<p>To view the properties of a process definition, perform the following steps:</p>
+
+<ol>
+ <li>Select the process definition under the model node. The properties window is displayed at the top right corner
+ of the swim lane.
+ <p class="image"><img src="images/gen-proc-prop.png" alt=""> <br>
+<strong>Figure:</strong> General Properties of Process Definition</p>
+ </li>
+ <li>Specify the properties:
+ <ul>
+ <li>UUID - A unique identifier ID gets generated as an identifier for client server communication</li>
+ <li>ID - Default ID of the process</li>
+ <li>Name - Specify name of the process</li>
+ <li>Description - Specify the description</li>
+ <li>Default Priority - Specify process priority. By default, it is set to 0. You can specify following
+ values for priority:
+ <ul>
+ <li>1 indicates high priority</li>
+ <li>0 indicates medium priority</li>
+ <li>-1 indicates low priority</li>
+ </ul>
+ </li>
+ </ul></li>
+</ol>
+
+<h3>Process Interface</h3>
+<p></p>
+
+
+<p>To view and modify the process interface properties of a process, perform the following steps: </p>
+<ol>
+ <li>Make sure that property panel of the process definition is open </li>
+ <li>Click the <strong>Process Interface</strong> icon displayed at top right corner of the swim lane</li>
+ <p class="image"><img src="images/proc-int.png" alt=""> <br>
+<strong>Figure:</strong> Process Interface icon</p>
+
+ <li>Select process interface type from the <strong>Type</strong> drop-down list.
+ By default, <strong>No Process Interfaces</strong> option is selected.
+ <p class="image"><img src="images/proc-int-type.png" alt=""> <br>
+<strong>Figure:</strong> Process Interface - Type</p>
+ <ul>
+ <li>Provides Process Interface</li>
+ <li>Implements Process Interface</li>
+
+ </ul>
+</li>
+</ol>
+
+<h4>Provides Process Interface</h4>
+<p></p>
+
+<h4>Implements Process Interface</h4>
+<p></p>
+
+<h3>Data Path</h3>
+<p>TO DO</p>
+
+<h3>Display</h3>
+<p>Perform the following steps to modify the Display properties</p>
+
+<ol>
+ <li>Make sure that property panel of the process definition is open </li>
+ <li>Click the <strong>Display</strong> icon displayed at top right corner of the swim lane
+
+ <p class="image"><img src="images/proc-display-prop.png" alt=""> <br>
+<strong>Figure:</strong> Process - Display Icon</p></li>
+ <li>Select a check box <strong>Is Auxiliary Process</strong> to mark a process as auxiliary from a
+ business perspective. Thus, non-business relevant process instances can be hidden in
+ the Infinity Process Platform Portal. This check box is not selected, by default.
+
+ <p class="image"><img src="images/display.png" alt=""> <br>
+<strong>Figure:</strong> Process - Display</p></li>
+
+</ol>
+
+<h3>Process Attachments</h3>
+
+<p>Perform the following steps to specify process attachments:</p>
+
+<ol>
+ <li>Make sure that property panel of the process definition is open </li>
+ <li>Click the <strong>Process Attachments</strong> icon displayed at top right corner of the swim lane
+ <p class="image"><img src="images/proc-attach.png" alt=""> <br>
+<strong>Figure:</strong> Process Attachments Icon</p></li>
+
+ <li>Select the check box <strong>Process supports attachments</strong></li>
+ <li>
+ Select the check box <strong>Unique per root process instance</strong></li>
+
+</ol>
+<p>For more information, please refer to the chapter
+<a href="PLUGINS_ROOT/org-eclipse.stardust.docs.dev/html/handbooks/modelling/mg-defdesk-3.htm">Working with Process Definition</a>
+
+
-<h2 id="props">Modifying Process Definition Properties</h2>
-<p>The properties of a process definition are accessible in its properties dialog.
-To open this dialog, right-click the process definition symbol in the <strong>Outline</strong>
-view and select the option <strong>Properties</strong>.</p>
-<p class="image"><img src="images/mg-defdesk-16a.png" alt="General Properties">
-<br>
-<strong>Figure:</strong> General Properties</p>
-<p>The following properties are provided for a process definition:</p>
-<ul>
- <li><strong>Authorization</strong> - for detailed information on how to set authorization properties
- for process definitions please refer to the section
- <a href="property-page-authorization.html#process">Authorization for Process Definitions</a>
- of the <a href="property-page-authorization.html">Authorization</a> chapter.</li>
- <li><strong>General</strong> properties - including the process name, ID and description.<br>
- Please note that IDs containing
- hyphens, blanks or dots and IDs starting with digits are not supported.</li>
- <li><strong>Controlling</strong>:<ul>
- <li><strong>Cost Driver</strong> - the cost driver.</li>
- <li><strong>Target Cost-Driver Quantity</strong> - the estimated cost-driver quantity.</li>
- <li><strong>Target Processing Time</strong> - the estimated processing time, default is
- <tt>Y:000 M:00 D:00 h:00 m:00 s:00</tt>.</li>
- <li><strong>Target Execution Time</strong> - the estimated duration of
- the process in seconds, default is <tt>Y:000 M:00 D:00 h:00 m:00 s:00</tt>.</li>
- <li><strong>Target Idle Time</strong> - the estimated idle time, default is
- <tt>format Y:000 M:00 D:00 h:00 m:00 s:00</tt>.</li>
- <li><strong>Target Cost Per Execution</strong> - the estimated cost per execution.</li>
- <li><strong>Target Cost Per Second</strong> - the estimated cost per second.</li>
- <li><strong>Overdue Threshold</strong> - threshold for criticality in percent.
- The default value is 0%.</li>
- </ul></li>
- <li><strong>Display</strong> - a checkbox <strong>Is Auxiliary Process</strong>
- is provided to mark processes as auxiliary
- from a business perspective. Thus, non business relevant process instances
- can be hidden in the @productname@ Portal. This option is disabled by default.
- </li>
- <li><strong>Process Interface</strong> - helps to refer the elements of a model
- as public. Refer to section Process Interface for details.
- For detail information, please refer to the
-
- <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/mg-defdesk-3.htm#pi">
-Process Interface</a> section and <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/mg-defdesk-3.htm#refprocess">
-Working with Referenced Process Definitions </a>
-of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/mg-defdesk-3.htm">Working with Process Definitions</a> chapter
-of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/handbooks.htm">Developer Handbook.</a>
-
- </li>
- <li><strong>Display</strong> - a checkbox <strong>Is Auxiliary Process</strong>
- is provided to mark processes as auxiliary
- from a business perspective. Thus, non business relevant process instances
- can be hidden in the @productname@ Portal. This option is disabled by default.
- </li>
-
- <li><strong>Process Attachments</strong> - to specify if process attachments are supported.
- Refer to section <a href="#attachments">Process Attachments</a>
- for details.</li>
- <li><strong>Simulation</strong> - to specify simulation configurations, as described detailed in the chapter
- <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.simulation/html/simulation/simulation-configurations.html">
- Simulation Configurations</a>
- of the
- <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.simulation/html/simulation/toc.html">
- Developer Simulation Guide</a>.</li>
- <li><strong>Effort Planning</strong> - for detailed information on how to set properties for
- effort planning please refer to the chapter
- <a href="process-effort-calculation.html">Process Effort Calculation</a>.</li>
-</ul>
-<p>&nbsp;</p>
-<p class="image"><img src="images/mg-process-controlling.png"
- alt="Controlling Properties"> <br>
-<strong>Figure:</strong> Controlling Properties</p>
-<p>General properties can be modified by typing the desired strings or text elements
-into the provided text fields.</p>
-<h3 id="attachments">Process Attachments</h3>
-<p>Per default, process attachments support is disabled in
-the process instance property page.</p>
-<p class="image"><img src="images/mg-proc-attach.png"
- alt="flag"> <br>
-<strong>Figure:</strong> Process support Attachments Flag</p>
-<p>To support process attachments, enable the
-<strong>Support process attachments</strong> flag.</p>
-<h4>Unique per root process instance</h4>
-<p>In case the <strong>Support process attachments</strong> flag
-is enabled, the <strong>Unique per root process instance</strong>
-is checkbox is enabled as well.</p>
-<p class="image"><img src="images/mg-proc-attach-unique.png"
- alt="unique flag"> <br>
-<strong>Figure:</strong> Unique per root process instance option.</p>
-<p>If this flag is enabled,
-all process attachments pertaining to subprocesses access the root
-process data instead of the scope process data. That means
-that the process attachments list is maintained in scope of the root
-process instance and all attachments pertaining to the
-root process instance can be accessed in sub processes.</p>
-<p>If the flag is disabled, which is the default,
-process attachments pertaining to the root process instance
-are not present for the sub processes. The sub processes have separate data
-in that case.</p>
-
-
-<h2>Creating and Deleting Process Definition Diagrams</h2>
-<p>Deleting a diagram is done by selecting it in the <strong>Outline</strong> view
-and choosing <strong>Delete </strong> in the diagram's pop-up menu.</p>
-<p>To create a diagram:</p>
-<ul>
- <li>In the <strong>Outline</strong> view, select the process definition.</li>
- <li>Use the option <strong>New Diagram </strong> in the pop-up menu of the
- corresponding process definition.</li>
-</ul>
-<p>A diagram created this way can be used only to define this process.</p>
-<p>For more information about diagrams, see the chapter <a
- href="model-views/views-diagrams.html">Diagrams</a> in the @productname@ Workbench
-description.</p>
<script language="JavaScript" type="text/javascript">
<!--