Manage system fields
You can modify the list of exposed system fields on a roster, queue, event log, or application space. Exposing a field makes it available for use in
a search filter or an index. Adding a system field to the list of exposed fields
does not create the field—the workflow system does that. In the same way, removing
a field from the list of exposed fields does not delete the field—it simply
makes the field unavailable for the uses listed above.
Requirements for system field exposure fall into three categories.
- Fields that must be exposed in a roster, queue, event log, or application space for Process Engine (PE) to function properly. Most system fields fall into the this category. A System symbol next to the field indicates that it is required.
You cannot delete or modify one of these fields.
- Fields that are used by various Application Engine- or web server-based
workflow applications. Fields in this category must be exposed for the applications
to function properly. However, if you develop your own applications that do
not require these fields, you can leave fields in this category unexposed.
These fields are not marked with an icon, but by default they are automatically
added to the list of exposed system fields when you create a new roster, queue,
or event log.
- Fields that are optional. These are not required by either PE
or by Application Engine-based or web server-based workflow applications.
For a list of all system fields, their definition, and requirements, see System
fields.
To add, remove, or modify system fields
- If the Properties dialog box is not already displayed, select the icon
of the queue, roster, event log, or application space you wish to modify and click Properties
on the toolbar.
- Select the System Fields tab.
- Click New to display the System Fields Selection dialog box. The Available items box contains a list of the optional system fields.
- To add system fields, select one or more items from the Available
items list and click Add.
To remove system fields, select one or more items from
the Selected items list and click Remove. You can also
remove system fields by selecting them directly in the System Fields list
(if the fields have not been transferred yet), and clicking Delete.
NOTE You
cannot remove a system field when it:
- is a mandatory field.
- is currently used in an index. You must first delete
the field from the index.
- Click OK to close the System Fields Selection
dialog box.
- Process Configuration Console
automatically enters the Field Type and Length
of each selected item. You cannot change the field type of any system field;
in rosters and queues, you can change the length of non-mandatory system fields
that are strings.
NOTE You cannot change the length of any system field in an event log.
- Click OK when done.
- Click Commit Changes
on the toolbar
to apply this change to your isolated region. You can commit the changes immediately,
or you can wait until you have finished all your changes.
NOTE Following
the committal, in the runtime environment (for example, the Workplace Tasks
page) the changes will be reflected only in work items that:
- Were created after the committal, or
- (If the changes were on a queue) entered the queue after the committal.