Page History

...

The CheckHistoryJob template accepts the following arguments:

Name	Required	Default Value	Purpose
`query`	yes	n/a	Specifies the expression that is used to look up the execution history, for example isCompleted, isCompletedSuccessful etc., for the full list see Queries.
`workflow`	no	n/a	Specifies the name of a workflow for which the execution history is looked up. A `workflow` name or `job` name has to be specified.
`job`	no	n/a	Specifies the name of a job for which the execution history is looked up. A `workflow` name or `job` name has to be specified.
`controller_id`	no	n/a	The identifier of a Controller can be specified to limit results to workflows and jobs executed with the indicated Controller.

...

The CheckHistoryJob template returns the following variables:

Return Variable	Data Type	Purpose	Example
`js7CheckHistoryResult`	Boolean	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`
`js7CheckHistoryResultWorkflow`	String	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`
`js7CheckHistoryResultStarted`	Date	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`
`js7CheckHistoryResultCompleted`	Date	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`
`js7CheckHistoryQuery`	String	Returns the value of the `query` argument. Returns a copy of the value of the `query` argument that was used with the query.	`isStarted`
`js7CheckHistoryQueryWorkflow`	String	Returns the value of the `workflow` argument. Returns a copy of the value of the `workflow` argument that was used with the query.	`accounting`
`js7CheckHistoryQueryJob`	String	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`

...

Space shortcuts

Page tree

Versions Compared

Old Version 11

New Version 12

Key