Customizing Email Templates

Debugging Email Notifications

To save email data: add setting named notifications/dump_files=1 to configuration file config dir\config.txt.
Approval Manager will save data files used in emails to the following location:
files storage dir\notifications\\user_id\production_list.xml.message.xml
and
files storage dir\notifications\\user_id\review_list.xml.message.xml
Use the files to understand what data is used to create the notifications

Notification XML Document

• review_list - root
  • @_user_name - target user name
• review_list/items - list of proofs in the notification
• review_list/items/item - proof
  • @proof_id - proof id
  • @name - name of the item, usually "file 'filename.ext'"
  • @proof - proof name
  • @manager_comment - the text entered by the manager in "Manager's Note" field
  • @sign - sign of importance of the item, such as "attention", "exclamation", "done"
  • @status - status of the item, such as "Review in Progress", "Review Past Due"
  • @due_date - Due Date
  • @step_id - id of the step (aka round)
  • @proof_url - url of the proof
  • @first_file_name - name of the first file
  • @first_file_url - url of first file
  • @group_description_secondary_part - second part of description, such as "and 2 more files"
• review_list/items/item/files - list of files in the proof
• review_list/items/item/files/file - each file
  • @url - file url
  • @thumbnail - thumbnail path
  • @thumbnail_size - thumbnail size
• review_list/items/item/_buttons - buttons with links
• review_list/items/item/button - each button
  • @title - title text, such as "Review", "View My Review List"
  • @name - name of button, such as "review_file_group", "view_review_list", "manage_proof"
  • @uri - url to the action
  • @mode - one of "note", "line" - where the button appears, on the line with the item, on in the notes section
  • @code - button code, such as "R" for review, "V" for "View My Review List"
• review_list/message_notes/note - note describing autologin aspect of the links
• review_list/_buttons - buttons with links
  • review_list/_buttons/button @mode="letter" buttons have "letter" mode
• review_list/appearance - appearance aspects set up in the custom appearance administration section
• review_list/appearance/logo - logo html
• review_list/appearance/background-color - background color
• review_list/appearance/color - text color