Versions Compared

Key

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

...

FunctionArgumentsDefaultExplanation
isStartedstartedFrom,
startedTo, count
startedFrom=0d, startedTo=0d,  count=1count>0
  • 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
completedFrom=0d, completedTo=0d,   count=1count>0
  • 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
completedFrom=0d, completedTo=0d,   count=1count>0
  • 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
completedFrom=0d,  completedTo=0d, count=1count>0
  • 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
completedFrom=0d,  completedTo=0d, count=1count>0
  • 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
completedFrom=0d,  completedTo=0d, count=1count>0
  • 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.

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.
count
count  
1The minimum
count>0

Count is used with an operator. The number of history items that is expected to be returned for the given period. By default

a single

at least one history item is expected (count>0). The CheckHistoryJob will fail if the number of expected history entries specified by this argument

exceeds

not correspond to the number of history items returned.

Values for operator: =, <=, <, >, >=

Example count > 10 

==> The CheckHistoryJob will fail if the number of history entries is not greater then 10

Absolute Dates

Absolute date can be specified as values to the startedFrom, startedTo, completedFrom and completedTo arguments.

...

ExampleExplanation
isStartedSpecifies that the workflow or job started today.
isCompletedSpecifies that the workflow or job completed today independently from its start date.
isCompletedSuccessfulSpecifies that the workflow or job completed successfully today independently from its start date.
isCompletedFailedSpecifies that the workflow or job failed today independently from its start date.
isCompleted( startedFrom=0d )Specifies that the workflow or job started today and completed today. It is not considered if the workflow or job completed successfully or failed.
isCompletedSuccessful( startedFrom=0d )Specifies that the workflow or job started today and completed successfully today.
isCompletedFailed( startedFrom=0d )Specifies that the workflow or job started today and failed today.
isStarted( startedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job started after the given point in time.
isCompletedSuccesfulisCompletedSuccessful( startedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job started after the given point in time and completed successfully.
isCompletedFailed( startedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job started after the given point in time and failed.
isCompleted( completedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job completed after the given point in time.
isCompletedSuccessful( completedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job completed successfully after the given point in time.
isCompletedFailed( completedFrom=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job failed after the given point in time.
isCompleted( completedFrom=2021-12-05T01:00:00.000Z, completedTo=2022-05-05T01:00:00+02:00 )Specifies that the workflow or job completed before the given point in time.
isCompletedSuccesfulisCompletedSuccessful( completedFrom=2021-12-03T01:00:00+02:00, completedTo=2021-12-05T01:00:00+02:00 )Specifies that the workflow or job completed successfully before the given point in time.
isCompletedFailed( completedFrom=2021-12-04T01:00:00+02:00, completedTo=2022-12-05T01:00:00+02:00 )Specifies that the workflow or job failed before the given point in time.
lastCompletedSuccessfulSpecifies that the last run of the workflow or job completed successfully.
lastCompletedFailedSpecifies that the last run of the workflow or job failed.
lastCompletedSuccessful( startedFrom=-1d, startedTo=-1d )Specifies that the last run of the workflow or job started in the given period and completed successfully today.
lastCompletedFailed( startedFrom=-1d, startedTo=-1d )Specifies that the last run of the workflow or job started in the given period and failed today.
lastCompletedSuccessful( completedFrom=-1d, completedTo=-1d )Specifies that the last run of the workflow or job completed successfully in the given period.
lastCompletedFailed( completedFrom=-1d, completedTo=-1d )Specifies that the last run of the job failed in the given period.

...