summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-06-01 02:00:26 (EDT)
committerStephan Born2012-06-15 10:41:22 (EDT)
commit603b5ca6c53c3afbafadca104aa3d7add4b0cba0 (patch)
treed7edda6f118f535fecdb488ec60224fdb2695ce5
parentaf9780670645989d3d7459ba8eb59321e4f9dbcc (diff)
downloadorg.eclipse.stardust.documentation-603b5ca6c53c3afbafadca104aa3d7add4b0cba0.zip
org.eclipse.stardust.documentation-603b5ca6c53c3afbafadca104aa3d7add4b0cba0.tar.gz
org.eclipse.stardust.documentation-603b5ca6c53c3afbafadca104aa3d7add4b0cba0.tar.bz2
CRNT-23483 - Added field level presentation preferences for structured data- portal and modeler
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@56773 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type.pngbin0 -> 59218 bytes
-rw-r--r--org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type_orgSize.pngbin0 -> 48544 bytes
-rw-r--r--org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html114
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/images/struct-data.pngbin0 -> 9085 bytes
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html24
5 files changed, 138 insertions, 0 deletions
diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type.png b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type.png
new file mode 100644
index 0000000..95ded49
--- /dev/null
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type_orgSize.png b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type_orgSize.png
new file mode 100644
index 0000000..26c3cd0
--- /dev/null
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/images/properties-struct-type_orgSize.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html
index 0630369..cf9f669 100644
--- a/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html
+++ b/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html
@@ -324,6 +324,120 @@ table columns, will change the value for all fields.</p>
alt="Change All"><br>
<strong>Figure:</strong> Enable Change all to reflect value on all entries.</p>
+
+<h3 id="field">Defining Field Level Presentation for Structure Data</h3>
+<p>You can define certain properties to control each field of structured data. For example, if you
+define a Read Only property for a the field Customer ID then in the @productname@ Portal
+the user cannot edit the Customer ID field.</p>
+
+
+
+<p class="image"><a href="images/properties-struct-type_orgSize.png"><img src="images/properties-struct-type.png"
+alt="Structured Data - Field Level Properties"></a><br>
+<strong>Figure:</strong> Structured Data - Field Level Properties</p>
+
+<p>You can define following field level properties for a structured data:</p>
+
+<table>
+ <tr>
+ <th>Property</th>
+ <th>Value</th>
+ <th>Description</th>
+ </tr>
+ <!-- <tr>
+ <td>Show Structure Description</td>
+ <td>Yes or No</td>
+ <td>Displays description of structure data, if specified and Yes is selected. </td>
+ </tr> -->
+ <tr>
+ <td>Read Only</td>
+ <td>Yes or No</td>
+ <td>If you select Yes, the field becomes read only. If In-Out data mapping is provided for that
+ field it gets overridden and field remains read only.</td>
+ </tr>
+ <tr>
+ <td>Mandatory</td>
+ <td>Yes or No</td>
+ <td>If you select Yes, activity cannot be completed until you specify value for that field.</td>
+ </tr>
+ <tr>
+ <td>CSS Style</td>
+ <td>Specify CSS style.</td>
+ <td>For example, if you specify Color:Red for the field last name. The value for last name
+ is taken in red color.</td>
+ </tr>
+ <tr>
+ <td>CSS Style Class</td>
+ <td>Specify the class name from .css file. For example, .noteTip</td>
+ <td>Specify the name of the class from .css file. Include the css file in the <strong>skin</strong>
+ folder of <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/
+ admin-portal/views/admin-portal-resource.html">
+ Resource Mangement View</a> of the
+ <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html">Administration Perspective</a>.</td>
+ </tr>
+ <tr>
+ <td>Prefix i18 Key</td>
+ <td>-</td>
+ <td>Specify the key in the according language bundle properties file. The format should be
+ StructuredType.&lt;FullXPath&gt;.&lt;Field Name&gt;= &lt;specify value&gt;. The value for the key is read from
+ properties file and displayed in @productname@ Portal in specified language.</td>
+ </tr>
+ <tr>
+ <td>Prefix</td>
+ <td>Specify any string as prefix</td>
+ <td>The specified text is displayed before the input box in the @productname@ Portal.
+ If the prefix i18key is provided, then the prefix is overridden.</td>
+ </tr>
+ <tr>
+ <td>Suffix i18 Key</td>
+ <td>-</td>
+ <td>Specify the key in the according language bundle properties file. The format should be
+ StructuredType.&lt;FullXPath&gt;.&lt;Field Name&gt; = &lt;specify value&gt;. The value for the key will be read from
+ properties file and displayed in @productname@ Portal in specified language.</td>
+ </tr>
+ <tr>
+ <td>Suffix</td>
+ <td>Specify any string as suffix</td>
+ <td>The specified text is displayed after the input box in the @productname@ Portal.
+ If the suffix i18key is provided, then the suffix is overridden.</td>
+ </tr>
+ <tr>
+ <td>String Input Type</td>
+ <td>Select Text Input or Text Area</td>
+ <td>If the Text Input is selected, then the following <strong>Rows</strong> and
+ <strong>Columns</strong> fields become invalid. If Text Area is selected, you can specify
+ more characters. For example, in the Test Area, you can specify complete address of home and office.</td>
+ </tr>
+ <tr>
+ <td>Rows</td>
+ <td>Specify the size of rows to be displayed in the @productname@</td>
+ <td>Specified rows get displayed. If String Input Type is Text Area then rows are displayed. </td>
+ </tr>
+ <tr>
+ <td>Columns</td>
+ <td>Specify the size of columns to be displayed in the @productname@</td>
+ <td>Specified columns get displayed. If String Input Type is Text Area then columns are displayed. </td>
+ </tr>
+ <tr>
+ <td>Boolean Readonly Input Type</td>
+ <td>Checkbox or Text Output</td>
+ <td>The type of the field should be xsd:boolean. If Checkbox is selected, you need to select or clear the checkbox.
+ If Text Output is selected, the values True or False are displayed. For Text Output, you need to provide
+ Out data mapping for first activity and In data mapping should be provided to second activity.</td>
+ </tr>
+
+</table>
+<p>For more information, please refer to the section
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html#prop">
+Manual Activity Panel for Structured Data with Field Level Properties</a> of the
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html">
+Activities Execution View</a> of
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal.html">
+The Workflow Execution Perspective
+</a>
+.</p>
+
+
<h2 id="refStruct">Using Referenced Structured Data Definition</h2>
<p>Once the file connection is established, the referenced structured data definition can be referred in another model.
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/images/struct-data.png b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/images/struct-data.png
new file mode 100644
index 0000000..a3f971e
--- /dev/null
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/images/struct-data.png
Binary files differ
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html
index 757644a..b30e2c9 100644
--- a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/pp_renovated/process-portal-activities.html
@@ -43,6 +43,7 @@ for details.</p>
<li><a href="#tip">Tooltip Text</a></li>
<li><a href="#card">Manual Activity Panel for 1:N Cardinality of Structured Data</a></li>
<li><a href="#error">Error Handling in Manual Activity Panel</a></li>
+ <li><a href="#prop">Manual Activity Panel for Structured Data with Field Level Properties</a></li>
<li><a href="#qa">Activity Execution for Quality Assurance Activities</a></li>
</ul>
<h2 id="panel">Interactive Activity Panel</h2>
@@ -836,6 +837,29 @@ an error is shown in the form. A warning message is displayed at the top of the
alt="Manual Activity - Table Error Message"> <br>
<strong>Figure:</strong> Manual Activity - Table Error Message</p>
+
+<h2 id="prop">Manual Activity Panel for Structured Data with Field Level Properties</h2>
+<p>If field level properties are set for structured data, then the manual activity panel is displayed
+in the following manner. Note the red color outline for input text box, some text (KM and Integer) before (Prefix) and after (Suffix) the input text box.</p>
+
+<p class="image"><img src="images/struct-data.png"
+ alt="Manual Activity Panel - Structure Data Field Level Properties"> <br>
+<strong>Figure:</strong> Manual Activity Panel - Structure Data Field Level Properties</p>
+
+<p>For more information, please refer to the section
+<span class="hideReference">
+<strong>Defining Field Level Presentation for Structure Data</strong> in the chapter
+<strong>Structured Data Types
+</strong>
+of the <strong>@productname@ Online Documentation - Modeling Guide</strong></span>
+<span class="showReference"><a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html#field">
+Defining Field Level Presentation for Structure Data
+</a>
+in the chapter
+<a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/data-integration/mg-integration-lego.html">Structured Data Types</a>
+of the <a href="PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/handbooks/modelling/mg-preface.htm">Modeling Guide</a></span>.</p>
+
+
<h2 id="qa">Activity Execution for Quality Assurance Activities</h2>
<p>In case an activity is in quality assurance state, this is indicated via an
overlay icon:</p>