diff --git a/discuss.rst b/discuss.rst index b85d42866..46b9b873b 100644 --- a/discuss.rst +++ b/discuss.rst @@ -8,8 +8,9 @@ Discuss :titlesonly: discuss/overview - discuss/team_communication + discuss/tracking discuss/monitoring discuss/mentions - discuss/tracking - discuss/integrations \ No newline at end of file + discuss/team_communication + discuss/mail_twitter + discuss/email_servers \ No newline at end of file diff --git a/discuss/email_servers.rst b/discuss/email_servers.rst new file mode 100644 index 000000000..78d3d4f4b --- /dev/null +++ b/discuss/email_servers.rst @@ -0,0 +1,99 @@ +==================================================================== +How to use my own email servers to send and receive messages in Odoo +==================================================================== + +When is it needed +================= +You need it if you use Odoo Community or Enterprise. + +What if I use Odoo Online +========================= +You are done! Odoo Online comes up with an embedded and ready-to-use email +server (*@yourcompany.odoo.com*). +We recommend to keep this default setting as is as it is really convenient. + +Indeed, while it is branded by Odoo, the visible source of any message +sent from Odoo will be your personal email address (your Odoo login). +Your contacts will therefore trust your messages. + +How does it work when a contact replies to an email sent from Odoo +================================================================== +Default reply-to is a generic address used to automatically route +any incoming email to the discussion thread of the origin business object +(opportunity, order, task, etc.) and to the inbox of all its followers. +By default this address is "catchall@" but it can be changed. +Thanks to it, you get a perfect message thread in Odoo and you don't +pollute your external email box with Odoo-related topics. + +How to use my own email servers +=============================== +You need to be a system admin to set this up. +Go to :menuselection:`Settings --> General Settings` and check *External +Email Servers* (watch out: this checkbox only shows up after Odoo 10). +Then, go through the following steps. + +Set an outgoing email server for outbound messages +-------------------------------------------------- +You need the SMTP data of your email provider (Gmail, Outlook, +Yahoo, AOL, etc.) as well as your admin credentials. +Once all the information has been filled out, click on *Test Connection*. + +.. image:: media/outgoing_server.png + :align: center + +Set an incoming email server for inbound messages +------------------------------------------------- +Fill out the form according to your email provider’s settings. +Leave the *Actions to Perform on Incoming Mails* blank. Once all the +information has been filled out, click on *TEST & CONFIRM*. + +.. image:: media/incoming_server.png + :align: center + +.. note:: By default inbound messages are fetched every 5 minutes. + You can change this value in developer mode. + Go to :menuselection:`Settings --> Technical --> Automation --> + Scheduled Actions` and look for *Mail: Fetchmail Service*. + +Set the domain name +------------------- +Enter the domain name of your email servers (e.g. mycompany.com) +in General Settings. + +.. image:: media/alias_domain.png + :align: center + +Create a catchall address +------------------------- +Create a catchall address in your email server settings. We advise +you to use "catchall@" so that everything works out straight away. +If you want to use another alias, you have extra steps in Odoo: + +- Activate the developer mode from your Settings Dashboard. + +.. image:: media/developer_mode.png + :align: center + +- Refresh your screen. Then go to :menuselection:`Settings --> Technical + --> Parameters --> System Parameters` and enter your custom catchall alias + in *mail.catchall.alias*. + +.. image:: media/system_parameters.png + :align: center + +.. note:: You can edit the email alias used for bounced messages the same way. + +How to perfectly combine Odoo Discuss and my traditional email tool +=================================================================== +Odoo Discuss is a perfect tool to send and read messages related to +business objects. But it doesn't aim to replace a full-featured email +software (Gmail, Outlook, Yahoo, AOL, etc.). +We recommend to take the most out of both systems without mingling them: +What is related to Odoo business objects or applications goes into Odoo; +What is not stays into your external email boxes. + +To do so, create specific email aliases to use in Odoo (to generate leads +or opportunities, helpdesk tickets, etc.). If you take an email alias +already used for messaging outside of Odoo, incoming messages will land +into both systems. +This will negatively impact your productivity when it comes to process them. diff --git a/discuss/integrations.rst b/discuss/integrations.rst deleted file mode 100644 index 656212929..000000000 --- a/discuss/integrations.rst +++ /dev/null @@ -1,10 +0,0 @@ -:banner: banners/discuss.jpg - -============ -Integrations -============ - -.. toctree:: - :titlesonly: - - integrations/mail_twitter \ No newline at end of file diff --git a/discuss/integrations/mail_twitter.rst b/discuss/mail_twitter.rst similarity index 82% rename from discuss/integrations/mail_twitter.rst rename to discuss/mail_twitter.rst index 8ce922b6d..b736326bf 100644 --- a/discuss/integrations/mail_twitter.rst +++ b/discuss/mail_twitter.rst @@ -1,12 +1,12 @@ -====================================== -Integrating Twitter Feed with Channels -====================================== +==================================== +How to follow Twitter feed from Odoo +==================================== .. image:: media/twitter_user-image.png :align: center -A user can follow specific hashtags on twitter and see the tweets within the -channels of his/her choice. The tweets are retrieved periodically from Twitter. +You can follow specific hashtags on Twitter and see the tweets within the +Odoo Discuss channels of your choice. The tweets are retrieved periodically from Twitter. An authenticated user can retweet the messages. Setting up the App on Twitter's side diff --git a/discuss/media/alias_domain.png b/discuss/media/alias_domain.png new file mode 100644 index 000000000..c71eb2534 Binary files /dev/null and b/discuss/media/alias_domain.png differ diff --git a/discuss/integrations/media/api_key.png b/discuss/media/api_key.png similarity index 100% rename from discuss/integrations/media/api_key.png rename to discuss/media/api_key.png diff --git a/discuss/media/developer_mode.png b/discuss/media/developer_mode.png new file mode 100644 index 000000000..4a8668de3 Binary files /dev/null and b/discuss/media/developer_mode.png differ diff --git a/discuss/overview/media/discuss01.png b/discuss/media/discuss01.png similarity index 100% rename from discuss/overview/media/discuss01.png rename to discuss/media/discuss01.png diff --git a/discuss/team_communication/media/discuss02.png b/discuss/media/discuss02.png similarity index 100% rename from discuss/team_communication/media/discuss02.png rename to discuss/media/discuss02.png diff --git a/discuss/team_communication/media/discuss03.png b/discuss/media/discuss03.png similarity index 100% rename from discuss/team_communication/media/discuss03.png rename to discuss/media/discuss03.png diff --git a/discuss/monitoring/media/discuss04.png b/discuss/media/discuss04.png similarity index 100% rename from discuss/monitoring/media/discuss04.png rename to discuss/media/discuss04.png diff --git a/discuss/monitoring/media/discuss05.png b/discuss/media/discuss05.png similarity index 100% rename from discuss/monitoring/media/discuss05.png rename to discuss/media/discuss05.png diff --git a/discuss/mentions/media/discuss06.png b/discuss/media/discuss06.png similarity index 100% rename from discuss/mentions/media/discuss06.png rename to discuss/media/discuss06.png diff --git a/discuss/tracking/media/discuss07.png b/discuss/media/discuss07.png similarity index 100% rename from discuss/tracking/media/discuss07.png rename to discuss/media/discuss07.png diff --git a/discuss/tracking/media/discuss08.png b/discuss/media/discuss08.png similarity index 100% rename from discuss/tracking/media/discuss08.png rename to discuss/media/discuss08.png diff --git a/discuss/tracking/media/discuss09.png b/discuss/media/discuss09.png similarity index 100% rename from discuss/tracking/media/discuss09.png rename to discuss/media/discuss09.png diff --git a/discuss/tracking/media/discuss10.png b/discuss/media/discuss10.png similarity index 100% rename from discuss/tracking/media/discuss10.png rename to discuss/media/discuss10.png diff --git a/discuss/media/inbox.png b/discuss/media/inbox.png new file mode 100644 index 000000000..67ac258ba Binary files /dev/null and b/discuss/media/inbox.png differ diff --git a/discuss/media/incoming_server.png b/discuss/media/incoming_server.png new file mode 100644 index 000000000..7a971e96a Binary files /dev/null and b/discuss/media/incoming_server.png differ diff --git a/discuss/media/outgoing_server.png b/discuss/media/outgoing_server.png new file mode 100644 index 000000000..72be5c3e8 Binary files /dev/null and b/discuss/media/outgoing_server.png differ diff --git a/discuss/media/sales_channel_follow.png b/discuss/media/sales_channel_follow.png new file mode 100644 index 000000000..ec482d2e4 Binary files /dev/null and b/discuss/media/sales_channel_follow.png differ diff --git a/discuss/media/system_parameters.png b/discuss/media/system_parameters.png new file mode 100644 index 000000000..21b785ed2 Binary files /dev/null and b/discuss/media/system_parameters.png differ diff --git a/discuss/integrations/media/twitter_user-image.png b/discuss/media/twitter_user-image.png similarity index 100% rename from discuss/integrations/media/twitter_user-image.png rename to discuss/media/twitter_user-image.png diff --git a/discuss/mentions.rst b/discuss/mentions.rst index 8f207630d..2b2606f07 100644 --- a/discuss/mentions.rst +++ b/discuss/mentions.rst @@ -1,10 +1,38 @@ -:banner: banners/discuss.jpg +=================================================== +How to grab attention of other users in my messages +=================================================== -======== -Mentions -======== +You can **mention** a user in a channel or chatter by typing +**@user-name**. Mentioning a user in the chatter will set them as a +follower of the item (if they are not already) and send a message to +their inbox. The item containing the mention will also be bolded in the +list view. Mentioning a user in a channel will send a message to their +inbox. You cannot mention a user in a channel who is not subscribed to +the channel. Typing **#channel-name** will provide a link to the +mentioned channel in either a chatter or another channel. -.. toctree:: - :titlesonly: +Direct messaging a user +======================= + +**Direct messages** are private messages viewable only by the sender +and recipient. You can send direct messages to other users from +within the Discuss module by creating a new conversation or +selecting an existing one from the sidebar. Direct messages can be +sent from anywhere in Odoo using the speech bubble icon in the top +bar. The online status of other users is displayed to the left of +their name. A **green dot** indicates that a user is Online, an +**orange dot** that they are Idle, and a **grey dot** that they are +offline. + +Desktop notifications from Discuss +================================== + +You can choose to see **desktop notifications** when you receive a +new direct message. The notification shows you the sender and a +brief preview of the message contents. These can be configured or +disabled by clicking on the gear icon in the corner of the +notification.. + +.. image:: media/discuss06.png + :align: center - mentions/mentions \ No newline at end of file diff --git a/discuss/mentions/mentions.rst b/discuss/mentions/mentions.rst deleted file mode 100644 index 51186fb55..000000000 --- a/discuss/mentions/mentions.rst +++ /dev/null @@ -1,38 +0,0 @@ -==================================================== -Grabbing Attention with Direct Messages and Mentions -==================================================== - -You can **mention** a user in a channel or chatter by typing -**@user-name**. Mentioning a user in the chatter will set them as a -follower of the item (if they are not already) and send a message to -their inbox. The item containing the mention will also be bolded in the -list view. Mentioning a user in a channel will send a message to their -inbox. You cannot mention a user in a channel who is not subscribed to -the channel. Typing **#channel-name** will provide a link to the -mentioned channel in either a chatter or another channel. - -Direct Messaging a User -======================= - -**Direct messages** are private messages viewable only by the sender -and recipient. You can send direct messages to other users from -within the Discuss module by creating a new conversation or -selecting an existing one from the sidebar. Direct messages can be -sent from anywhere in Odoo using the speech bubble icon in the top -bar. The online status of other users is displayed to the left of -their name. A **green dot** indicates that a user is Online, an -**orange dot** that they are Idle, and a **grey dot** that they are -offline. - -Desktop Notifications from Discuss -================================== - -You can choose to see **desktop notifications** when you receive a -new direct message. The notification shows you the sender and a -brief preview of the message contents. These can be configured or -disabled by clicking on the gear icon in the corner of the -notification.. - -.. image:: media/discuss06.png - :align: center - diff --git a/discuss/monitoring.rst b/discuss/monitoring.rst index bfa8897b0..de37047a4 100644 --- a/discuss/monitoring.rst +++ b/discuss/monitoring.rst @@ -1,10 +1,27 @@ -:banner: banners/discuss.jpg +==================================================== +How to be responsive at work thanks to my Odoo inbox +==================================================== -========== -Monitoring -========== +Use the **Inbox** in Discuss app to monitor updates and progress +on everything you do in Odoo. +Notifications and messages from everything you follow or in +which you are mentioned appear in your inbox. + +.. image:: media/discuss04.png + :align: center + +You can keep an eye on your **Inbox** from any screen. + +.. image:: media/inbox.png + :align: center + +Marking an item with a check marks the message as **read** and removes it +from your inbox. If you would like to save an item for future reference +or action, mark it with a star to add it to the **Starred** box. You can +star any message or notification in Discuss or any of the item-specific +chatters throughout Odoo to keep tabs on it here. + +.. image:: media/discuss05.png + :align: center -.. toctree:: - :titlesonly: - monitoring/monitoring \ No newline at end of file diff --git a/discuss/monitoring/monitoring.rst b/discuss/monitoring/monitoring.rst deleted file mode 100644 index 128e48293..000000000 --- a/discuss/monitoring/monitoring.rst +++ /dev/null @@ -1,27 +0,0 @@ -======================================== -Monitoring Your Messages Using the Inbox -======================================== - -.. image:: media/discuss04.png - :align: center - -Use the **inbox** to monitor updates and progress on everything you do -in Odoo. Notifications from everything you follow and conversations in -which you are mentioned appear in your inbox. - -.. image:: media/discuss05.png - :align: center - -Marking an item with a check sets the message to **read** and removes it -from your inbox. If you would like to save an item for future reference -or action, mark it with a star to add it to the **Starred** box. You can -star any message or notification in Discuss or any of the item-specific -chatters throughout Odoo to keep tabs on it here. - -Sending Emails -============== - -You can **send emails** from the inbox of Odoo Discuss. In addition -to the usual email features, you can select a template that you have -already created, or create one on the fly and save it for later use. - diff --git a/discuss/overview.rst b/discuss/overview.rst index 5d9458dc5..18ae03775 100644 --- a/discuss/overview.rst +++ b/discuss/overview.rst @@ -1,10 +1,15 @@ -:banner: banners/discuss.jpg +======================= +Why to use Odoo Discuss +======================= -======== -Overview -======== +Odoo Discuss is an easy to use messaging app for teams that brings all +your organization's communication into one place and seamlessly +integrates with the Odoo platform. Discuss lets you send and receive +messages from wherever you are in Odoo as well as manage your messages +and notifications easily from within the app. Discuss allows you to +create **channels** for team chats, conversations about projects, +meeting coordination, and more in one simple and searchable +interface. -.. toctree:: - :titlesonly: - - overview/overview \ No newline at end of file +.. image:: media/discuss01.png + :align: center diff --git a/discuss/overview/overview.rst b/discuss/overview/overview.rst deleted file mode 100644 index aa0b69819..000000000 --- a/discuss/overview/overview.rst +++ /dev/null @@ -1,15 +0,0 @@ -======== -Overview -======== - -Odoo Discuss is an easy to use messaging app for teams that brings all -your organization's communication into one place and seamlessly -integrates with the Odoo platform. Discuss lets you send and receive -messages from wherever you are in Odoo as well as manage your messages -and notifications easily from within the app. Discuss allows you to -create **channels** for team chats, conversations about projects, -meeting coordination, and more in one simple and searchable -interface. - -.. image:: media/discuss01.png - :align: center diff --git a/discuss/team_communication.rst b/discuss/team_communication.rst index 3b264aea3..7f2c4d6e1 100644 --- a/discuss/team_communication.rst +++ b/discuss/team_communication.rst @@ -1,10 +1,82 @@ -:banner: banners/discuss.jpg +===================================================== +How to efficiently communicate in team using channels +===================================================== -============= -Communication -============= +You can use **channels** to organize discussions between individual +teams, departments, projects, or any other group that requires regular +communication. By having conversations that everyone in the channel can +see, it's easy to keep the whole team in the loop with the latest +developments. -.. toctree:: - :titlesonly: +Creating a channel +================== - team_communication/team_communication \ No newline at end of file +In Discuss there are two types of channels - **public** and +**private**. + +A **public channel** can only be created by an administrator with +write privileges and can be seen by everyone in the organization. By +contrast, a **private channel** can be created by any user and by +default is only visible to users who have been invited to this +channel. + +.. note:: + A public channel is best used when many employees need to + access information (such as interdepartmental communication or + company announcements), whereas a private channel should be used + whenever information should be limited to specific users/employees + (such as department specific or sensitive information). + +Configuring a channel +===================== + +You can configure a channel's name, description, access rights, +automatic subscription, and emailing from +:menuselection:`#channel-name --> Settings`. +Changing channel access rights allows +you to control which groups can view each channel. You can make a +channel visible by all users, invited users, or users within a +selected user group. Note that allowing "Everyone" to follow a +private channel will let other users view and join it as they would +a public channel. + +.. image:: media/discuss02.png + :align: center + +How to set up a mailing list +============================ + +A channel can be configured to behave as a mailing list. From within +:menuselection:`#channel-name --> Settings`, define the email you would like to use. +Users can then post to the channel and choose to receive +notifications using the defined email address. An envelope icon will +appear next to the channel name in the list to indicate that a +channel will send messages by email. + +Locating a channel +================== + +If you do not see a channel on your dashboard, you can search the +list of **public channels** to locate the correct channel or create +a new channel by clicking the plus icon. + +.. image:: media/discuss03.png + :align: center + +You can also click the **CHANNELS** heading to browse a list of all +public channels. This allows the user to manually **join** and +**leave** public channels from a single screen. + +.. note:: + It is always wise to search for a channel before creating a new + one to ensure that duplicate entries are not created for the same topic. + + +Using filters to navigate within Discuss +======================================== + +The topbar search provides access to the same comprehensive search +function present in the rest of Odoo. You can apply multiple **filter +criteria** and **save filters** for later use. The search function +accepts wildcards by using the underscore character "\ **\_**\ " to +represent a **single character wildcard.** \ No newline at end of file diff --git a/discuss/team_communication/team_communication.rst b/discuss/team_communication/team_communication.rst deleted file mode 100644 index e020abbd8..000000000 --- a/discuss/team_communication/team_communication.rst +++ /dev/null @@ -1,82 +0,0 @@ -=========================================== -Communicating with Your Team Using Channels -=========================================== - -You can use **channels** to organize discussions between individual -teams, departments, projects, or any other group that requires regular -communication. By having conversations that everyone in the channel can -see, it's easy to keep the whole team in the loop with the latest -developments. - -Creating a Channel -================== - -In Discuss there are two types of channels - **public** and -**private**. - -A **public channel** can only be created by an administrator with -write privileges and can be seen by everyone in the organization. By -contrast, a **private channel** can be created by any user and by -default is only visible to users who have been invited to this -channel. - -.. note:: - A public channel is best used when many employees need to - access information (such as interdepartmental communication or - company announcements), whereas a private channel should be used - whenever information should be limited to specific users/employees - (such as department specific or sensitive information). - -Configuring a Channel -===================== - -You can configure a channel's name, description, access rights, -automatic subscription, and emailing from -:menuselection:`#channel-name --> Settings`. -Changing channel access rights allows -you to control which groups can view each channel. You can make a -channel visible by all users, invited users, or users within a -selected user group. Note that allowing "Everyone" to follow a -private channel will let other users view and join it as they would -a public channel. - -.. image:: media/discuss02.png - :align: center - -How To Set Up a Mailing List -============================ - -A channel can be configured to behave as a mailing list. From within -:menuselection:`#channel-name --> Settings`, define the email you would like to use. -Users can then post to the channel and choose to receive -notifications using the defined email address. An envelope icon will -appear next to the channel name in the list to indicate that a -channel will send messages by email. - -Locating a Channel -================== - -If you do not see a channel on your dashboard, you can search the -list of **public channels** to locate the correct channel or create -a new channel by clicking the plus icon. - -.. image:: media/discuss03.png - :align: center - -You can also click the **CHANNELS** heading to browse a list of all -public channels. This allows the user to manually **join** and -**leave** public channels from a single screen. - -.. note:: - It is always wise to search for a channel before creating a new - one to ensure that duplicate entries are not created for the same topic. - - -Using Filters to Navigate within Discuss -======================================== - -The topbar search provides access to the same comprehensive search -function present in the rest of Odoo. You can apply multiple **filter -criteria** and **save filters** for later use. The search function -accepts wildcards by using the underscore character "\ **\_**\ " to -represent a **single character wildcard.** \ No newline at end of file diff --git a/discuss/tracking.rst b/discuss/tracking.rst index 6d87791c4..9a7e98412 100644 --- a/discuss/tracking.rst +++ b/discuss/tracking.rst @@ -1,10 +1,45 @@ -:banner: banners/discuss.jpg +====================================================================== +How to follow a discussion thread and define what I want to hear about +====================================================================== -======== -Tracking -======== +How to follow a discussion thread +================================= +You can keep track of virtually any business object in Odoo +(an opportunity, a quotation, a task, etc.), by **following** it. -.. toctree:: - :titlesonly: +.. image:: media/discuss07.png + :align: center - tracking/tracking \ No newline at end of file +How to choose the events to follow +================================== +You can choose which types of events you want to be notified about. +The example below shows the options available when +following a **task** in the **Project** app. + +.. image:: media/discuss08.png + :align: center + +How to add other followers +========================== +You can invite other users and add channels as followers. Adding a +channel as a follower will send messages posted in the chatter to the +channel with a link back to the original document. + +.. image:: media/discuss09.png + :align: center +.. image:: media/discuss10.png + :align: center + +How to be a default follower +============================ +You are automatically set as a default follower of any item +you create. In some applications like CRM and Project, you can +be a default follower of any new record created to get notified +of specific events (e.g. a new task created, an opportunity won). + +To do so, start following the parent business object +(e.g. the sales channel in CRM, the project in Project). +Then, choose the events you want to hear about. + +.. image:: media/sales_channel_follow.png + :align: center \ No newline at end of file diff --git a/discuss/tracking/tracking.rst b/discuss/tracking/tracking.rst deleted file mode 100644 index 95c9c2202..000000000 --- a/discuss/tracking/tracking.rst +++ /dev/null @@ -1,26 +0,0 @@ -====================================================== -Tracking Important Topics, Projects, and Conversations -====================================================== - -You can keep track of virtually any object in Odoo, such as a Task or -Quotation, by **following** it. An item can be followed from the item -view, just above the chatter. - -.. image:: media/discuss07.png - :align: center - -You can choose which types of events to follow, with the depending on -the type of item. The example below shows the options available when -following a **task** in the **Projects** **Module**. - -.. image:: media/discuss08.png - :align: center - -You can invite other users and add channels as followers. Adding a -channel as a follower will send messages posted in the chatter to the -channel with a link back to the original document. - -.. image:: media/discuss09.png - :align: center -.. image:: media/discuss10.png - :align: center