[docs] Feedback triggers

This commit is contained in:
mbauskar 2017-02-01 18:25:21 +05:30
parent 70fd8546ce
commit 298acd3d1a
17 changed files with 104 additions and 0 deletions

View File

@ -94,6 +94,12 @@ def get_data():
"label": _("Email"),
"icon": "fa fa-envelope",
"items": [
{
"type": "doctype",
"name": "Feedback Trigger",
"label": _("Feedback Trigger"),
"description": _("Automatically triggers the feedback request based on conditions.")
},
{
"type": "doctype",
"name": "Email Digest",

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 25 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

@ -0,0 +1,7 @@
# Feedback
Customer/User Feedback for a Product or Services can be usefull for business as it can be used to make decisions for imporvements either in products or services. Feedback can also give the insight on which area Services/Product is excelling or lacking.
### Topics
{index}

View File

@ -0,0 +1,3 @@
setting-up-feedback
submit-feedback
resend-feedback-request

View File

@ -0,0 +1,14 @@
# Resend Feedback Request
We can also Resend the Feedback Request to the Customer/User.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/timeline-rating-and-feedback.png">
To resend the Feedback Request we will need to navigate the Communication by clicking the `Details` link on Timeline Feedback.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/resend-feedback-request-button.png">
On Resend Button click the a dialog with the Feedback Request message will appear user can either send the
Feedback Request with same message or he/she can make the changes in the Feedback Request message.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/resend-feedback-request-custom-message.png">

View File

@ -0,0 +1,55 @@
# Feedback Trigger
You can set up the Feedback Trigger for various documents to get the Feedback from the user.
For this you will need to setup the Feedback Trigger,
> Setup > Email > Feedback Trigger
### Setting Up Feedback Trigger
To Setup an Feedback:
1. Select which Document Type you want send feedback request mail.
2. Select the Email Field, This field will be used to get the recipients email id.
3. Set the Subject for feedback request mail.
4. Set the conditions, if all the conditions are met only then the feedback request mail will be sent.
5. Compose the message.
### Setting a Subject
You can retrieve the data for a particular field by using `doc.[field_name]`. To use it in your subject / message, you have to surround it with `{% raw %}{{ }}{% endraw %}`. These are called [Jinja](http://jinja.pocoo.org/) tags. So, for example to get the name of a document, you use `{% raw %}{{ doc.name }}{% endraw %}`. The below example sends an feedback request whenever Issue is Closed with the Subject, "ISS-##### Issue is Resolved"
<img class="screenshot" alt="Setting Subject" src="{{docs_base_url}}/assets/img/setup/feedback/feedback-trigger-subject.png">
### Setting Conditions
Feedback Trigger allow you to set conditions according to the field data in your documents. The feedback request email will be sent on document save only if the all conditions are true For example, if you want to trigger the feedback request mail to customer if a Issue is has been saved as "Closed" as it's status, you put `doc.status == "Closed"` in the conditions textbox. You can also set more complex conditions by combining them.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/feedback-trigger-condition.png">
### Setting a Message
You can use both Jinja Tags (`{% raw %}{{ doc.[field_name] }}{% endraw %}`) and HTML tags in the message textbox.
{% raw %}<h3>Your Support Ticket is Resolved</h3>
<p>Issue {{ doc.name }} Is resolved. Please check and confirm the same.</p>
<p> Your Feedback is important for us. Please give us your Feedback for {{ doc.name }}</p>
<p> Please visit the following url for feedback.</p>
{{ feedback_url }}
{% endraw %}
Please note the to include Feedback URL in the feedback request mail message body you will need to include the `{% raw %}{{ feedback_url }}{% endraw %}` in message while setting up the feedback trigger.
---
### Example
1. Setting up Feedback Trigger
<img class="screenshot" alt="Defining Criteria" src="{{docs_base_url}}/assets/img/setup/feedback/setting-up-feedback-trigger.png">
1. Setting the Recipients and Message
<img class="screenshot" alt="Set Message" src="{{docs_base_url}}/assets/img/setup/feedback/setting-up-feedback-trigger-message.png">
{next}

View File

@ -0,0 +1,19 @@
# Submit Feedback
Once feedback request mail is sent the user/customer. He/She can visit the URL to submit the feedback
as well as rating for the document.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/submit-feedback.png">
Once Feedback is submitted the feedback details message and ratings will be recorded and will be shown on Document sidebar and timeline. Also once the Feedback is successfully submitted by the user the link shared to the user will be expired and can not be used to submit the Feedback again.
On Document sidebar the latest feedback ratings will displayed.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/sidebar-ratings.png">
Also, The Feedback details such as Feedback message and ratings will be shown in the Document's Timeline along
with Comment, Email.
<img class="screenshot" alt="Setting Condition" src="{{docs_base_url}}/assets/img/setup/feedback/timeline-rating-and-feedback.png">
{next}