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