diff options
Diffstat (limited to 'rt/docs/queue_subject_tag.pod')
-rw-r--r-- | rt/docs/queue_subject_tag.pod | 79 |
1 files changed, 79 insertions, 0 deletions
diff --git a/rt/docs/queue_subject_tag.pod b/rt/docs/queue_subject_tag.pod new file mode 100644 index 0000000..084c813 --- /dev/null +++ b/rt/docs/queue_subject_tag.pod @@ -0,0 +1,79 @@ +=head1 INTRODUCTION + +This text is about 'Subject Tag' property of a queue. This +property allows you to use different tags in subjects of +RT's notifications, by default it's rtname option from +the config file as it's been for a long time, now you can +use different values for different queues. + +=head1 CONFIGURATION + +=head2 Setting subject tag + +Open RT's web UI, goto -E<gt> Configuration -E<gt> Queues +-E<gt> select a queue -E<gt> set 'subject tag' -E<gt> +save changes. + +=head2 Using tag in templates + +Usually you don't need to add some code into templates to +make subject tags work. A tag will be added in the +beginning of subject right before sending email out. + +If you want to subjects to be "prefix [tag] real subject" like +in default autoreply then you can use the following code in +templates to place subject tag whenever you want in a template: + + [{ $Ticket->QueueObj->SubjectTag || $rtname } #{$Ticket->id()}] + +B<Note> that in the extension from the CPAN Tag method have +been used when in 3.8 and newer it's SubjectTag, so you have to upgrade +your templates. Read L</UPGRADING> below. + +=head1 This functionality vs. RT-Extension-BrandedQueues + +RT-Extension-BrandedQueues is extension that's available from +the CPAN for older versions of RT. Starting from RT 3.8 it's +been integrated into RT core. If you are B<UPGRADING> from +older version and were using extension from the CPAN then you +MUST read L</UPGRADING> below. + +=head1 UPGRADING + +=head2 For everyone who is upgrading + +You need to modify any of your email templates which use +the $rtname variable. To edit your templates, log into RT +as your administrative user, then click: + +Configuration -> Global -> Templates -> <Some template name> + +For example, RT's default "Autoreply" includes this line: + + "There is no need to reply to this message right now. Your ticket has been + assigned an ID of [{$rtname} #{$Ticket->id()}]." + +Change this line to read: + + "There is no need to reply to this message right now. Your ticket has been + assigned an ID of [{ $Ticket->QueueObj->SubjectTag || $rtname } #{$Ticket->id()}]." + +=head2 For users of RT-Extension-BrandedQueues + +1) You MUST uninstall RT-Extension-BrandedQueues before upgrade +or use clean new dir for installation and reinstall your local +customizations. The latter way is recommended as there are many +changes in RT 3.8 and several extensions have been integrated +into core. + +2) We expect that you have backup of your RT DB around during upgrade. + +3) After upgrade run perl script 'etc/upgrade/3.8-branded-queues-extension'. +This script will convert data in the DB into new format. + +4) In templates where you were using Tag method (for example +C<< $Ticket-E<gt>QueueObj-E<gt>Tag >>) replace it with +C<< $Ticket-E<gt>QueueObj-E<gt>SubjectTag >>. Read more in +L</"Using tag in templates"> + +=cut |