SuggestCommentSuffix

Syntax

sub SuggestCommentSuffix

Back to top

Description

This function is called for every change request, in which the work order contains a suggested rule comment. It receives the change request as input, as well as the original rule comment and the rule comment suggested by FireFlow. It returns a suffix to be added to the rule comment suggested by FireFlow.

Back to top

Configuration

By default, this hook is not called. To configure the hook, complete the procedure below.

To enable the SuggestCommentsSuffix hook, use the generic procedure for overriding system defaults to set the configuration parameter SuggestCommentSuffixForWorkOrder to the value 1. For details, see Override FireFlow system defaults.

Note: After setting this parameter, you must restart FireFlow for the change to take affect. See Restarting FireFlow (see Restart FireFlow).

Back to top

Input Parameters

$ticket

A Perl hash reference containing a single key called flatTicket, which points to the flat ticket representation of the change request.

For details, see Flat Ticket Examples.
$origComment

The original rule comment.
$commentValue

The rule comment suggested by FireFlow.

Back to top

Return Values

A suffix to be added to the rule comment suggested by FireFlow.

Back to top