Configuring Worklists

The Worklist section allows administrators to filter worklist items and set configurations for participants and process worklists. Note that it is not accessible if you have no administrator rights.

Worklist configuration
Figure: Worklist configuration

Filter Providers

You can control the viewing of a user's worklist depending on specific criteria. This criteria can be set in a Filter Provider class, which can be referenced in the Worklist configuration. Note that you need to add the class to the classpath of your Web project and restart your server. For details on how to create a filter provider class, please refer to section Creating a Filter Provider to Filter Worklists of chapter Filter Criteria in the Programming Guide. section Creating a Filter Provider to Filter Worklists of chapter Filter Criteria in the Programming Guide.

To apply the filter, enter a name for the filter and the Java class file name including the package in the Filter Providers text box. Save these configuration settings.

For example, if you have a filter provider class LocationFilter, which filters for specific data depending on a specific user grant, you add this class with a filter name to the Filter Providers entry field as shown below. The items in the worklist of a logged-in user will be filtered by the criteria given in the class.

Worklist filter configuration
Figure: Worklist filter configuration

You can add more than one filters by adding them in a comma separated list, for example:

Worklist filter configuration
Figure: Worklist filter configuration for multiple filters

For details on creating and applying worklist filters, please refer to chapter Creating and Applying a Worklist Filter in our Tutorial Guide. Creating and Applying a Worklist Filter in our Tutorial Guide.

Adding Filter Providers via Properties

You also have the option to set filters in your carnot.properties file. Property Carnot.ProcessPortal.FilterProvider.<filtername> has to be set to the full qualified name of the provider class, e.g.:

Carnot.ProcessPortal.FilterProvider.locationFilter = org.eclipse.stardust.examples.filter.LocationFilter
Carnot.ProcessPortal.FilterProvider.cdateFilter = org.eclipse.stardust.examples.filter.CreationDateFilter

With property Carnot.ProcessPortal.FilterProviders you determine which filters should be used. If you like to use more than one filter, add the filter names in a comma separated list, e.g.:

Carnot.ProcessPortal.FilterProviders = locationFilter,cdateFilter

Please refer to section Portal Properties of chapter Client Side Properties in the Stardust Documentation - Developer Handbook Portal Properties of chapter Client Side Properties of the Developers Handbook for details on these properties.

Note
Filters set in the carnot.properties file have precedence over filters set in the Portal configuration. If properties are set in the carnot.properties file, the filter provider settings of the Portal Worklist configuration will be ignored.

Auto-Refresh

In the Auto-Refresh section, you can set a refresh interval to refresh the worklist and launch panel. The value is set in minutes. Accepted values are whole numbers between 1-100. By default, the entry field is blank and no auto-refresh is performed.

Participant Worklist Configuration

The default configuration for all participants is provided in the table per default. You can change the default configuration or add participants you like to change the configuration for. The following functionality is available for participant worklist configurations:

Process Worklist Configuration

The default configuration for all processes is provided in the table per default. You can change the default configuration or add processes you like to change the configuration for. The following functionality is available for process worklist configurations: