rt/docs/queue_subject_tag.pod

   1 =head1 INTRODUCTION
   2
   3 This text is about 'Subject Tag' property of a queue. This
   4 property allows you to use different tags in subjects of
   5 RT's notifications, by default it's rtname option from
   6 the config file as it's been for a long time, now you can
   7 use different values for different queues.
   8
   9 =head1 CONFIGURATION
  10
  11 =head2 Setting subject tag
  12
  13 Open RT's web UI, goto -E<gt> Configuration -E<gt> Queues
  14 -E<gt> select a queue -E<gt> set 'subject tag' -E<gt>
  15 save changes.
  16
  17 =head2 Using tag in templates
  18
  19 Usually you don't need to add some code into templates to
  20 make subject tags work. A tag will be added in the
  21 beginning of subject right before sending email out.
  22
  23 If you want to subjects to be "prefix [tag] real subject" like
  24 in default autoreply then you can use the following code in
  25 templates to place subject tag whenever you want in a template:
  26
  27     [{ $Ticket->QueueObj->SubjectTag || $rtname } #{$Ticket->id()}]
  28
  29 B<Note> that in the extension from the CPAN Tag method have
  30 been used when in 3.8 and newer it's SubjectTag, so you have to upgrade
  31 your templates. Read L</UPGRADING> below.
  32
  33 =head1 This functionality vs. RT-Extension-BrandedQueues
  34
  35 RT-Extension-BrandedQueues is extension that's available from
  36 the CPAN for older versions of RT. Starting from RT 3.8 it's
  37 been integrated into RT core. If you are B<UPGRADING> from
  38 older version and were using extension from the CPAN then you
  39 MUST read L</UPGRADING> below.
  40
  41 =head1 UPGRADING
  42
  43 =head2 For everyone who is upgrading
  44
  45 You need to modify any of your email templates which use
  46 the $rtname variable. To edit your templates, log into RT
  47 as your administrative user, then click:
  48
  49 Configuration -> Global -> Templates -> <Some template name>
  50
  51 For example, RT's default "Autoreply" includes this line:
  52
  53  "There is no need to reply to this message right now.  Your ticket has been
  54  assigned an ID of [{$rtname} #{$Ticket->id()}]."
  55
  56 Change this line to read:
  57
  58  "There is no need to reply to this message right now.  Your ticket has been
  59  assigned an ID of [{ $Ticket->QueueObj->SubjectTag || $rtname } #{$Ticket->id()}]."
  60
  61 =head2 For users of RT-Extension-BrandedQueues
  62
  63 1) You MUST uninstall RT-Extension-BrandedQueues before upgrade
  64 or use clean new dir for installation and reinstall your local
  65 customizations. The latter way is recommended as there are many
  66 changes in RT 3.8 and several extensions have been integrated
  67 into core.
  68
  69 2) We expect that you have backup of your RT DB around during upgrade.
  70
  71 3) After upgrade run perl script 'etc/upgrade/3.8-branded-queues-extension'.
  72 This script will convert data in the DB into new format.
  73
  74 4) In templates where you were using Tag method (for example
  75 C<< $Ticket-E<gt>QueueObj-E<gt>Tag >>) replace it with
  76 C<< $Ticket-E<gt>QueueObj-E<gt>SubjectTag >>. Read more in
  77 L</"Using tag in templates">
  78
  79 =cut