initial releaseHEADmaster

1 files changed, 48 insertions, 0 deletions

diff --git a/README b/README
new file mode 100644
index 0000000..3e1cb27
--- /dev/null
+++ b/README
@@ -0,0 +1,48 @@
+NAME
+    RTx::MandatoryCustomFields - RT Extension to require custom fields to be
+    set before resolving a ticket
+
+DESCRIPTION
+    This RT extension adds a field to custom field definitions, allowing the
+    field to be designated as "Required". If this is enabled, tickets with
+    no value in that custom field will refuse to resolve. Note that unlike
+    the Mandatory Subject extension, the field does not have to be set to
+    create the ticket.
+
+    Required fields are enforced in the web interface, not the RT API, so
+    they can be bypassed fairly easily by command-line, email, or other
+    mechanisms for changing a ticket's status. This extension is for
+    encouraging good habits, not for security.
+
+INSTALLATION
+     perl Makefile.PL
+     make
+     make initdb # if you have never installed this extension before
+     make install
+
+    If your RT is not in the default path (/opt/rt3), you must set RTHOME
+    first.
+
+CONFIGURATION
+    Add this line to your RT_SiteConfig.pm:
+
+    Set(@Plugins, ( 'RTx::MandatoryCustomFields' ));
+
+    If you already have a Set(@Plugins ...) line, add
+    'RTx::MandatoryCustomFields' to the list of values.
+
+    Then edit your custom field and check the 'Required' box. Any number of
+    custom fields may be flagged as required.
+
+    If the user tries to resolve a ticket when one or more required fields
+    are empty,
+
+AUTHOR
+    Mark Wells <mark@freeside.biz>
+
+    Copyright (C) 2009-2010 Mark Wells
+    Copyright (C) 2009-2010 Freeside Internet Services, Inc.
+
+    This program is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself.
+