Versions Compared

Key

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

...

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 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.
isCompletedSuccesful( 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.
isCompletedSuccesful( 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=-11d, startedTo=-1d )Specifies that the last run of the workflow or job started in the given period and completed successfully today.
lastCompletedFailed( startedFrom=-11d, startedTo=-1d )Specifies that the last run of the workflow or job started in the given period and failed today.
lastCompletedSuccessful( completedFrom=-11d, completedTo=-1d )Specifies that the last run of the workflow or job completed successfully in the given period.
lastCompletedFailed( completedFrom=-11d, completedTo=-1d )Specifies that the last run of the job failed in the given period.

...

Return VariableData TypePurposeExample
js7CheckHistoryResultBoolean

Returns the Boolean result of the query.
Note: The query result is similarly returned with the returnCode return variable and the values 0=true, 1=false.

true, false

js7CheckHistoryResultControllerId

String

Returns the Controller ID of the resulting history entry.

The value of the return variable is empty if the query returns no result. If the query returns a result then the return variable holds the Controller ID of the youngest resulting history entry.

controller
js7CheckHistoryResultWorkflowString

Returns the workflow name of the resulting history entry.

The value of the return variable is empty if the query returns no result.
If the query returns a result then the return variable holds the workflow name of the youngest resulting history entry.

check_history
js7CheckHistoryResultJobString

Returns the job name of the resulting history entry.

The value of the return variable is empty if the query returns no result.
If the query returns a result then the return variable holds the job name of the youngest resulting history entry.

check-history-job
js7CheckHistoryResultStartedDate

Returns the start date and time of the resulting history entry.

The value of the return variable is empty if the query returns no result. If the query returns a result then the return variable holds the start date and time of the youngest resulting history entry in ISO-8601 format.

2012-12-05T01:00:00+02:00
js7CheckHistoryResultCompletedDate

Returns the completion date and time of the resulting history entry.

The value of the return variable is empty if the query returns no result. If the query returns a result then the return variable contains the completion date and time of the youngest resulting history entry in ISO-8601 format.

2012-12-05T01:00:00+02:00
js7CheckHistoryQueryString

Returns the value of the query argument.

Returns a copy of the value of the query argument that was used with the query.

isStarted

js7CheckHistoryQueryControllerId

String

Returns the value of the controller_id argument.

Returns a copy of the value of the controller_id argument that was used with the query.

controller
js7CheckHistoryQueryWorkflowString

Returns the value of the workflow argument.

Returns a copy of the value of the workflow argument that was used with the query.

accounting
js7CheckHistoryQueryJobString

Returns the value of the job argument.

Returns a copy of the value of the job argument that was used with the query.

my-job

...

Code Block
titleAgent private.conf file configuration
linenumberstrue
js7 {
    auth { ... }
    configuration { ... }
    job { ... }
    web { ... }

	api-server {
    	# API Server URL
	    url = [ "https://joc-2-0-primary:4443" ]

    	# Option 1: use of a Credential Store
	    cs-file=${js7.config-directory}"/private/secret.kdbx"
	    cs-key=${js7.config-directory}"/private/secret.key"
    	cs-password="secret"

	    # Option 1: use of references to credentials 
    	account="cs://myAccounts/joc@username"
	    password="cs://myAccounts/joc@password"


    	# Option 2: Use of account and password
	    # account="root"
    	# password="root"
	}
}

...