Differences

This shows you the differences between two versions of the page.

Link to this comparison view

72:email_feedback [2018/07/17 13:52] (current)
bkkr created
Line 1: Line 1:
 +[[:​72:​configure_stages|Configure the Stages Server]]
 +
 +====== Email Feedback Mechanism ======
 +
 +Stages contains a feature for user feedback via e-mail. The users can then write feedback mails by simply using the predefined mail addresses. The feedback can thereby be given for a configurable number of categories. These categories must be configured in the ''<​font inherit/​Courier New,​Courier,​monospace;;​inherit;;​inherit><​PKITHOME>/​WEB-INF/​conf/​PKitConfig.xml</​font>'' ​ configuration file.
 +
 +The following example describes such a configuration:​
 +
 +<​code>​
 +<​feedback address="​defaultfeedback@example.com">​
 + <​categories>​
 +
 + <​category ident="​process"​ address="​processfeedback@example.com"/>​
 + <​category ident="​misc"/>​
 + </​categories>​
 +</​feedback>​
 +</​code>​
 +
 +In this configuration,​ two categories "​process"​ and "​misc"​ are defined. The feedback for the "​process"​ category will be sent to "​processfeedback@example.com",​ all other feedback will be sent to the default address "​defaultfeedback@example.com"​ defined directly at the "​feedback"​ element.
 +
 +For every category, a cleartext message must be configured that will be shown to the user on the GUI and that will also be used as the e-mail subject. This messages are defined via properties and must be named
 +
 +<​code>​
 +feedback.category.CATEGORY-IDENT = CLEARTEXT MESSAGE
 +</​code>​
 +
 +For example, to define a user message and e-mail subject for the "​process"​ category, "​feedback.category.process = Process"​ would be used.
 +
 +//Note//: E-mail notification has to be defined properly in order to enable the feedback mechanism. The corresponding feedback link is shown in the service area.
 +