summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-06-01 04:21:58 (EDT)
committer Stephan Born2012-06-15 10:41:23 (EDT)
commit4f17c21c43c273e0ec6f15e8337ed6c9950e711e (patch)
treecfce6f721505a976f42ddbb47a603982f5b0a005
parentd01387cacd488258d3f793850a5104b7af3261fa (diff)
downloadorg.eclipse.stardust.documentation-4f17c21c43c273e0ec6f15e8337ed6c9950e711e.zip
org.eclipse.stardust.documentation-4f17c21c43c273e0ec6f15e8337ed6c9950e711e.tar.gz
org.eclipse.stardust.documentation-4f17c21c43c273e0ec6f15e8337ed6c9950e711e.tar.bz2
CRNT-24824 - Preference store manager
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@56783 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html3
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html254
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html2
-rw-r--r--org.eclipse.stardust.docs.enduser/usertoc.xml2
4 files changed, 118 insertions, 143 deletions
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html
index d79a38c..076b8da 100644
--- a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/admin-portal.html
@@ -72,7 +72,8 @@ chapter for detailed information.</p>
<li><a href="views/admin-portal-participant.html">Participant Management</a></li>
<li><a href="views/admin-portal-passwd.html">Password Security</a></li>
<li><a href="views/admin-portal-criticality.html">Criticality Configuration</a></li>
- <li><a href="views/admin-portal-quality.html">Quality Assurance Management</a></li>
+ <li><a href="views/admin-portal-quality.html">Quality Assurance Management</a></li>
+ <li><a href="views/admin-portal-prefstore.html">Preference Store Manager</a></li>
</ul>
<h2>Access Control</h2>
<p>The chapter <a href="admin-access.html">Administration Perspective Access Control</a>
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html
index b72e92f..9d3162b 100644
--- a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html
@@ -12,7 +12,7 @@
<script language="JavaScript" type="text/javascript">
<!--
writeNavigation("Administration Perspective Access Control","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
- "admin-portal-criticality.html","../../admin-portal/admin-access.html",
+ "admin-portal-quality.html","../../admin-portal/admin-access.html",
"../../../../toc.html","End User Handbooks",
"../../carnot-clients.html","@productname@ Portal",
"../admin-portal.html","Administration Perspective");
@@ -29,16 +29,8 @@
setting from the <strong>Portal Configuration</strong> view. The Preference Store Manager displays all the
preferences for the Portal Configuration view.
</p>
-
-<p>The user can change the preferences for the following:</p>
-<ul>
- <li>Select Column</li>
- <li>Portal Configuration</li>
- <li>Activity Criticality</li>
-</ul>
-
<p class="image"><a
href="images/prer-store_orgSize.png" target="_blank"><img
src="images/pref-store.png" alt=""></a> <br>
@@ -49,21 +41,124 @@
<li>Scope - Preferences are defined either for User or Tenant. User specific preference scope is defined for Portal Configuration and
selectable columns. The tenant specific scope is defined for Activity Criticality and some Portal configurations. </li>
<li>Module ID - Module ID of the corresponding preference</li>
- <li>Preference ID - Preference </li>
+ <li>Preference ID - Specified ID of the preference </li>
<li>Preference Name - Preference name specified in the preference store</li>
- <li>Value - displays what change is performed for the preference</li>
+ <li>Value - Displays what change is performed for the preference and default value, if any.</li>
</ul>
-<p>You can select following columns from the <strong>Select Columns</strong> option as described in section
-<a href="../../layout.html#selCol">Column Selection and Reordering</a>.</p>
-Bug is present ??????
+
+
+<h2>Searching Preferences</h2>
+<p>You can search for preferences based on user and tenant.</p>
+ <ul>
+ <li><a href="#ten">Searching Tenant Preferences</a></li>
+ <li><a href="#user">Searching User Preferences</a></li>
+ <li><a href="#fil">Filtering Preferences</a></li>
+</ul>
+
+<h3 id="ten">Searching Tenant Preferences</h3>
+<p>To search for tenant preferences, make sure that <strong>Search Tenant Preferences</strong> option is selected.
+These preferences are stored in partitions.</p>
+
+<p class="image"><img
+ src="images/tenant-pref.png" alt=""> <br>
+<strong>Figure:</strong> Search Tenant Preferences</p>
+
+<h3 id="user">Searching User Preferences</h3>
+ <p> To search for user preferences, select <strong>Search User Preferences</strong> option and
+ add the user name in the text box adjacent to it. Click <strong>Search</strong>.
+ The search result displays all the preferences changed by the specified user.</p>
+
+<p class="image"><img
+ src="images/user-pref-search.png" alt=""> <br>
+<strong>Figure:</strong> Search User Preferences</p>
+
+<h3 id="fil">Filtering Preferences</h3>
+<p>If you want to search for specific preference from the preference search result table, specify the
+preference name in the <strong>Filter</strong> text box and click <strong>Search</strong>. The search result
+displays the filtered preference.</p>
+
+
+<p class="image"><img
+ src="images/fitler.png" alt=""> <br>
+<strong>Figure:</strong> Filter Preferences</p>
+
+<h3 id="sorting">Sorting</h3>
+<p>The table may be sorted by any sortable column by clicking the sort icon
+<img src="images/sort-icon.png" alt=""> in the column header. The table data can be toggled
+between ascending and descending order when the sort icon is clicked.</p>
+<p>Please refer to the section <a href="../../layout.html#sorting">Sorting</a>
+of the chapter <a href="../../layout.html">@productname@ Portal Components</a>
+for detailed information.</p>
+
+<h2>Toolbar Actions</h2>
+<p>You can perform following operations on the preference store table.</p>
+
<ul>
- <li></li>
- <li></li>
+ <li><a href="#excel">Exporting Table Content</a></li>
+ <li><a href="#add">Adding a Preference</a></li>
+ <li><a href="#ed">Deleting a Preference</a></li>
+ <li><a href="#del">Editing a Preference</a></li>
</ul>
+<h3 id="excel">Exporting Table Content </h3>
+<p>The data in the table may be exported to an Excel or CSV file. To export
+to a file, click <img src="../../detail-views/images/excel_icon.png" alt=""> to export to Excel or
+<img src="../../detail-views/images/csv_icon.png" alt=""> to export to a CSV file.</p>
+<p>Please refer to the section <a href="../../layout.html#fileExport">Exporting Table Content</a>
+of the chapter <a href="../../layout.html">@productname@ Portal Components</a>
+for detailed information.</p>
+
+<h3 ID="add">Adding a Preference</h3>
+<p>To add the preference, perform the following steps:</p>
+<ol>
+ <li>Click the <strong>Add Preference</strong> <img src="images/add-pref.png">icon.
+ The <strong>Add Preference</strong> dialog box gets displayed.</li>
+ <p class="image"><img src="images/add-pref-dialog.png"
+ alt="Add Preference"><br></p>
+
+
+ <li>Specify following preference details. You can refer to the <a href="#list">preference list</a> to fill the details.
+ <ul>
+ <li>Module ID - Mandatory field</li>
+ <li>Preference ID - Mandatory field</li>
+ <li>Preference Name - Mandatory field</li>
+ <li>Value - Specify the new value for the preference</li>
+ <li>Scope - Tenant or User</li>
+
+ </ul></li>
+
+ <li>Click <strong>Ok</strong>. The preference gets added to the preference store. If the
+ preference already exists, the existing preference is overwritten.</li>
+
+</ol>
+
+<h3 id="ed">Editing a Preference</h3>
+<p>To edit the preference, perform the following steps:</p>
+<ol>
+ <li>Select the preference from the Preference Store table</li>
+ <li>Click the <strong>Edit Preference</strong><img src="images/edit-pref.png"> icon. The <strong>Edit Preference</strong> dialog gets displayed.</li>
+ <p class="image"><img src="images/edit-pref-dialog.png"
+ alt="Edit Preference"><br></p>
+
+ <li>Change the value and click <strong>Ok</strong>.</li>
+</ol>
-<h2>Preference List</h2>
+<h3 id="del">Deleting a Preference</h3>
+<p>To delete the preference, perform the following steps:</p>
+<ol>
+ <li>Select the preference row from the Preference Store table</li>
+ <li>Click the <strong>Delete Preference</strong> <img src="images/del-pref.png"> icon.
+ The <strong>Warning</strong> dialog gets displayed.</li>
+
+ <p class="image"><img src="images/del-pref-warn.png"
+ alt="Delete Preference - Warning"><br></p>
+
+
+ <li>Click <strong>Continue</strong> to delete the preference</li>
+</ol>
+
+<h2 id="list">Preference List</h2>
<p>The following tables describe preferences entries for:</p>
<ol>
@@ -810,7 +905,7 @@ based on each column. So preferences are displayed as number of rows * five for
<p>Also, note that for participant management the scope is partition. </p>
-<h3>Column Selectors</h3>
+<h3 id="col">Column Selectors</h3>
<p>For select columns feature, the scope is User.</p>
@@ -1041,129 +1136,6 @@ For example, Overview$#$Priority$#$Descriptors$#$Started$#$Last Modified </td>
-
-
-<h2>Searching Preferences</h2>
-<p>You can search for preferences based on user and tenant.</p>
- <ul>
- <li><a href="#ten">Searching Tenant Preferences</a></li>
- <li><a href="#user">Searching User Preferences</a></li>
- <li><a href="#fil">Filtering Preferences</a></li>
-</ul>
-
-<h3 id="ten">Searching Tenant Preferences</h3>
-<p>To search for tenant preferences, make sure that <strong>Search Tenant Preferences</strong> option is selected.
-The tenant preferences exist only for activity criticality.</p>
-
-<p class="image"><img
- src="images/tenant-pref.png" alt=""> <br>
-<strong>Figure:</strong> Search Tenant Preferences</p>
-
-<h3 id="user">Searching User Preferences</h3>
- <p> To search for user preferences, select <strong>Search User Preferences</strong> option and
- add the user name in the text box adjacent to it. Click <strong>Search</strong>.
- The search result displays all the preferences changed by the specified user.</p>
-
-<p class="image"><img
- src="images/user-pref-search.png" alt=""> <br>
-<strong>Figure:</strong> Search User Preferences</p>
-
-<h3 id="fil">Filtering Preferences</h3>
-<p>If you want to search for specific preference from the preference search result table, specify the
-preference name in the <strong>Filter</strong> text box and click <strong>Search</strong>. The search result
-displays the filtered preference.</p>
-
-
-<p class="image"><img
- src="images/fitler.png" alt=""> <br>
-<strong>Figure:</strong> Filter Preferences</p>
-
-
-
-<h2>Toolbar Actions</h2>
-<p>You can perform following operations on the preference store table.</p>
-
-<ul>
- <li><a href="#col">Select Columns</a></li>
- <li><a href="#excel">Exporting Table Content</a></li>
- <li><a href="#add">Adding a Preference</a></li>
- <li><a href="#ed">Deleting a Preference</a></li>
- <li><a href="#del">Editing a Preference</a></li>
-</ul>
-<h3 id="col">Select Columns</h3>
-<p>You can select the columns to be displayed in table and reorder them.</p>
-<p>Click the <strong>Select Columns</strong>
-icon <img src="../../detail-views/images/select-column-icon.png" alt=""> to open
-the <strong>Select Columns</strong> dialog, which is described
-in detail in the section <a href="../../layout.html#selCol">Column Selection and Reordering</a>
-of the chapter <a href="../../layout.html">@productname@ Portal Components</a>.</p>
-
-<p class="image"><img src="../../detail-views/images/selectcolumn.png"
- alt="Column Selection and Reordering"><br></p>
-
-<h3 id="excel">Exporting Table Content </h3>
-<p>The data in the table may be exported to an Excel or CSV file. To export
-to a file, click <img src="../../detail-views/images/excel_icon.png" alt=""> to export to Excel or
-<img src="../../detail-views/images/csv_icon.png" alt=""> to export to a CSV file.</p>
-<p>Please refer to the section <a href="../../layout.html#fileExport">Exporting Table Content</a>
-of the chapter <a href="../../layout.html">@productname@ Portal Components</a>
-for detailed information.</p>
-
-<h3 ID="add">Adding a Preference</h3>
-<p>To add the preference, perform the following steps:</p>
-<ol>
- <li>Click the <strong>Add Preference</strong> <img src="images/add-pref.png">icon.
- The <strong>Add Preference</strong> dialog box gets displayed.</li>
- <p class="image"><img src="images/add-pref-dialog.png"
- alt="Add Preference"><br></p>
-
-
- <li>Specify following preference details. You can refer to the preference list to fill the details.
- <ul>
- <li>Module ID - Mandatory field</li>
- <li>Preference ID - Mandatory field</li>
- <li>Preference Name - Mandatory field</li>
- <li>Value - Specify the new value for the preference</li>
- <li>Scope - Tenant or User</li>
-
- </ul></li>
-
- <li>Click <strong>Ok</strong>. The preference gets added to the preference store. If the
- preference already exists, the existing preference is overwritten.</li>
-
-</ol>
-
-<h3 id="ed">Editing a Preference</h3>
-<p>To edit the preference, perform the following steps:</p>
-<ol>
- <li>Select the preference from the Preference Store table</li>
- <li>Click the <strong>Edit Preference</strong><img src="images/edit-pref.png"> icon. The <strong>Edit Preference</strong> dialog gets displayed.</li>
- <p class="image"><img src="images/edit-pref-dialog.png"
- alt="Edit Preference"><br></p>
-
- <li>Change the value and click <strong>Ok</strong>.</li>
-</ol>
-
-<h3 id="del">Deleting a Preference</h3>
-<p>To delete the preference, perform the following steps:</p>
-<ol>
- <li>Select the preference row from the Preference Store table</li>
- <li>Click the <strong>Delete Preference</strong> <img src="images/del-pref.png"> icon.
- The <strong>Warning</strong> dialog gets displayed.</li>
-
- <p class="image"><img src="images/del-pref-warn.png"
- alt="Delete Preference - Warning"><br></p>
-
-
- <li>Click <strong>Continue</strong> to delete the preference</li>
-</ol>
-
-
-
-
-
-
-
<script language="JavaScript" type="text/javascript">
<!--
writeFooter();
diff --git a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html
index ba60ef7..d916277 100644
--- a/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html
+++ b/org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html
@@ -12,7 +12,7 @@
<script language="JavaScript" type="text/javascript">
<!--
writeNavigation("Administration Perspective Access Control","PLUGINS_ROOT/org.eclipse.stardust.docs.dev/html/toc.html",
- "admin-portal-criticality.html","../../admin-portal/admin-access.html",
+ "admin-portal-criticality.html","admin-portal-prefstore.html",
"../../../../toc.html","End User Handbooks",
"../../carnot-clients.html","@productname@ Portal",
"../admin-portal.html","Administration Perspective");
diff --git a/org.eclipse.stardust.docs.enduser/usertoc.xml b/org.eclipse.stardust.docs.enduser/usertoc.xml
index ed6564a..481951a 100644
--- a/org.eclipse.stardust.docs.enduser/usertoc.xml
+++ b/org.eclipse.stardust.docs.enduser/usertoc.xml
@@ -112,6 +112,8 @@
</topic>
<topic href="html/handbooks/execution-clients/admin-portal/views/admin-portal-quality.html"
label="Quality Assurance Management" />
+ <topic href="html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html" label="Preference Store Manager">
+ </topic>
<topic label="Administration Perspective Access Control"
href="html/handbooks/execution-clients/admin-portal/admin-access.html" />
</topic>