Job Status Actions

Lifecycle hooks for form execution.

Start a GUI action, triggered by a job status. Such as clear, hide, show, …

You can use these hooks:

• onSubmit - Triggered when the form is submitted
• onSuccess - Triggered when the job completes successfully
• onFailure - Triggered when the job fails
• onFinish - Triggered when the job finishes (regardless of status)
• onAbort - Triggered when the job is aborted

Attributes

Attribute	Comments
clear number	Clear the form integer >= 0 This action clears the form after x seconds.
hide number	Hide the form integer >= 0 This action hides the form after x seconds.
show number	Show the form integer >= 0 This action shows the form after x seconds.
home number	Go to Home integer >= 0 This action navigates to the home page
reload number	Reload form integer >= 0 This action reloads the form (and cleans the job output)
load string	Load a form number_of_seconds,name_of_form This action allows you to load another form. new in v4.0.20 : the previous jobid is sent as __previous__jobid__. You must make sure you have this field in your form, it will be populated with the previous jobid. This is particularly interesting to grab information from the previous job (for example, load output, …)

Examples

1) Clear and hide on submit

onSubmit:
  - clear: 0   # clear form after submit
  - hide: 2    # 2 seconds later, hide the form        

2) Go home on submit

onSubmit:
  - home: 0 

3) Load another form on success

onSuccess:
  - load: 2,Another form   # load another form after success

4) Hide, Show and Home

onSubmit:
  - hide: 0  # hide on submit
onFailure: 
  - show: 0  # show if failed
onSuccess:
  - home: 0  # go home if success