Planning Engine workflow

Workflows provide a scripting language to automate various actions in the Planning Engine. Users can define and execute the workflows that comprise of commands and logic flow statements. Each workflow definition contains a unique workflow name and multiple commands. Each command is separated by a semicolon.

Note: Workflows are validated when a user saves the data.

Execution

These conditions are applicable for the workflow execution:

A workflow with a specified name is requested for execution.
Note: If workflow is not defined for the specified workflow name, the execution fails, and this error message is displayed:
```
APACS114=Workflow "{0}" was not found
```
Where {0} = Workflow name
When the execution of a workflow is started, this message is logged:
```
APACS188=Start executing workflow "{0}"
```
Where {0} = Workflow name
If the user interrupts the execution of the workflow, this message is logged and the workflow execution including the nested workflow execution, if any, initiated through the workflow command, are stopped:
```
APACS190=Workflow execution interrupted by user
```
If the workflow execution is completed successfully, this message is logged:
```
APACS117=Workflow "{0}" completed
```
Where {0} = Workflow name
If the workflow reports errors, an additional error message is logged indicating that the execution of the workflow has been completed with errors.
```
APACS123=Workflow "{0}" completed with errors
```
Where {0} = Workflow name
If the workflow reports warnings with no error, an additional warning message is logged indicating that the execution of the workflow has been completed with warning message.
```
APACS287=Workflow "{0}" completed with warnings
```
Where {0} = Workflow name

Workflow commands

During the execution of the workflow command, warnings, error messages or related information messages are logged. The message can vary based on the command. See Workflow commands.

These conditions are applicable for each command in the workflow:

If the command is valid, the command and the argument to be executed is logged.
```
APACS121=Command: {0} 
```
{0} = workflow command, including any specified arguments.
If the command is not valid, this warning message is logged, and the next command is executed:
```
APACS189=Command "{0}" not known
```
{0} = workflow command.
If the workflow command is successfully completed, a message explaining the impact of the command is logged and the next command in the workflow is executed.
If the workflow command is not successfully completed, an unsuccessful completion of a workflow logs an appropriate error or warning message and the next command in the workflow is executed.
If the workflow command reports errors, this additional error message is logged, indicating that the execution of the command has been completed with errors, before continuing with the next command:
```
APACS279=Command: "{0}" completed with errors
```
If the workflow command reports warnings with no errors, this additional warning message is logged indicating that the execution of the command has been completed with warnings before continuing with the next command:
```
APACS286=Command: "{0}" completed with warnings
```