CRNT-26895 - Added Structured type details

git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@60660 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b

13 files changed, 110 insertions, 4 deletions

diff --git a/org.eclipse.stardust.docs.analyst/analysttoc.xml b/org.eclipse.stardust.docs.analyst/analysttoc.xml
index 1dfe8bd..037058f 100644
--- a/org.eclipse.stardust.docs.analyst/analysttoc.xml
+++ b/org.eclipse.stardust.docs.analyst/analysttoc.xml
@@ -30,6 +30,8 @@
     </topic>
     <topic href="html/handbooks/modelling_analyst/pep-process.htm" label="Working with Process Definitions">
     </topic>
+    <topic href="html/handbooks/modelling_analyst/pep-struct-type.htm" label="Working with Structured Types">
+    </topic>
     <topic href="html/handbooks/modelling_analyst/pep-activities.htm" label="Specifying Activities">
     </topic>
     <topic href="html/handbooks/modelling_analyst/pep-con-sequence.htm" label="Working with Sequence Flows">
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/add-element.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/add-element.png
new file mode 100644
index 0000000..ff79af5
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/add-element.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/card.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/card.png
new file mode 100644
index 0000000..1ccc6fe
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/card.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/comment.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/comment.png
new file mode 100644
index 0000000..2f4acff
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/comment.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-struct.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-struct.png
new file mode 100644
index 0000000..21d7563
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/del-struct.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/element.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/element.png
new file mode 100644
index 0000000..44c463c
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/element.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-struct.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-struct.png
new file mode 100644
index 0000000..390ef8d
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/rename-struct.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/struct-type.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/struct-type.png
new file mode 100644
index 0000000..1f01fd8
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/struct-type.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/type.png b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/type.png
new file mode 100644
index 0000000..6416bd6
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/images/type.png
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
index 63fcf6d..bc3fd4a 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-activities.htm
@@ -12,7 +12,7 @@
 <script language="JavaScript" type="text/javascript">
 <!--
 	writeNavigation("Working with Sequence Flows","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
-        "pep-process.htm","pep-con-sequence.htm",
+        "pep-struct-type.htm","pep-con-sequence.htm",
         "../../toc.html","Business Process Modeling Handbook");
  -->
 </script>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
index e5cc724..0ebcedc 100644
--- a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-gateways.htm
@@ -168,7 +168,7 @@ Select the gateway in the swim lanes and click the <strong>Comments</strong>
 icon displayed at top right side of the diagram canvas. </p>

 

 

-<p>Add annotation in the text box and click <strong>Submit</strong>.</p>

+<p>Add comment in the text box and click <strong>Submit</strong>.</p>

 

 <p class="image"><img src="images/gateway-comments.png" alt=""> <br>

 <strong>Figure:</strong> Gateway - Comments</p>

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 c7588aa..540ecf3 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
@@ -11,8 +11,8 @@
 <body>
 <script language="JavaScript" type="text/javascript">
 <!--
