stop_sequence

Format

stop_sequence = ["stop", "post_stop"]

Description

The stop_sequence keyword notifies plms to execute a stop task from left to right. If any function fails, plms interprets that stop sequence to have failed.

If you define stop_sequence, plms attempts to stop the process with the component's stop task properties. If the component doesn't have a stop task, plms uses default properties.

Default

The default value is stop.

Multiplicity

Zero or one instance in a component block.

Constraints

• The tasks must be resolvable at the end of the component parsing. If the sequence contains any unresolvable tasks, the configuration files are rejected.

• The component is considered to have been stopped when all the tasks defined in the stop_sequence are executed.

• The execution of the stop_sequence is not aborted if the tasks fail.

• A task can appear only once in the stop_sequence list, and the tasks are executed as specified. If a task is used in stop_sequence, then it is not allowed to use the task in other sequences.

• If you specify stop in the stop_sequence, then the stop terminates all the processes started before the stop task, including the tasks started by the stop_sequence before the stop.

• If you don't specify the stop task in the stop_sequence, then a default or user defined stop task executes at the end of the stop_sequence.

• An additional stop task executes at the end of stop_sequence to terminate any process created by stop_sequence. 

• Empty stop_sequence lists are rejected during parsing.

Example

stop_sequence = ["post_cleanup"]

stop_sequence = ["stop", "post_cleanup"]