Core actions
Introduction
These core actions are actions directly supported by the process interpreter. They relate to how a process runs, completes, or fails.
Running a sub-process explicitly
process
processYou can run a sub-process with the process action:
<property as="xs:string" name="oxf.fr.detail.process.home.*.*">
process("orbeon-home")
</property>You can also run a sub-process directly by name:
<!-- Define a sub-process which navigates to the "/" URL -->
<property as="xs:string" name="oxf.fr.detail.process.orbeon-home.*.*">
navigate("/")
</property>
<!-- Use that sub-process from the "home" process -->
<property as="xs:string" name="oxf.fr.detail.process.home.*.*">
orbeon-home
</property>Terminating a process
terminate-with-success
terminate-with-successComplete the top-level process right away and return a success value.
The terminate-with-success action replaces the success action since Orbeon Forms 2024.1.
terminate-with-failure
terminate-with-failureComplete the top-level process right away and return a failure value.
The terminate-with-failure action replaces the failure action since Orbeon Forms 2024.1.
success
success[DEPRECATED SINCE Orbeon Forms 2024.1]
Complete the top-level process right away and return a success value.
The success action name is deprecated. Use terminate-with-success instead since Orbeon Forms 2024.1.
failure
failure[DEPRECATED SINCE Orbeon Forms 2024.1]
Complete the top-level process right away and return a failure value.
The failure action name is deprecated. Use terminate-with-failure instead since Orbeon Forms 2024.1.
Continuing a process
continue-with-success
continue-with-successDon't do anything and return a success value.
The continue-with-success action replaces the nop action since Orbeon Forms 2024.1.
continue-with-failure
continue-with-failureDon't do anything and return a failure value.
nop
nop[SINCE Orbeon Forms 4.3]
[DEPRECATED SINCE Orbeon Forms 2024.1]
Don't do anything and return a success value.
The nop action name is deprecated. Use continue-with-success instead since Orbeon Forms 2024.1.
Suspending and resuming a process
suspend
suspend[SINCE Orbeon Forms 4.3]
Suspend the current process. The continuation of the process is associated with the current form session.
resume-with-success
resume-with-successResume the process previously suspended with suspend.
The resume-with-success action replaces the resume action since Orbeon Forms 2024.1.
resume-with-failure
resume-with-failureResume the process previously suspended with suspend, but indicate that the resumption is a failure.
abort
abort[SINCE Orbeon Forms 4.3]
Abort the process previously suspended with suspend. This clears the information associated with the process. It won't be possible to resume it with resume-with-success or resume-with-failure.
resume
resume[SINCE Orbeon Forms 4.3]
[DEPRECATED SINCE Orbeon Forms 2024.1]
Resume the process previously suspended with suspend.
The resume action is deprecated. Use resume-with-success instead since Orbeon Forms 2024.1.
Last updated