Search properties of a JobList
Define the search criteria for a JobList control to search for the required jobs. You can either use a predefined query or create custom filter criteria. The joblist page displayed initially at runtime is based on the selected query or the search criteria (Custom) defined at design time.
- Allow Job/Case Search
- Use this option to allow or restrict search on a job or case at
runtime (default: Yes). For example, you may want to restrict job search when
populating the control with a query without enabling the edit option.
If this option is set to No, the search-related options for job or case are not visible at runtime. However, on upgrading TotalAgility, these options are displayed by default to preserve backward compatibility.
- Allow Query Selection
-
Use this option to hide or display the Queries panel at runtime. (Default: Yes; this means the Queries panel is available at runtime.)
If this option is set to No, the Queries panel is not available at runtime.
- Initialize with
- Use either option:
-
Query: At runtime, the jobs are displayed based on the query consumed.
-
Custom Search: At runtime, the jobs are displayed based on the custom search criteria defined at design time.
-
- Return Query Total
- Use this option to view the total number of items matching
the query regardless of the retrieval limit specified in the query. (Default:
No)
Note If you set this option to Yes, there will be a performance overhead.
The following table describes the joblist criteria available for custom search.
Job List Field
Description
Job ID
ID of the case job. Use a static value.
Note You can only consume a global variable, variable or form field for the initial search of a joblist control.Case Reference
Case reference based on which the job is created. Consume a global variable, variable or form field or use a static value.
Start Date
The date when the job started.
Completion Date
The date when the job completed.
Due Date
The date when the job is due to complete.
Note 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.Created By
The resource who created the job.
Job Owner
The resource who is the job owner.
Status
The status of the job. The following job status are available:
-
Active: A job that is currently in an active state, that is actively progressing or in a state to progress.
-
AcLive And Finishedtive: 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 lifecycle as designed.
-
Ready For Evaluation: Jobs that are in the process of reevaluating what should happen next.
-
Pending: A job which has 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 lifecycle.
-
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.
-
Completed Awaiting Associated Jobs Completion: A case that is completed but still has active associated jobs.
-
Completed 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.
Category
The category to which the job belongs.
Search in Sub-Categories
Whether to search within subcategories.
Process
The process on which the job is created.
Process Version
The process version.
Job Type
The job type: All, Job, Case or Associated Job.
Priority
The priority of the job with 1 being the highest and 100 lowest.
Job State
Name of the state associated with the process. Consume a global variable, variable or form field or use a static value.
Retrieval Limit
The number of latest jobs to retrieve from the server at a given point in time.
Work Type
Consume the work type.
Metadata
Create a filter criteria by consuming the work type and selecting the corresponding fields. See Create metadata.
Score
The score of the job.
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 (target duration).
Suspend Reason
The suspend reason for a job. Consume a global variable, variable or form field or use a static value.
- Allow Query Edit
-
This option is only available if the Allow Query Selection option is set to Yes.
Use this option to allow or restrict editing queries at runtime. (Default: Yes)
If this option is set to No, you can only view queries but cannot create, modify or delete a query.
Specify the Query Type to view at runtime.
-
All: Runs all queries-private and shared.
-
Private: Runs only the queries defined by you and not shared with anyone.
-
Shared: Runs all shared queries.
-