diff --git a/foundation/www/docs/assets/img/setup/notifications/__init__.py b/foundation/www/docs/assets/img/setup/notifications/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/foundation/www/docs/assets/img/setup/email/email-alert-1.png b/foundation/www/docs/assets/img/setup/notifications/email-alert-1.png similarity index 100% rename from foundation/www/docs/assets/img/setup/email/email-alert-1.png rename to foundation/www/docs/assets/img/setup/notifications/email-alert-1.png diff --git a/foundation/www/docs/assets/img/setup/email/email-alert-2.png b/foundation/www/docs/assets/img/setup/notifications/email-alert-2.png similarity index 100% rename from foundation/www/docs/assets/img/setup/email/email-alert-2.png rename to foundation/www/docs/assets/img/setup/notifications/email-alert-2.png diff --git a/foundation/www/docs/assets/img/setup/email/email-alert-condition.png b/foundation/www/docs/assets/img/setup/notifications/email-alert-condition.png similarity index 100% rename from foundation/www/docs/assets/img/setup/email/email-alert-condition.png rename to foundation/www/docs/assets/img/setup/notifications/email-alert-condition.png diff --git a/foundation/www/docs/assets/img/setup/email/email-alert-set-property.png b/foundation/www/docs/assets/img/setup/notifications/email-alert-set-property.png similarity index 100% rename from foundation/www/docs/assets/img/setup/email/email-alert-set-property.png rename to foundation/www/docs/assets/img/setup/notifications/email-alert-set-property.png diff --git a/foundation/www/docs/assets/img/setup/email/email-alert-subject.png b/foundation/www/docs/assets/img/setup/notifications/email-alert-subject.png similarity index 100% rename from foundation/www/docs/assets/img/setup/email/email-alert-subject.png rename to foundation/www/docs/assets/img/setup/notifications/email-alert-subject.png diff --git a/foundation/www/docs/assets/img/setup/notifications/slack_notification_1.png b/foundation/www/docs/assets/img/setup/notifications/slack_notification_1.png new file mode 100644 index 00000000..ec47f14f Binary files /dev/null and b/foundation/www/docs/assets/img/setup/notifications/slack_notification_1.png differ diff --git a/foundation/www/docs/assets/img/setup/notifications/slack_notification_2.png b/foundation/www/docs/assets/img/setup/notifications/slack_notification_2.png new file mode 100644 index 00000000..a79b13bb Binary files /dev/null and b/foundation/www/docs/assets/img/setup/notifications/slack_notification_2.png differ diff --git a/foundation/www/docs/assets/img/setup/notifications/slack_notification_3.png b/foundation/www/docs/assets/img/setup/notifications/slack_notification_3.png new file mode 100644 index 00000000..895ad876 Binary files /dev/null and b/foundation/www/docs/assets/img/setup/notifications/slack_notification_3.png differ diff --git a/foundation/www/docs/assets/img/setup/notifications/slack_notification_4.png b/foundation/www/docs/assets/img/setup/notifications/slack_notification_4.png new file mode 100644 index 00000000..5e6cef3c Binary files /dev/null and b/foundation/www/docs/assets/img/setup/notifications/slack_notification_4.png differ diff --git a/foundation/www/docs/user/manual/en/setting-up/email/index.txt b/foundation/www/docs/user/manual/en/setting-up/email/index.txt index 778fc812..61daf042 100755 --- a/foundation/www/docs/user/manual/en/setting-up/email/index.txt +++ b/foundation/www/docs/user/manual/en/setting-up/email/index.txt @@ -3,4 +3,5 @@ email-inbox email-alerts email-digest email-reports -sending-email \ No newline at end of file +sending-email +use-cases \ No newline at end of file diff --git a/foundation/www/docs/user/manual/en/setting-up/email/.md b/foundation/www/docs/user/manual/en/setting-up/email/use-cases.md similarity index 100% rename from foundation/www/docs/user/manual/en/setting-up/email/.md rename to foundation/www/docs/user/manual/en/setting-up/email/use-cases.md diff --git a/foundation/www/docs/user/manual/en/setting-up/notifications/__init__.py b/foundation/www/docs/user/manual/en/setting-up/notifications/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/foundation/www/docs/user/manual/en/setting-up/email/email-alerts.md b/foundation/www/docs/user/manual/en/setting-up/notifications/index.md old mode 100755 new mode 100644 similarity index 55% rename from foundation/www/docs/user/manual/en/setting-up/email/email-alerts.md rename to foundation/www/docs/user/manual/en/setting-up/notifications/index.md index e1968f04..9c5d0d53 --- a/foundation/www/docs/user/manual/en/setting-up/email/email-alerts.md +++ b/foundation/www/docs/user/manual/en/setting-up/notifications/index.md @@ -1,7 +1,7 @@ -# Email Alerts +# Notifications -You can configure various email alerts in your system to remind you of important activities such as: +You can configure various Notifications in your system to remind you of important activities such as: 1. Completion date of a Task. 2. Expected Delivery Date of a Sales Order. @@ -11,13 +11,13 @@ You can configure various email alerts in your system to remind you of important 6. Expiry notification for a Contract. 7. Completion / Status change of a Task. -For this, you need to setup an Email Alert. +For this, you need to setup an Notification. -> Setup > Email > Email Alert +> Setup > Email > Notification ### Setting Up An Alert -To setup an Email Alert: +To setup an Notification: 1. Select which Document Type you want watch changes on 2. Define what events you want to watch. Events are: @@ -33,15 +33,15 @@ To setup an Email Alert: ### 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 email on saving a Task with the Subject, "TASK##### has been created" -Setting Subject +Setting Subject ### Setting Conditions -Email alerts allow you to set conditions according to the field data in your documents. For example, if you want to recieve an Email if a Lead has been saved as "Interested" as it's status, you put `doc.status == "Interested"` in the conditions textbox. You can also set more complex conditions by combining them. +Notifications allow you to set conditions according to the field data in your documents. For example, if you want to recieve an Email if a Lead has been saved as "Interested" as it's status, you put `doc.status == "Interested"` in the conditions textbox. You can also set more complex conditions by combining them. -Setting Condition +Setting Condition -The above example will send an Email Alert when a Task is saved with the status "Open" and the Expected End Date for the Task is the date on or before the date on which it was saved on. +The above example will send an Notification when a Task is saved with the status "Open" and the Expected End Date for the Task is the date on or before the date on which it was saved on. ### Setting a Message @@ -68,21 +68,42 @@ You can use both Jinja Tags (`{% raw %}{{ doc.[field_name] }}{% endraw %}`) and ### Setting a Value after the Alert is Set -Sometimes to make sure that the email alert is not sent multiple times, you can -define a custom property (via Customize Form) like "Email Alert Sent" and then +Sometimes to make sure that the Notification is not sent multiple times, you can +define a custom property (via Customize Form) like "Notification Sent" and then set this property after the alert is sent by setting the **Set Property After Alert** field. Then you can use that as a condition in the **Condition** rules to ensure emails are not sent multiple times -Setting Property in Email Alert +Setting Property in Notification ### Example 1. Defining the Criteria - Defining Criteria + Defining Criteria 1. Setting the Recipients and Message - Set Message + Set Message -{next} + +--- + +### Configuring Slack notifications + +Instead of sending a notification through emails, you can configure a Slack Webhook URL and receive your notification directly in Slack. + +1. Create a Slack App + +Set Message + +2. Create new Slack Webhook URLs + +Set Message + +3. Add the Slack Webhook URL to ERPNext + +Set Message + +4. Select Slack and your Slack channel in the channel and Slack channel fields within your notification + +Set Message \ No newline at end of file