-	writeNavigation("Specifying Activities","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
-        "models/model-preface.html","pep-activities.htm",
+	writeNavigation("Working with Structured Types","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
+        "models/model-preface.html","pep-struct-type.htm",
         "../../toc.html","Business Process Modeling Handbook");
  -->
 </script>
diff --git a/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-struct-type.htm b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-struct-type.htm
new file mode 100644
index 0000000..ae9d6fa
--- a/dev/null
+++ b/org.eclipse.stardust.docs.analyst/html/handbooks/modelling_analyst/pep-struct-type.htm
@@ -0,0 +1,104 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">

+<html>

+<head>

+<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">

+<meta http-equiv="Content-Style-Type" content="text/css">

+

+<link rel="STYLESHEET" href="../../styles/carnot.css" charset="ISO-8859-1" type="text/css">

+<title>Working with Structured Types</title>

+<script language="JavaScript" src="../../styles/naviLine.js" type="text/javascript"></script>

+</head>

+<body>

+<script language="JavaScript" type="text/javascript">

+<!--

+	writeNavigation("Specifying Activities","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",

+        "pep-process.htm","pep-activities.htm",

+        "../../toc.html","Business Process Modeling Handbook");

+ -->

+</script>

+

+<h1>Working with Structured Types</h1>

+<p>You can define structured data types in the web-based modeling. For more information on 

+the <a href="">Structured Data Types</a> chapter of the Modeling Handbook.</p>

+

+<ul>

+	<li><a href="#std">Creating Structured Types</a>

+		<ul>

+			<li><a href="#ren">Renaming a Structured Type</a></li>

+			<li><a href="#del">Deleting a Structured Type</a></li>

+		

+		</ul></li>

+	<li><a href="#def">Defining Structured Types</a></li>

+	<li><a href="#imp">Importing Type Declarations</a></li>

+	

+	

+</ul>

+<h2 id="std">Creating Structured Types</h2>

+<p>To create structured types, right-click the <strong>Structured Types</strong> node and select

+<strong>Create Data Type</strong>.</p>

+<p class="image"><img src="images/cr-std.png" alt=""> <br>

+<strong>Figure:</strong> Creating Structured Types</p>

+

+<h3 id="ren">Renaming a Structured Type</h3>

+<p>To rename structured type, right-click the structured type created under <strong>Structured Types</strong>

+node and select <strong>Rename</strong>.</p>

+<p class="image"><img src="images/rename-struct.png" alt=""> <br>

+<strong>Figure:</strong> Renaming Structured Types</p>

+<h3 id="del">Deleting a Structured Type</h3>

+<p>To delete structured type, right-click the structured type created under 

+<strong>Structured Types</strong>

+node and select <strong>Delete</strong>.</p>

+<p class="image"><img src="images/del-struct.png" alt=""> <br>

+<strong>Figure:</strong> Deleting Structured Types</p>

+<h2 id="def">Defining Structured Types</h2>

+<p>To define the structured type, click the structured type name under the <strong>Structured Type</strong> 

+node in the <strong>My Process Models</strong> panel.</p>

+<p class="image"><img src="images/struct-type.png" alt=""> <br>

+<strong>Figure:</strong> Structured Type - Definition</p>

+<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>

+		<p>The <strong>UUID</strong> and <strong>ID</strong> options are displayed only when you switch to 

+	<a href="model-views/pep-panels.html">Integrator</a> profile.</p>

+	<li>Data Structure Name - Name of the structure type</li>

+	<li>Description - Specify description</li>

+	<li>Configuration

+	<ul>

+	<li>Structure - By default, this option is selected. You can define structured type fields if this option is selected.	</li>

+	<li>Enumeration - Select this option to create enumeration types. It means that data object is of type string and 

+	accepts values from the list of values.</li>

+	<li>Add Elements - Click the Add icon<img src="images/add-element.png"> to add elements for structured type.

+	<ul>

+		<li>Element - Specify name for the element</li>

+		<li>Type - Select data type from the drop-down list</li>

+		<p class="image"><img src="images/type.png" alt=""> <br>

+		<li>Cardinality - Select cardinality from the drop-down list</li>

+		<p class="image"><img src="images/card.png" alt=""> <br>

+	</ul></li>

+	<p class="image"><img src="images/element.png" alt=""> <br>

+	<li>Field Properties - You can define field properties for each field.

+	For more information, please refer to the section 

+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modeling/data-integration/mg-integration-lego.html#field">Defining Field Level Presentation for Structure Data</a>

+	of the chapter 

+	<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modeling/data-integration/mg-integration-lego.html">Structured Data Types</a> of the 

+	<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modeling/mg-preface.htm">Modeling Handbook.</a>

+	</li>

+	<li>Comments - Click the <strong>Comments</strong> tab. Add comment in the text box and click <strong>Submit</strong>.</li>

+	<p class="image"><img src="images/comment.png" alt=""> <br>

+	</ul></li>

+</ul>

+

+

+

+

+

+<h2 id="imp">Importing Type Declarations</h2>

+

+

+<script language="JavaScript" type="text/javascript">

+<!-- 

+writeFooter(); 

+-->

+</script>

+</body>

+</html>