Figure: Workflow Execution Launch Panel
The Workflow Execution perspective provides the following launch options:
Figure: Workflow Execution Launch Panel
You can hide the launch panels by selecting the following icon:
Figure: Hiding the Launch Panels
The Overview section provides an overview over available workitems and a link to activities the logged-in user has been working on.
Figure: Overview Launch Panel
The first part of the Overview section displays available work items depending on some criteria. Clicking on the items opens the General Worklist View displaying the resulting activities.
Figure: Direct Worklist
In case the property Stardust.Engine.Tuning.Query.ExcludeUser.Evaluation is set to true and activities have ExcludeUser actions applied, you can set a maximum worklist count in your carnot.properties file. The property Stardust.Engine.Tuning.Query.ExcludeUser.MaximumWorklistCount determines the maximum number of worklist items, that is displayed in the worklist counts. Refer to section Tuning of chapter Server Side Properties in the Operation Guide Tuning of chapter Server Side Properties in the Online Documentation - Operation Guide for details.
For example, if you set the following properties in your carnot.properties file, the total worklist count will be displayed as More than 10 total worklist item(s) if it exceeds 10.
Stardust.Engine.Tuning.Query.ExcludeUser.Evaluation = true Stardust.Engine.Tuning.Query.ExcludeUser.MaximumWorklistCount = 10
Figure: Total workitems with maximum value
In second part of the Overview section provides a list, in which the logged-in user can select a time frame to display activity instances he has been working on. In the select box he can choose one of the following:
Figure: Select Time Frame
Choosing a time frame opens the General Worklist View displaying the resulting activities.
In the My Startable Processes launch panel, you can see the list of processes you are allowed to start. This list will show all processes having a manual trigger with a role that is assigned to the currently logged-in user. Note that in case a process does not appear in your startable process list as expected, a manual trigger might be missing in this process to trigger the process.
Figure: The Startable Processes View
A process can be started by clicking on the process name. To refresh the
view, click the Refresh icon
in the upper right corner of the section.
If the Description is added in the Properties page for the process in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the process name.
Figure: Tooltip Text of a Process
Manually triggering process instances on behalf of scoped participants sets the department data accordingly in order to make sure that any follow-up activity instance is created in the correct target department. If the department cannot be uniquely determined during a process start, a dialog opens where you can select the participant in the department to be used. This happens in the following cases:
In those cases the dialog mentioned above opens with a list of all possible participant-department combinations, e.g. as displayed in the following screenshot:
Figure: Select the Participant.
Click the participant in the department to be used to continue the triggering process. Select Close to cancel the role/department selection.
The launch panel My Assignments displays all the items being bound to nodes in a hierarchical participant tree. It contains a list of:
the logged-in user is assigned to and which have at least one worklist item. The item entry is followed by a link listing the number of workitems within the corresponding worklist.
Roles within departments are listed as follows:
Role Name (department.[parent department.[..]])
Scoped Organizations are displayed as follows:
Organization Name (department.[parent department.[..]])
Figure: Worklist by Role
Note that if the user has attached the image to the profile from the Configuration panel then the user picture is displayed in the User Worklist of My Assignments panel. However, note that the image size is 16*16.
Figure: My Assignments - User Image
To refresh the
view, click the Refresh icon
in the upper right corner of the section.
Participants can be configured for assembly line mode in their modeler property pages by setting the task assignment mode to Assign Automatically. For information on how to set this property, please refer to the section Task Assignment of the chapter Modeling the Organizational Structure in the Stardust Documentation - Modeling Guide Task Assignment of the chapter Modeling the Organizational Structure in the Modeling Guide.
In case the assembly line mode is supported (please see section Assembly line mode support) and the logged-in user is assigned to roles or organizations that are configured for assembly line mode, entries for the logged-in user with Assembly Line mode are displayed at the top of the entries list.
The Assembly Line entry displays a link with the number of live activities in the user's assembly line worklist.
Figure: Assembly Line Entries
Clicking the link gets the next activity from the assembler, activates the activity and sets the Stardust Portal in Assembly Line mode.
You can determine if the assembly line mode is supported by adding the property Carnot.BpmClient.Features.AssemblyLineTaskAssignment to your carnot.properties file, residing in the ipp-resources folder of your Web application. If set to false, the assembly line mode is not supported and no assembly line entries are displayed in the My Assignments section.
Carnot.BpmClient.Features.AssemblyLineTaskAssignment = false
Setting the property to true, which is the default value, the assembly line mode will be supported again.
The logic to decide which assembly line has to be activated next is implemented via an assembly line activity provider class, which has to implement the interface IAssemblyLineActivityProvider. The property Carnot.ProcessPortal.AssemblyLineActivityProvider determines the provider class to use. Per default, this is set to:
Carnot.ProcessPortal.AssemblyLineActivityProvider =
org.eclipse.stardust.ui.web.processportal.common.DefaultAssemblyLineActivityProvider
In case you created a custom implementation class, change the value accordingly. Please refer to chapter Implementing an Assembly Line Activity Provider of the section Implementing Interfaces for Portal Configurations in the Stardust Documentation - Modeling Guide Implementing an Assembly Line Activity Provider of the section Implementing Interfaces for Portal Configurations in the Modeling Guide for detailed information on the interface.
In case activity criticality is set, the assembly line provider reduces the top element from an activity list for the relevant participant, ordered by:
Second and third criteria are applied when multiple activity instances have identical criticality.
To implement the activity criticality, the assembly line provider should point to the class called org.eclipse.stardust.ui.web.processportal.common.CriticalityAwareAssemblyLineActivityProvider instead of DefaultAssemblyLineActivityProvider class. To use the given criticality criteria to order the worklist, following property should be set in the Carnot.properties file:
Carnot.ProcessPortal.AssemblyLineActivityProvider = org.eclipse.stardust.ui.web.processportal.common.CriticalityAwareAssemblyLineActivityProvider
For example, activity one and activity two have normal priority and medium criticality. Activity three has high priority and high criticality. Activity two is initiated first and then the activity one is initiated. In this case in assembly line provider, the order of the activity execution would be as follows:
For details on activity criticality, refer to chapter Activity Criticality of the Stardust Concepts section. Activity Criticality of the Stardust Concepts section.
In case you prefer to see all worklists, also those having no items, select the Show empty Worklists checkbox.
Figure: Empty Worklists hidden.
In case the name of the worklist entry is too long to be displayed, a tooltip is displayed with the whole name in case you hover your mouse over the entry.
Figure: Tooltip for long worklist entries
Select the x item(s) link to get an overview of the according pending activities:
Figure: The Pending Activities of the selected Role
Please refer to the chapter General Worklist View for information about working in this overview.
The launch panel My Processes provides a list of all process definitions the logged-in user participates in one of the following ways:
Figure: My Processes
In case you have the ability to start an activity in a process definition, the x item(s) entry on the right side of the process definition is enabled. To get an overview of the according pending activities, click on the according item entry.
To refresh the
view, click the Refresh icon
in the upper right corner of the section.
If the processes contain excluding users event handlers, you have the option to set a maximum worklist count in your carnot.properties file, as described in section Limited maximum worklist count for Workitems in the Overview section.
For example, if you set the following properties in your carnot.properties file, the workitems count for the processes you participate in will be displayed as More than 10 total worklist item(s) if it exceeds 10.
Stardust.Engine.Tuning.Query.ExcludeUser.Evaluation = true Stardust.Engine.Tuning.Query.ExcludeUser.MaximumWorklistCount = 10
Figure: Maximum Worklist Count
If the Description is added in the Properties page for the process in modeler, then it is displayed as tooltip text in the portal when you hover the mouse over the process name in My Processes panel.
Figure: My Processes
The Documents section provides the option to launch the following views:
Figure: Documents Launch Panel
The Stardust Workflow Execution Perspective provides predefined search filters for:
To start a search, select one of the provided search filters in the Activity Search section.
Note that only activities are taken in account the user has the declarative security permissions Read Process Instance Data and Read Activity Instance Data for. These permissions are defined in the modeler for the process definition and the activity accordingly. Please refer to the section Authorization for Activities Authorization for Activities for detailed information on the Read Activity Instance Data permission and the section Authorization for Process Definitions of the chapter Authorization in the Stardust Online Documentation - Modeling Guide Authorization for Process Definitions of the Authorization chapter in the Modeling Guide for detailed information on the Read Process Instance Data permission accordingly.
Figure: Activity Search Launch Panel
Select this search to filter activity instances waiting for resubmission. Please refer to the section Resubmission of the Activities Execution View chapter for details on how to set an activity for resubmission.
Figure: Search Activities for Resubmission
Now all activities waiting for resubmission are displayed in an overview, providing information on the search result activities.
Figure: Pending Activities for Search Result Pane
If you like to see all activities select the All available activities option:
Figure: Search for all available Activities.
An All available activities pane opens, displaying:
In case a displayed activity instance belongs to a foreign worklist, a direct performing is not possible. To perform the activity, the user has to delegate it to himself first. However the following functionalities can be invoked for such activity instances:
Figure: All Available Activities Search Result.
Figure: Search for all available Activities.
Please note that the activity search retrieves the result from all the department scopes.
To filter for the worklist of a specific user, select User worklist.
Figure: Search for User Worklist.
An entry field opens where you can choose the user. In the Pattern field type in a pattern the listed user names should contain or leave the field empty to show all the available user names. Click the Search button to display appropriate users.
Figure: Click to start the Search.
Now a list with users containing the search string in their name are listed below the launch entries.
Figure: Resulting Users.
All the activities of logged in user are displayed. Click on the user name to open the worklist.
Figure: Worklist of Users.
Note that it is not possible to activate an item of a foreign worklist. To work on an item from this list, the user has to delegate it to himself first.