diff --git a/erpnext/config/setup.py b/erpnext/config/setup.py index 9c9bae2fdcb..878b2f2a0c6 100644 --- a/erpnext/config/setup.py +++ b/erpnext/config/setup.py @@ -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", diff --git a/erpnext/docs/assets/img/setup/feedback/__init__.py b/erpnext/docs/assets/img/setup/feedback/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/docs/assets/img/setup/feedback/feedback-trigger-condition.png b/erpnext/docs/assets/img/setup/feedback/feedback-trigger-condition.png new file mode 100644 index 00000000000..5fdae3c6df8 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/feedback-trigger-condition.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/feedback-trigger-subject.png b/erpnext/docs/assets/img/setup/feedback/feedback-trigger-subject.png new file mode 100644 index 00000000000..22c3f4cccd2 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/feedback-trigger-subject.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/manual-feedback-request-option.png b/erpnext/docs/assets/img/setup/feedback/manual-feedback-request-option.png new file mode 100644 index 00000000000..e9f6487b3e3 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/manual-feedback-request-option.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/manual-feedback-request.png b/erpnext/docs/assets/img/setup/feedback/manual-feedback-request.png new file mode 100644 index 00000000000..cf9ecc0f227 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/manual-feedback-request.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-button.png b/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-button.png new file mode 100644 index 00000000000..9a4b19d79b7 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-button.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-custom-message.png b/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-custom-message.png new file mode 100644 index 00000000000..a68f520a0e3 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/resend-feedback-request-custom-message.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger-message.png b/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger-message.png new file mode 100644 index 00000000000..6bc802ec2f9 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger-message.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger.png b/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger.png new file mode 100644 index 00000000000..dec03361f5a Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/setting-up-feedback-trigger.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/sidebar-ratings.png b/erpnext/docs/assets/img/setup/feedback/sidebar-ratings.png new file mode 100644 index 00000000000..72f4377b5cd Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/sidebar-ratings.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/submit-feedback.png b/erpnext/docs/assets/img/setup/feedback/submit-feedback.png new file mode 100644 index 00000000000..a1ccf0df835 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/submit-feedback.png differ diff --git a/erpnext/docs/assets/img/setup/feedback/timeline-rating-and-feedback.png b/erpnext/docs/assets/img/setup/feedback/timeline-rating-and-feedback.png new file mode 100644 index 00000000000..0f691d3d591 Binary files /dev/null and b/erpnext/docs/assets/img/setup/feedback/timeline-rating-and-feedback.png differ diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/__init__.py b/erpnext/docs/user/manual/en/setting-up/feedback/__init__.py new file mode 100644 index 00000000000..e69de29bb2d diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/index.md b/erpnext/docs/user/manual/en/setting-up/feedback/index.md new file mode 100644 index 00000000000..bb2efaffc53 --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/index.md @@ -0,0 +1,7 @@ +# Feedback + +Customer/User Feedback for a Product or Services can be useful for business as it can be used to make decisions for improvements either in products or services. + +### Topics + +{index} diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/index.txt b/erpnext/docs/user/manual/en/setting-up/feedback/index.txt new file mode 100644 index 00000000000..08160ccd71e --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/index.txt @@ -0,0 +1,4 @@ +setting-up-feedback +submit-feedback +resend-feedback-request +manual-feedback-request diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/manual-feedback-request.md b/erpnext/docs/user/manual/en/setting-up/feedback/manual-feedback-request.md new file mode 100644 index 00000000000..4afaee1fed5 --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/manual-feedback-request.md @@ -0,0 +1,17 @@ +# Manual Feedback Request + +We can also send the feedback request to Customer/User without configuring the +Feedback Trigger. + +To request a feedback manually go to respective document e.g. Sales Order, Issue etc. +and click on Ask a Feedback option in Menu. + +Setting Condition + +Then, user can enter the feedback request details like email id, message and send the +feedback request mail. + +Setting Condition + +Note. If Feedback Trigger is already configured for the document then system will fetch +Feedback Request details (email id, message) diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/resend-feedback-request.md b/erpnext/docs/user/manual/en/setting-up/feedback/resend-feedback-request.md new file mode 100644 index 00000000000..0dbb3b7340b --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/resend-feedback-request.md @@ -0,0 +1,16 @@ +# Resend Feedback Request + +We can also Resend the Feedback Request to the Customer/User. + +Setting Condition + +To resend the Feedback Request we will need to navigate the Communication by clicking the `Details` link on Timeline Feedback. + +Setting Condition + +On Resend Button click 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. + +Setting Condition + +{next} diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/setting-up-feedback.md b/erpnext/docs/user/manual/en/setting-up/feedback/setting-up-feedback.md new file mode 100644 index 00000000000..373d7032753 --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/setting-up-feedback.md @@ -0,0 +1,53 @@ +# 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 to 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" + +Setting Subject + +### Setting Conditions + +Feedback Trigger allows 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 a customer if an 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. + +Setting Condition + +### Setting a Message + +You can use both Jinja Tags (`{% raw %}{{ doc.[field_name] }}{% endraw %}`) and HTML tags in the message textbox. + + {% raw %}

Your Support Ticket is Resolved

+ +

Issue {{ doc.name }} Is resolved. Please check and confirm the same.

+

Your Feedback is important for us. Please give us your Feedback for {{ doc.name }}

+

Please visit the following url for feedback.

+ + {{ feedback_url }} + {% endraw %} + +--- + +### Example + +1. Setting up Feedback Trigger + Defining Criteria + +1. Setting the Recipients and Message + Set Message + +{next} diff --git a/erpnext/docs/user/manual/en/setting-up/feedback/submit-feedback.md b/erpnext/docs/user/manual/en/setting-up/feedback/submit-feedback.md new file mode 100644 index 00000000000..9069f3721b5 --- /dev/null +++ b/erpnext/docs/user/manual/en/setting-up/feedback/submit-feedback.md @@ -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. + +Setting Condition + +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. + +Setting Condition + +Also, The Feedback details such as Feedback message and ratings will be shown in the Document's Timeline along +with Comment, Email. + +Setting Condition + +{next} \ No newline at end of file