Managing 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.

About this task

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 use in a search filter or an index.

Requirements for system field exposure fall into three categories.

  • Fields that must be exposed in a roster, queue, event log, or application space for the workflow system to function properly. Most system fields fall into 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 client 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 the workflow system or by client workflow applications.

Procedure

To add, remove, or modify system fields:

  1. If the Properties window is not already displayed, select the icon of the queue, roster, event log, or application space you want to modify and click Properties on the toolbar.
  2. Click the System Fields tab.
  3. Click New to display the System Fields Selection window. The Available items window contains a list of the optional system fields.
  4. Add or remove system fields.
    Important: You cannot remove a system field under the following conditions:
    • The system field is a mandatory field.
    • The system field is currently used in an index. You must first delete the field from the index.
  5. Click OK to close the System Fields Selection window.
    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.
    Important: You cannot change the length of any system field in an event log.
  6. Click OK when done.
  7. 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.
    Important: Following the committal, the changes are reflected in the runtime environment only in work items that were created after the committal or in work items that entered the queue after the committal.