Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Required Arguments
    • query : Specifies the expression that is used to query the execution history, for example isCompleted, isCompletedSuccessful, for the full list see Queries.
    • One or both of the following arguments are specified:
      • workflow: Specifies the name of a workflow for which the execution history is looked up. 
      • job: Specifies the name of a job for which the execution history is looked up.
      • If both arguments are specified then the job name is looked up in matching workflow names only.
      • Search for workflows and jobs is case-insensitive.
      • Wildcards can be used for both arguments, for example, accounting*, *account*.
        • * : matches zero or more characters
        • ? : matches any single character
  • Optional Arguments
    • controller_id:  Optionally the identifier of a Controller can be specified to limit results to workflows and jobs executed with the indicated Controller.
  • Note that the the check box provided with each argument has to be selected the argument is to be added to the arguments of the CheckHistoryJob template.

...

FunctionArgumentsDefaultExplanation
isStartedstartedFrom,
startedTo, count
startedFrom=0d, startedTo=0d,  count=1
  • Scope: specifies that the workflow or job started without consideration if it completed or is still running.
  • Default Period: start on the same day.
isCompletedstartedFrom,
startedTo, completedFrom, completedTo, count
startedFromcompletedFrom=0d, completedFromcompletedTo=0d,  count=1
  • Scope: specifies that the workflow or job completed without consideration of success of failure.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.
isCompletedSuccessfulstartedFrom,
startedTo, completedFrom, completedTo, count
startedFromcompletedFrom=0d, completedFromcompletedTo=0d,  count=1
  • Scope: specifies that the workflow or job completed successfully.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.
isCompletedFailedstartedFrom,
startedTo, completedFrom, completedTo, count
startedFromcompletedFrom=0d, completedFrom  completedTo=0d, count=1
  • Scope: specifies that the workflow or job failed.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.
lastCompletedSuccessfulstartedFrom,
startedTo, completedFrom, completedTo, count
startedFromcompletedFrom=0d, completedFrom  completedTo=0d, count=1
  • Scope: specifies that the last run of the job completed successfully.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.
lastCompletedFailedstartedFrom,
startedTo, completedFrom, completedTo, count
startedFromcompletedFrom=0d, completedFrom  completedTo=0d, count=1
  • Scope: specifies that the last run of the workflow or job failed.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.
lastCompletedSuccessful

startedFrom,
startedTo, completedFrom, completedTo, count

startedFromcompletedFrom=0d, completedFrom  completedTo=0d, count=1
  • Scope: specifies that the last run of the workflow or job completed successfully.
  • Arguments: if the argument startedFrom is specified, then the default value of the startedTo argument is 0d.
  • Default Period: start and completion on the same day.

Arguments

ArgumentDefaultExplanation
startedFrom0dThe workflow or job started after the given date.
startedTo0dThe workflow or job started before the given date.
completedFrom0dThe workflow or job completed after the given date.
completedTo0dThe workflow or job completed before the given date.
count1The minimum number of history items that is expected to be returned for the given period. By default a single history item is expected. The CheckHistoryJob will fail if the number of expected history entries specified by this argument exceeds the number of history items returned.

...