Welcome > Jobs > Manage JobList queries > Create a JobList query

Create a JobList query

  1. On the Jobs menu, click Find.

    The page appears listing all live jobs and the Queries panel. The Queries panel includes the following two folders:

    • My Queries: All private queries are saved in this folder.
    • Shared Queries: Includes all shared queries.

  2. On the Queries panel, click .

    The New Query page displays the search criteria for the job query.

  3. Enter a name for your query in the Query Name box.
  4. To view the total number of items matching the query, select Return Query Total.

    The count is the total number of items regardless of the retrieval limit specified in the query.

    Note If you turn this setting on, there may be a performance overhead.
  5. Select the criteria for your query.

    The following table describes the criteria available for a job.

    Field

    Description

    Work Type Allows selection of work type from the list.
    Job ID ID of the job.
    Case Ref Case reference based on which the job is created.
    Type The type of job. Includes the following options:

    • Job
    • Case
    • Associated Job
    • Business Rule

    Category The category to which the job belongs.
    Sub Categories Select this check box to include the subcategories within the selected category in your query.
    Created By The following options are available:

    • Me: Jobs created by you.
    • My Direct Subordinates: Jobs created by your direct subordinates.
    • Me and My Direct Subordinates: Jobs created by you and your direct subordinates.
    • My Subordinates: Jobs created by your subordinates.
    • Me and My Subordinates: Jobs created by you and your subordinates.

    It also includes the name of the resources who created the job.

    Process Map The process on which the job is created.
    Job Owner The name of the person who currently owns the job. The following options are available:

    • Me: Jobs owned by you.
    • Me and My Groups: Jobs owned by you and your groups.
    • My Direct Subordinates: Jobs owned by your direct subordinates.
    • Me and My Direct Subordinates: Jobs owned by you and your direct subordinates.
    • My Subordinates: : Jobs owned by your subordinates.
    • Me and My Subordinates: Jobs owned by you and your subordinates.

    Version

    The version of the job.

    Job State

    The name of the state associated with the process.

    Status

    The following job statuses are available:

    • Active: Jobs which are currently in an active state, that is actively progressing or in a state to progress.

    • Live And Finished: Jobs which are currently live or finished.

    • Finished: Jobs which are completed or terminated.

    • Live: Jobs which are either not completed, terminated, awaiting completion or awaiting termination.

    • Completed: Jobs which have completed their life cycle as designed.

    • Ready For Evaluation: Jobs which are in the process of re-evaluating what should happen next.

    • Pending Completion: Jobs which have completed, but there are taken activities.

    • Suspended: Jobs which are suspended but can manually be reactivated to get them up and running again.
      Note The jobs that have failed evaluation cannot be suspended.

    • Terminated: Jobs which have stopped processing before completing the lifecycle.

    • On Hold: Jobs which 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: Cases which are completed but still have active associated jobs.

    • Completed Awaiting Associated Case Completion: Associated jobs which are completed and awaiting case completion.

    • Terminated Awaiting Associated Jobs Completion: Terminated cases awaiting completion of associated jobs.

    • Terminated Awaiting Associated Case Completion: Associated jobs that have been terminated and awaiting case completion.

    • Job Evaluation Failed: Jobs that have failed evaluation.

    Priority

    The priority of the activity with 1 being the highest and 100 being the lowest.

    Retrieval Limit

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

    Score

    The score of the job.

    Job SLA

    The threshold status or job state on a job list that indicates if the job is within or has exceeded the set target duration.

    Suspend Reason

    The reason for suspending the job. The jobs that match the suspend reason are returned.

    Dates

    1. Start Date: The date on which the job has started.

    2. Completion Date: The date on which the job was completed.

    3. Due Date: The date on which the job is due to be completed.

    Metadata A feature for creating filter criteria by selecting the work type and the corresponding fields. See Create metadata.

  6. The default query is Live Jobs. To change the default query, in the Queries panel, select the query and then click .
  7. Click Edit Query and click Run to check if the query is displaying results as expected.

    Note Click Cancel to discard the changes and return to the joblist.

  8. Click Save.
    The query is saved in the My Queries folder.
  9. To save the query with another name:
    1. On the Queries panel, select the query and click the Edit Query tab.
    2. On the toolbar, click Save As.
    3. In the Query Name box, enter a name for the query and click OK.

      A message confirms that the query is saved.

    4. Click OK.

      The query appears on the Queries panel.

Maintain queries

  • To edit a query:

    1. On the Queries panel, select the query and click Edit Query.

    2. Make the changes, as needed.

    3. Click Save.

      Note Click Cancel to discard the changes and return to the job list.

  • To delete a query:

    1. On the Queries panel, select the query and click .

    2. Click Yes to confirm deletion.

      The query is deleted.