summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVrishali Doke2012-05-30 03:16:21 (EDT)
committerStephan Born2012-06-15 10:41:14 (EDT)
commit525661c9efa97b4797b8ef69ee7a6a7fbc4cb37c (patch)
tree19751b395a8f9dfb883d748b8aa721d10676ad3c
parent4a68489585567ae918fb763abd2318a3b56d8f57 (diff)
downloadorg.eclipse.stardust.documentation-525661c9efa97b4797b8ef69ee7a6a7fbc4cb37c.zip
org.eclipse.stardust.documentation-525661c9efa97b4797b8ef69ee7a6a7fbc4cb37c.tar.gz
org.eclipse.stardust.documentation-525661c9efa97b4797b8ef69ee7a6a7fbc4cb37c.tar.bz2
CRNT-24824 - Added preference store manager view
git-svn-id: http://emeafrazerg/svn/ipp/product/trunk/stardust/documentation@56697 8100b5e0-4d52-466c-ae9c-bdeccbdeaf6b
-rw-r--r--org.eclipse.stardust.docs.enduser/html/handbooks/execution-clients/admin-portal/views/admin-portal-prefstore.html544
1 files changed, 497 insertions, 47 deletions
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 c333004..b72e92f 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
@@ -47,10 +47,10 @@
<p>By default, following columns are displayed in the Preference Store Manager view.</p>
<ul>
<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 configurations. </li>
+ 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 Name - Preference name specified the preference store</li>
+ <li>Preference Name - Preference name specified in the preference store</li>
<li>Value - displays what change is performed for the preference</li>
</ul>
@@ -68,6 +68,7 @@ Bug is present ??????
<p>The following tables describe preferences entries for:</p>
<ol>
<li><a href="#pan">Configuration Panel</a></li>
+ <li><a href="#crit">Activity Criticality</a></li>
<li><a href="#col">Column Selectors</a></li>
</ol>
@@ -324,17 +325,7 @@ Bug is present ??????
</td>
</tr>
- <tr>
- <td>Worklist</td>
- <td>ipp-workflow-perspective </td>
- <td>preference</td>
- <td>ipp-workflow-perspective.worklist.prefs.filterProviders</td>
- <td>User Created entries
- </td>
- <td>Filter Provider
- </td>
- </tr>
<tr>
<td>Activity Panel
</td>
@@ -523,74 +514,533 @@ Bug is present ??????
</tr>
</table>
-<p>For the following configuration panels, the scope is Partition.</p>
+<p>For the following configuration panel settings, the scope is Partition.</p>
<table>
<tr>
+ <th>Configuration View</th>
+ <th>Module ID</th>
+ <th>Preference ID</th>
+ <th>Preference Name</th>
+ <th>Possible Values</th>
+ <th>Description</th>
+ </tr>
+ <tr>
<td>Traffic Light</td>
- <td>traffic-light-view </td>
- <td>preference</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
<td>Infinity.Monitoring.TrafficLightView.ProcessDefinitionIds</td>
- <td>List of Process Definations</td>
+ <td>List of Process Definitions</td>
<td>Select Process Definitions for Traffic Light configuration </td>
</tr>
<tr>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.StateCalculator </td>
+ <td>Populated for selected process or User Created
+ </td>
+ <td>State Calculator for selected Process
+ </td>
</tr>
<tr>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.DescriptorFilter </td>
+ <td>Populated for selected process or User Created </td>
+ <td>Descriptor Filter for selected Process
+ </td>
</tr>
<tr>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.DisplayTotalRow </td>
+ <td>True or False
+ </td>
+ <td>Display Total Row Selection
+ </td>
+
+ </tr>
+ <tr>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.ProcessingThreshold.&lt;ActivityId&gt;</td>
+ <td>User Entered
+ </td>
+ <td>Threshold value for given &lt;ActivityId&gt;</td>
</tr>
<tr>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.ColumnActivityIds </td>
+ <td>Activity Id for given Activity
+ </td>
+ <td>Activity Id
+ </td>
</tr>
<tr>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
- <td></td>
+ <td>Traffic Light</td>
+ <td>bcc</td>
+ <td>traffic-light-view</td>
+ <td>Infinity.Monitoring.TrafficLightView.&lt;ProcessQualifierId&gt;.RowDataId </td>
+ <td>Populated for process.
+
+ </td>
+ <td>Row Data Id
+ </td>
+
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.plannedStartTimeHHHH </td>
+ <td>Populated for Process Selected or User Entered in HHMM format </td>
+ <td>Planned Start Time
+ </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.plannedTerminationTimeHHHH </td>
+ <td>Populated for Process Selected or User Entered in HHMM format
+ </td>
+ <td>Planned Termination Time
+ </td>
</tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.predecessor </td>
+ <td>Selection from populated list based on process selected.
+ </td>
+ <td>Predecessor selection
+ </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.successor </td>
+ <td>Selection from populated list based on process selected. </td>
+ <td>Successor selection </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.thresholdPercentage </td>
+ <td>Populated for selected process or User entered
+ </td>
+ <td>Threshold Percentage
+ </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.estimatedDurationSeconds </td>
+ <td>Populated for selected process or User entered </td>
+ <td>Estimated Duration
+ </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.instance.descriptor.key </td>
+ <td>Populated for selected process </td>
+ <td>Id for descriptor
+ </td>
+ </tr>
+ <tr>
+ <td>Gantt Chart
+ </td>
+ <td>bcc</td>
+ <td>gantt-chart</td>
+ <td>Infinity.Monitoring.GanttChartView.&lt;ProcessQualifierId&gt;.instance.descriptor.values </td>
+ <td>Populated for selected process or User entered
+ </td>
+ <td>Value for descriptor
+ </td>
+ </tr>
+ <tr>
+ <td>Worklist</td>
+ <td>ipp-workflow-perspective </td>
+ <td>preference</td>
+ <td>ipp-workflow-perspective.worklist.prefs.filterProviders</td>
+ <td>User Created entries
+ </td>
+ <td>Filter Provider
+ </td>
+ </tr>
+
+
+
+</table>
+<h3 id="crit">Activity Criticality</h3>
+<p>For the activity criticality settings, the scope is Partition. For activity criticality categories, preferences are stored
+based on each column. So preferences are displayed as number of rows * five for each column of criticality category.</p>
+<table>
+ <tr>
+ <th>Configuration View</th>
+ <th>Module ID</th>
+ <th>Preference ID</th>
+ <th>Preference Name</th>
+ <th>Possible Values</th>
+ <th>Description</th>
+ </tr>
+
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range.TotalCount</td>
+ <td>1 - 1000
+ </td>
+ <td>Total number of criticality categories</td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range&lt;n&gt;.LowerBound
+ </td>
+ <td>0 - 999
+ </td>
+ <td>Lower limit for nth criticality category (one entry per category)
+ </td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range&lt;n&gt;.UpperBound
+</td>
+ <td>1 - 1000
+ </td>
+ <td>Upper limit for nth criticality category (one entry per category)</td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range&lt;n&gt;.Label </td>
+ <td>String </td>
+ <td>Criticality label for nth criticality category (one entry per category) </td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range&lt;n&gt;.Icon </td>
+ <td>File path to an image
+ </td>
+ <td>Criticality icon to use for nth criticality category (one entry per category) </td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>ipp-admin-portal </td>
+ <td>workflow-criticality-categories </td>
+ <td>Criticality.Ranges.Range&lt;n&gt;.IconDisplay </td>
+ <td>1 - 5</td>
+ <td>Number of criticality icons to display for nth criticality category (one entry per category)</td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>engine-internals </td>
+ <td>workflow-criticalities </td>
+ <td>Criticality.Recalc.OnSuspend </td>
+ <td>True or False</td>
+ <td>Flag indicating weather to recalculate criticality after the activity is suspended
+ </td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>engine-internals </td>
+ <td>workflow-criticalities</td>
+ <td>Criticality.Recalc.OnCreate </td>
+ <td>True or False</td>
+ <td>Flag indicating weather to recalculate criticality after the activity is created
+ </td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>engine-internals </td>
+ <td>workflow-criticalities</td>
+ <td>Criticality.Recalc.OnPriorityChange </td>
+ <td>True or False</td>
+ <td>Flag indicating weather to recalculate criticality after the activity's priority is changed.</td>
+ </tr>
+ <tr>
+ <td>Activity Criticality</td>
+ <td>engine-internals </td>
+ <td>workflow-criticalities</td>
+ <td>Criticality.Formula.Default </td>
+ <td>A javascript formula that returns a double value in range [0, 1]
+ </td>
+ <td>Default criticality formula
+ </td>
+ </tr>
</table>
+<p>Also, note that for participant management the scope is partition. </p>
+
+<h3>Column Selectors</h3>
+<p>For select columns feature, the scope is User.</p>
+
+
+
+<table>
+ <tr>
+ <th>Perspective</th>
+ <th>Module ID</th>
+ <th>Preference ID</th>
+ <th>Preference Name</th>
+ <th>Possible Values</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>Workflow Perspective</td>
+ <td>ipp-workflow-perspective</td>
+ <td>Preference</td>
+ <td>ipp-workflow-perspective.motu.selectedColumns<br>
+ <p>Note that for the preference name the default value is worklist. Other values
+ are based on locations from which this is called. These locations are: Account Name,
+ Role Name, lastNWorkedOn, allResubmissionInstances and allActivityInstances.</p>
+ </td>
+ <td>List of Columns IDs separated by special value '$#$'
+For example, Overview$#$Priority$#$Descriptors$#$Started$#$Last Modified </td>
+ <td>Standard Worklist
+ </td>
+ </tr>
+ <tr>
+ <td>Workflow Perspective</td>
+ <td>workflow-perspective</td>
+ <td>Preference</td>
+ <td>workflow-perspective.documentSearch.selectedColumns</td>
+ <td>List of column IDs separated by special value '$#$'. For example,
+ authorFullNames$#$createDate$#$modificationDate$#$fileType$#$documentType$#$
+ fileSize$#$metadata
+ </td>
+ <td>Documents Search
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective
+ </td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.overview.selectedColumns</td>
+ <td>List of column IDs separated by special value '$#$'.</td>
+ <td>Log Entries s</td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-views-common </td>
+ <td>Preference</td>
+ <td>ipp-views-common.processTable.selectedColumns</td>
+ <td>Not Applicable</td>
+ <td>Standard Processes
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-views-common </td>
+ <td>Preference</td>
+ <td>ipp-views-common.activityWithPrio.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Standard Activities </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>views-common</td>
+ <td> Preference</td>
+ <td>views-common.mytab.processInstanceHistory.selectedColumns</td>
+ <td>Not Applicable</td>
+ <td>Process History-Process Table
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>common</td>
+ <td>Preference</td>
+ <td>common.mytab.processHistory11.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Process History-Activity Table
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.userGroupMgmt.selectedColumns</td>
+ <td>Not Applicable</td>
+ <td>All User Groups</td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.realm.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Standard Realms </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.daemons.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Standard Daemon Action
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.modelManagementView.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Model Management </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>ipp-administration-perspective </td>
+ <td>Preference</td>
+ <td>ipp-administration-perspective.userMgmt.selectedColumns</td>
+ <td>Not Applicable</td>
+ <td>All Users </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>contextPortal</td>
+ <td>Preference</td>
+ <td>contextPortal.VersionHistory.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Document Version History
+ </td>
+ </tr>
+ <tr>
+ <td>Administration Perspective</td>
+ <td>contextPortal</td>
+ <td>Preference</td>
+ <td>contextPortal.Participant.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Participant rights for document/folder.
+ </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.priorityView.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Priority Overview </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center."TrafficLightView" + processDefinationId
+.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Traffic Light View</td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.CompletedActivity.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Overview of Completed Activities</td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.postponedActivities.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Overview of Postponed Activities </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.ProcessResourceRoleMgmt.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Standard Roles and Organizations </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.ProcessResourceUserMgmt.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Users </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.roleAssignment.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Role Overview and their Current State </td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.performanceTeamLeader.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Overview of Completed Activities by Team Leader</td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.roleAssigned.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Assigned Roles information</td>
+ </tr>
+ <tr>
+ <td>Business Control Center Perspective</td>
+ <td>ipp-business-control-center </td>
+ <td>Preference</td>
+ <td>ipp-business-control-center.roleAssignable.selectedColumns </td>
+ <td>Not Applicable</td>
+ <td>Assignable Roles information</td>
+ </tr>
+
+</table>
+
+
-<h3 id="col">Column Selectors</h3>
<h2>Searching Preferences</h2>