GetRealGroupName

Note: Most of this hook's functionality can be accomplished by configuring conditional logic in the FireFlow web interface. For details, see Manage user roles.

If conditional logic is defined in the web interface and this hook is being used, the hook has lower precedence. The hook is executed only if no condition is met for a specific change request.

Syntax

sub GetRealGroupName

Back to top

Description

This function is called for every change request, when the change request transitions from one status to another. It receives the change request as input, as well as the “meta group” name that the change request's workflow specifies, as the responsible role for the change request’s new status. It returns the name of the user role that is responsible for the change request in its current status.

Back to top

Input Parameters

$context

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.

$metaGroup

A user role name, as it appears in the workflow configuration.

This may be a meta role's name. For example if the meta role's name is "security", the hook may then return the user role "securityA" for requestors of company A, and the user role "securityB" for requestors of company B, where "securityA" and "securityB" are real user roles (not meta roles) that exist in FireFlow.

Back to top

Return Values

One of the following values:

The desired user role's name

 

""

Use the default behavior: The user role specified in the workflow configuration will be responsible for the change request.

Back to top