An End Business Process workflow action, when executed by the workflow engine, logs the completion of a business process that was started by a prior submission of a form. You would employ this type of action in a workflow configuration that has at least one Start Business Process action and that logs other business process information.
When an End Business Process action is executed upon submission of a form, the status of the business process associated with the submission is marked as complete, and a timestamp representing the process' time of completion is recorded. This allows form administrators and form users, when viewing business process tracking information, to see that a business process has finished and when it completed.
An End Business Process action will only have any effect in a workflow process that has already been started and that has logged information along the way. So before you create and associate this type of action with a workflow, you should first define at least one Start Business Process action for the workflow. In addition, you should ensure that the workflow is sending logging information for business process tracking purposes.
Creating an End Business Process action is simply a matter of creating an action of this type and associating it with a workflow rule. The workflow rule with which you associate it should be a conditional rule whose condition finds something in the form that clearly represents a completion of the business process. If there are multiple conditions that could indicate the end of a business process, you could create multiple rules, each having an End Business Process action.
When you create an End Business Process action, there is no need to have it reference a particular business process. When a form is submitted that is already associated with a particular business process, if its submission calls an End Business Process action, the business process at hand will be marked as complete.
To create and associate an End Business Process action with a workflow:
Create a workflow rule that meets the following requirements:
It should be a Conditional rule, or a Callable rule that is invoked from a conditional rule.
The rule's conditional expression should clearly and explicitly define the criteria that would represent the end of an existing business process.
For more information on configuring workflow rules and conditional expressions, see Creating a Workflow Rule.
Create a new workflow action, associated with your new workflow rule. On the first screen of the Action Setup wizard:
Give the action a descriptive name that indicates that it ends a business process.
Choose "End Business Process" as the action type.
Enable logging if you wish.
If you enabled logging on the first screen, the final screen will allow you to specify whether you want to log the end of the business process for tracking purposes. Note that logging here is not necessary in order for the end of the process to be recorded. This simply enables you to write an additional message to the log, explicitly stating something about the end of the process. You may separately allow and define logging for form administrators and form users. To configure logging:
Specify whether you want to provide a log record for administrators, form users, or both.
Supply a customized logging message for each, or use the default message provided. You may use the $BP_NAME token to have the server automatically supply the name of the business process that you will configure in the next step. For more information on other logging options, see Configuring Business Process Logging.