[Rt-commit] rt branch, 4.0/document-extractsubjecttag, created. rt-4.0.10-90-gac11ea5

[Kevin Falcone]

The branch, 4.0/document-extractsubjecttag has been created
        at  ac11ea55a6ef39627f38ecb58487960b57414190 (commit)

- Log -----------------------------------------------------------------
commit 313eb19e3cb6a6d96fc2dce6f2f5bd1fa767110e
Author: Kai Storbeck <kai at xs4all.nl>
Date:   Wed Mar 13 09:53:36 2013 +0100

    Add documentation to RT::Action::ExtractSubjectTag

diff --git a/lib/RT/Action/ExtractSubjectTag.pm b/lib/RT/Action/ExtractSubjectTag.pm
index 72147b4..c409512 100644
--- a/lib/RT/Action/ExtractSubjectTag.pm
+++ b/lib/RT/Action/ExtractSubjectTag.pm
@@ -46,6 +46,44 @@
 #
 # END BPS TAGGED BLOCK }}}
 
+=head1 NAME
+
+  RT::Action::ExtractSubjectTag
+
+=head1 DESCRIPTION
+
+ExtractSubjectTag is a ScripAction which allows ticket bonding between
+two RT instances or between RT and other Ticket systems like Siebel
+or Remedy.
+
+Default this ScripAction is set up to run on every transaction on 
+every Correspondence.
+
+One can configure this ScripActions behaviour by changing the
+global ExtractSubjectTagMatch in RT_Config.pm.
+
+If a transaction's subject matches this regexp, we're appending the match
+tag to the current subject.
+
+Take care to not remove the current default setting where it matches
+only a remote RT instance.
+
+
+
+=head1 EXAMPLE
+
+As an example, Siebel will set their subject tag to something
+like:
+
+    B<[SR ID:1-554]>
+
+To record this tag in the local ticket's subject, we need to change
+ExtractSubjectTagMatch to something like:
+
+    Set($ExtractSubjectTagMatch, qr/\[[^\]]+[#:][0-9-]+\]/);
+
+=cut
+
 package RT::Action::ExtractSubjectTag;
 use base 'RT::Action';
 use strict;

commit ac11ea55a6ef39627f38ecb58487960b57414190
Author: Kevin Falcone <falcone at bestpractical.com>
Date:   Thu Mar 14 12:20:38 2013 -0400

    Cleanups and Clarification of new ExtractSubjectTag docs
    
    Explain a little more about how it works (changing the Ticket), podify
    in a few places and a few minor grammatical nits.

diff --git a/lib/RT/Action/ExtractSubjectTag.pm b/lib/RT/Action/ExtractSubjectTag.pm
index c409512..efd0a80 100644
--- a/lib/RT/Action/ExtractSubjectTag.pm
+++ b/lib/RT/Action/ExtractSubjectTag.pm
@@ -56,19 +56,19 @@ ExtractSubjectTag is a ScripAction which allows ticket bonding between
 two RT instances or between RT and other Ticket systems like Siebel
 or Remedy.
 
-Default this ScripAction is set up to run on every transaction on 
+By default this ScripAction is set up to run on every transaction on
 every Correspondence.
 
 One can configure this ScripActions behaviour by changing the
-global ExtractSubjectTagMatch in RT_Config.pm.
-
-If a transaction's subject matches this regexp, we're appending the match
-tag to the current subject.
-
-Take care to not remove the current default setting where it matches
-only a remote RT instance.
+global C<$ExtractSubjectTagMatch> in C<RT_Config.pm>.
 
+If a transaction's subject matches this regexp, we append the match
+tag to the ticket's current subject. This help's ensure that
+further communication on the ticket will include the remote
+system's subject tag.
 
+If you modify this code, be careful not to remove the code where it
+ensures that it only examines remote systems.
 
 =head1 EXAMPLE
 

-----------------------------------------------------------------------