Search properties

Allow or restrict the search, define the search criteria for a Job list control to search for the required jobs, and allow editing of a query.

Allow job/case search

If selected, allows searching on a job (using the Job ID) or case (using the case reference) at runtime.

If clear, restricts searching on a job at runtime. For example, restricts job search when populating the control with a query without enabling the edit option. The search-related options for jobs or cases are not visible at runtime. However, on upgrading TotalAgility, these options are displayed by default to preserve backward compatibility.

Allow query edit

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

Allow query selection

Allow query selection at runtime or display the job list 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 either in a Tree or a 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

Clear Allow query selection.
Select Query for Initialize with.
Optional. On the Query list, select a query that will be used to load the initial job list.

If you do not set a query and load the form at runtime, the job list 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 job list, do the following.

Clear Allow query selection.
Select Custom search for Initialize with.

If a custom search is used, when you edit the query at runtime, the Save and Save as options are not enabled.

Set the criteria, as needed.

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

Job list 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. (Default: Clear) If you select this option, there will be a performance overhead.
Retrieval limit	The number of the latest activities that are to be retrieved from the server at a given point in time.
Job ID	The ID of the case job. You can only select a global variable, form variable, or form control for the initial search of a job list control.
Case reference	Case reference based on which the job is created. Select a global variable, form variable, form control, or use a static value.
Start date	The date when the job started.
Completion date	The date when the job is completed.
Due date	The date when the job is due to be complete. You can filter creation, completion, and due dates on any date (All), since a specific date, between two dates, today's date, this week, this month, and this year. If the date option is "Since" or "Between", you can provide a value to be "@Today" or a certain number of days from today in the following format: @Today +/- NUM. For example, <@Today - 7>
Created by	The resource who creates the job.
Job owner	The resource who is the job owner.
Status	The status of the job. The following job statuses are available: Active: A job that is currently in an active state, that is actively progressing or in a state to progress. Live and finished: A job that is currently live or finished. Finished: Jobs that are completed or terminated. Live: Jobs that are either not completed, terminated, awaiting completion, or awaiting termination. Completed: Jobs that have completed their life cycle as designed. Ready for evaluation: Jobs that are in the process of reevaluating what should happen next. Pending: A job, which was completed, but there are taken activities. Suspended: Jobs that are suspended but can manually be reactivated to get them up and running again. Terminated: A job that has stopped processing before completing the life cycle. On hold: Jobs that are on hold for a specific time to delay all event processing. When a job is placed on hold, exceptions, milestones, and triggers are affected. When the hold time expires, the job moves to active status, and the job activities become pending. Awaiting associated jobs completion: A case that is completed but still has active associated jobs. Awaiting associated case completion: An associated job that is completed and awaiting case completion. Terminated awaiting associated jobs completion: A terminated case awaiting completion of associated jobs. Terminated awaiting associated case completion: An associated job that has been terminated and awaiting case completion. Evaluation failed: Jobs that have failed in evaluation. Archiving: Jobs that are currently being archived. A job typically does not stay in this status very long. This status is shown for jobs with huge job histories that take a long time to archive. Terminating: Jobs that are pending termination. This status is typically seen when terminating a case with hundreds of fragments.
Category	The category to which the job belongs.
Search in sub-categories	Allows searching within subcategories.
Process	The process on which the job is created.
Process version	The process version.
Job type	The job type. The available options are All, Job, Case, Associated job, and Business rule.
Priority	The priority of the job with 1 being the highest and 100 lowest.
Job state	The name of the state associated with the process. Select a global variable, form variable, form control, or use a static value.
Work type	Select the work type.
Metadata fields	You can create filter criteria by selecting the work type and selecting the corresponding fields. See Create metadata.
Score	The score of the job.
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 (target duration).
Suspend reason	The reason for job suspension. Select a global variable, form variable, form control, or use a static value.

You can also configure the job list columns.
1. Click Configure for Job list columns.
  
  The Joblist 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 Creation 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 Creation Time or Completion Time, you can additionally set the Time format to be Date or Date Time.
5. Click OK.
6. Click Save.