Welcome > User interface > Forms > Toolbox > Advanced controls > Work queue control > Properties of a Work queue control > Search properties

Search properties

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

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 and allow editing queries at runtime, select Allow query selection (Default: Clear). The following options are displayed:

  • Display queries as: To display queries in tree or dropdown view at runtime, select Tree or Dropdown. (Default: Tree)

    Note If you upgrade to TotalAgility 7.8.0, by default, Dropdown is selected.

    When you select the tree view, the following options are displayed:

    • Expand query list: If selected, displays the expanded query list at runtime.

    • Allow query edit: Allows or restricts editing of queries at runtime.

      The Allow query edit option is only available if Allow query selection is selected.

      Note If you upgrade to TotalAgility 7.8.0, the default options for Display queries are as shown below.

      • Allow query selection: (Selected)

      • Allow query edit: (Selected)

      		Display query as tree

      • Allow query selection: (Selected)

      • Allow query edit: (Clear)

      		Display query as dropdown

  • 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. To set the query that will be used to load the initial list of activities in the work queue, select Query for Initialize with.
  3. On the Query list, select a query.

Specify custom search criteria

  1. Clear Allow query selection.
  2. To define the search criteria that will be used to load the initial list of activities in the work queue, select Custom search for Initialize with.

    The following table describes the criteria available for custom search.

    Work Queue Field Description

    Return query total

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

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

    Note 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

    Current 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

    Current 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

    ID of the job.

    Job state

    Name of the state associated with the process.

    Work type

    The work type associated to the process.

    Metadata fields

    Create a filter criteria by selecting the work type and select 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.

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.

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