Configuring Business Process Logging

Setup of business process logging for a form is part of configuring its workflow process.  When you define a workflow action, you may specify whether or not you want the action to have business process logging enabled.  If you enable logging, you may then specify customized messages that can be made available to form users by clicking a button on the form, and/or form administrators through the Formatta E-Forms Manager Submissions interface.

In addition to providing you flexibility in terms of exactly which actions get logged and who gets to see the logging information, you may also customize the contents of the logging messages to include text that you specify.  You may also employ tokens or placeholders that represent data values from the submitted form, email recipients, and other information to make the logging messages very specific to the actual workflow at hand.

Adding Business Process Logging to Workflow

In order for your workflow process to make use of the logging messages you specify, it is necessary for your workflow to contain at least one Start Business Process and one End Business Process action in order to define the conditions under which the workflow engine should begin and end logging for a particular form's workflow process.  

Whenever you are creating or editing a workflow action, the first screen in the Action Setup wizard prompts you as to whether or not you want to enable logging for the action.  If you check the Enable Logging checkbox, the second screen allows you to customize the logging messages.

This screen contains two checkboxes - one to enable logging of the action for administrators, and another to enable it for form users.  Below each checkbox is a text area which becomes enabled when the checkbox above it is checked.  You may use special placeholders to represent data such as the business process name ($BP_NAME), form field data ($PFF.field_name), and other information specific to the submission, form, or business process.  See below for a complete listing of available placeholders.

Using Placeholders in Business Process Logging

When you specify the content of a business process logging message, there are several placeholders that you may use to help customize the message and make it pertinent to the actual form that was submitted to workflow.  Some placeholders can be used with all types of workflow actions, while others are specific to the type of action for which logging is being configured.  Placeholders specified in an logging message are replaced with the actual values before the message is recorded.

The tables below provide a listing and description of each placeholder and show which placeholders pertain to the various types of workflow action.

Table 1: Placeholders Available in All Actions

Table 2: Send Email Action Placeholders

Table 3: Pre-populate New Form Action Placeholders

Table 4: Go to Rule Action Placeholders