› Manage jobs › Manage job queries › Create a job query

Create a job query

Create a job query to find jobs based on the criteria you define.

  1. On the Jobs menu, click Find.

    A list of all private (My Queries) and shared queries (Shared Queries) appears on the Jobs page.

  2. On the queries panel, click .

    The search criteria for the job appears on the right side of the query panel.

  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 of items are displayed in a badge beside the query name. The count is the total number of items regardless of the retrieval limit specified in the query.

    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. The following options are available:

    • 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.

    This field 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 that are currently in an active state, that is actively progressing or in a state to progress.

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

    • Finished: Jobs that are completed or terminated.

    • Live: Jobs that are 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 re-evaluating what should happen next.

    • Pending Completion: Jobs that are completed, but have "taken" activities.

    • Suspended: Jobs that are suspended but can manually be reactivated to get them up and running again.

      The jobs that have failed evaluation cannot be suspended.

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

    • Completed Awaiting Associated Case Completion: Associated jobs that 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.

    • Archiving: Jobs that are currently being archived.

      A job typically does not stay in this status very long. This status is shown for the jobs with huge job histories that take a long time to archive.

    • Terminating: Jobs that are pending for termination.

      This status is typically seen when terminating a case with hundreds of fragments.

    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 (this limit is set in the TotalAgility Designer).

    Select the checkbox against the field to override the system setting and apply your own retrieval limit.

    Score

    The score rule for the job. For example, "Greater than 10".

    Use the operator and the value to create a score rule. The following operators are available:

    • Equals (Default: Equals, 0)

    • Greater than

    • Greater than equal to

    • Less than

    • Less than equal to

    • Not equal to

    Job SLA

    The threshold status or job state 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. Click Edit Query and click Run to check if the query is displaying results as expected.
  7. After running the query if you click Revert, the query reverts to its original state.

    Click Cancel to discard the changes and return to the jobs page.

  8. Click Save.
    The query is saved under My Queries.

Maintain a job query

You can edit a query, save a query with a different name, and delete a query.

Save a query with another name

You can save a query with a different name and reuse it.

  1. On the queries panel, select the query.
  2. Click Edit Query.
  3. On the toolbar, click Save As.
  4. Enter a Query Name and click OK.
  5. Click OK in the confirmation message.

Edit a query

  1. On the queries panel, select the query and click Edit Query.
  2. Make the changes, as needed.
  3. On the toolbar, click Save.

    Click Cancel to discard the changes and return to the work queue.

Delete a query

  1. On the queries panel, select the query and click Delete.
  2. Click Yes to confirm deletion.