Difference between revisions of "JSP Attachment Deprecation"

From AgileApps Support Wiki
imported>Aeric
imported>Aeric
Line 8: Line 8:
:* If necessary, use Java code to create a [[Document Template Class]], and use that class to provide the data that the template processes.
:* If necessary, use Java code to create a [[Document Template Class]], and use that class to provide the data that the template processes.


{{Best|Identify existing document templates that are based on JSP pages, so designers know to avoid them in the contexts listed above. For example, add the word "JSP" to the template name. (That practice also helps to identify document templates that need to be converted.)}}
{{Best|Identify email templates that include a JSP-based attachment, so designers and developers know to avoid them in Rules, Processes and Java code. For example, add the word "Interactive" or "JSP" to the template name. (That practice also helps to identify document templates that need to be converted.)}}
}}
}}

Revision as of 00:47, 21 March 2014

Warn.png

DEPRECATED:
A document template based on a JSP page can no longer be included as attachment in an Email Template, due to limitations on the number of contexts in which it can be successfully used.

Explanation:

An attachment that is generated from JSP a template works when a message is sent interactively. However, it is not possible to send such an attachment from a Rule, a Process, or one of the Java sendEmail APIs.

Suggested Alternative: Use an HTML Document Template.

  • Use Velocity code for loops and conditionals, in place of Java code.
  • If necessary, use Java code to create a Document Template Class, and use that class to provide the data that the template processes.

Thumbsup.gif

Best Practice:
Identify email templates that include a JSP-based attachment, so designers and developers know to avoid them in Rules, Processes and Java code. For example, add the word "Interactive" or "JSP" to the template name. (That practice also helps to identify document templates that need to be converted.)