COMMENT Command

Comment commands are written to the rule procedure in order to describe the purpose or provide a description of something within the rule procedure. These commands are useful to anyone who needs to review a rule procedure after it was created and determine what it does. You should include comments in each section of your rule procedure to describe what its purpose is, particularly for complex rules.

For example, you might want to define a COMMENT command that writes the following descriptive information to the appropriate place in a rule procedure that balances departmental salary budget reports: “The following section of the rule procedure compares hours logged on an employee’s timesheet to the number of work hours in the pay period and multiplies any overage by the appropriate overtime rate. This value is then added to the employee’s base salary to determine the employee pay for this pay period."

To define a COMMENT command:

  1. Launch the Rule Editor. See for more information.
  2. On the Rule tab, from the COMMANDS drop-down, drag and drop the COMMENT command to the Working Canvas.
  3. In the Message text box, enter the appropriate message.
  4. Ensure that the Enable check box is checked.
  5. Click OK.
  6. Save and deploy the rule procedure.
For any rule procedure, comments can be updated or deleted. You can click the Reset button, to restore it to the previous state.