lib/RTx/MandatoryCustomFields.pm

   1 package RTx::MandatoryCustomFields;
   2
   3 our $VERSION = "0.01";
   4
   5 1;
   6
   7 =head1 NAME
   8
   9 RTx::MandatoryCustomFields - RT Extension to require custom fields to be set before resolving a ticket
  10
  11 =head1 DESCRIPTION
  12
  13 This RT extension adds a field to custom field definitions, allowing
  14 the field to be designated as "Required".  If this is enabled, tickets
  15 with no value in that custom field will refuse to resolve.  Note that
  16 unlike the Mandatory Subject extension, the field does not have to be
  17 set to create the ticket.
  18
  19 Required fields are enforced in the web interface, not the RT API, so
  20 they can be bypassed fairly easily by command-line, email, or other
  21 mechanisms for changing a ticket's status.  This extension is for
  22 encouraging good habits, not for security.
  23
  24 =head1 INSTALLATION
  25
  26  perl Makefile.PL
  27  make
  28  make initdb # if you have never installed this extension before
  29  make install
  30
  31 If your RT is not in the default path (/opt/rt3), you must set RTHOME
  32 first.
  33
  34 =head1 CONFIGURATION
  35
  36 Add this line to your RT_SiteConfig.pm:
  37
  38 Set(@Plugins, ( 'RTx::MandatoryCustomFields' ));
  39
  40 If you already have a Set(@Plugins ...) line, add 'RTx::MandatoryCustomFields'
  41 to the list of values.
  42
  43 Then edit your custom field and check the 'Required' box.  Any number of
  44 custom fields may be flagged as required.
  45
  46 If the user tries to resolve a ticket when one or more required fields
  47 are empty,
  48
  49 =head1 AUTHOR
  50
  51 Mark Wells <mark@freeside.biz>
  52
  53 =cut