Search properties

Define the search criteria for a Work queue control to search for the required activities and allow editing of a query.

Allow query edit

If selected, allows creating, editing, and deleting queries at runtime.

Allow query selection

Allow query selection at runtime or display the work queue based on the selected predefined query or define the search criteria at design time.

Allow query selection at runtime

To view queries at runtime, select Allow query selection (Default: Selected). The following options are displayed:

  • Display queries as: Select the view for the queries to display. Queries can be displayed in Tree or Dropdown view. (Default: Tree)

  • Expand query list: Displays the expanded query list at runtime.

    The Expand query list option is only available when queries are displayed in a tree view.

  • Query types: Select the query type to view.

    • All: Allows you to view both private and shared queries.

    • Private: Allows you to view only private queries.

    • Shared: Allows you to view only shared queries.

Select a predefined query at design time

  1. Clear Allow query selection.
  2. Select Query for Initialize with.
  3. Optional. On the Query list, select a query that will be used to load the initial list of activities in the work queue.

    If you do not set a query and load the form at runtime, the work queue control appears but no items are listed. If you set a query dynamically, the control appears at runtime, and the query is applied when the action executes and displays the items returned from the query result.

Specify custom search criteria

To define the search criteria that will be used to load the initial list of activities in the work queue, do the following.

  1. Clear Allow query selection.
  2. Select Custom search for Initialize with.
  3. Set the criteria, as needed.

    The following table describes the criteria available for a custom search.

    Work Queue Field Description

    Return query total

    If selected, allows viewing of the total number of items matching the query.

    At runtime, the total number of items regardless of the retrieval limit specified in the query is displayed.

    If you select this option, there will be a performance overhead.

    Process

    Name of the process.

    Activity name

    Name of the activity.

    Type

    Type of work queue. (Default: All)

    Available options are:

    • All
    • Normal
    • Alert

    Case tasks only

    Displays only activities that belong to cases.

    Priority type

    Allows selection of Activity or Job. (Default: Activity)

    Priority

    Priority for the activity.

    The value ranges from 1 to 10. For Job Priority, the accepted values are 1 to 10. 1 being the highest and 10 being the lowest.

    Due date order

    Allows selection of Activity or Job. (Default: Activity)

    Assigned to

    The resources to whom the activity is assigned. Select either Individual or Individual and group.

    Activity SLA

    The status of the activity. The activity SLA (Green-Amber-Red) status is the visual representation of the activity status on your work queue to indicate if the activity is within or has exceeded the set time limits, that is, target duration.

    Job SLA

    The status of the job. The job SLA (Green-Amber-Red) status is the visual representation of the job status on your work queue to indicate if the job is within or has exceeded the set time limits, that is, target duration.

    Case reference

    Case reference based on which the job is created.

    Job ID

    The ID of the job.

    Job state

    Name of the state associated with the process.

    Work type

    The work type associated with the process.

    Metadata fields

    Create filter criteria by selecting the work type and selecting variables in the corresponding fields. See Create metadata.

    Retrieval limit

    The number of the latest activities that are to be retrieved from the server at a given point in time.

  4. You can also configure the work queue columns.
    1. Click Configure for Work queue columns.

      The Work queue columns dialog box is displayed. The default width is displayed against each column and by default, some columns are selected to be displayed at run time.

    2. Select the column, such as Pending Time, and click .
    3. Select the check box to show the column at run time.
    4. Increase or decrease the value, as needed, to set the width of the column.

      For a date field such as Due Date or Pending Time, you can additionally set the Time format to be Date or Date Time.

    5. Click OK.
    6. Click Save.

Allow query edit

You can allow or restrict editing queries at runtime. The Allow query edit option is only available if Allow query selection is selected.

  • To allow editing queries at runtime, ensure Allow query edit is selected.

  • To restrict editing queries at runtime, clear Allow query edit and then select the type of query on the Query types list.

    • All: Allows you to view both private and shared queries.

    • Private: Allows you to view only private queries.

    • Shared: Allows you to view only shared queries.

    If you restrict editing queries, you can only view queries but cannot create, modify, or delete them.