[MOV] documentation structure reorganization
This commit aims to improve the documentation's navigability by redefining some categories' purposes and titles. There is a redirection rule for each documentation page moved. This ensures that users won't have a 404 error message. task-3217827 closes odoo/documentation#8064 Signed-off-by: Jonathan Castillo (jcs) <jcs@odoo.com>
@@ -1,10 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
========
|
||||
Advanced
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
advanced/ice_servers
|
||||
|
Before Width: | Height: | Size: 22 KiB After Width: | Height: | Size: 22 KiB |
|
Before Width: | Height: | Size: 13 KiB After Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 3.7 KiB After Width: | Height: | Size: 3.7 KiB |
|
Before Width: | Height: | Size: 8.5 KiB After Width: | Height: | Size: 8.5 KiB |
|
Before Width: | Height: | Size: 29 KiB After Width: | Height: | Size: 29 KiB |
|
Before Width: | Height: | Size: 21 KiB After Width: | Height: | Size: 21 KiB |
|
Before Width: | Height: | Size: 24 KiB After Width: | Height: | Size: 24 KiB |
@@ -1,12 +0,0 @@
|
||||
:nosearch:
|
||||
|
||||
========
|
||||
Overview
|
||||
========
|
||||
|
||||
.. toctree::
|
||||
:titlesonly:
|
||||
|
||||
overview/get_started
|
||||
overview/team_communication
|
||||
overview/plan_activities
|
||||
@@ -1,107 +0,0 @@
|
||||
========================
|
||||
Get started with Discuss
|
||||
========================
|
||||
|
||||
Odoo *Discuss* is an internal communication app that allows users to connect through messages,
|
||||
notes, and file sharing, either through a persistent chat window that works across applications, or
|
||||
through the dedicated *Discuss* dashboard.
|
||||
|
||||
.. _discuss_app/notification_preferences:
|
||||
|
||||
Choose notifications preference
|
||||
===============================
|
||||
|
||||
Access user-specific preferences for the *Discuss* app by navigating to :menuselection:`Settings app
|
||||
--> Users --> User --> Preferences tab`.
|
||||
|
||||
.. image:: get_started/preferences-user.png
|
||||
:align: center
|
||||
:alt: View of the Preferences tab for Odoo Discuss.
|
||||
|
||||
By default, the :guilabel:`Notification` field is set as :guilabel:`Handle by Emails`. With this
|
||||
setting enabled, a notification email will be sent by Odoo every time a message is sent from the
|
||||
chatter, a note is sent with an `@` mention (from chatter), or a notification is sent for a record
|
||||
that the user follows. Something that triggers a notification is changing of the stage (if an email\
|
||||
is configured to be sent, for example if the task is set to :guilabel:`Done`).
|
||||
|
||||
By choosing :guilabel:`Handle in Odoo`, the above notifications are shown in the *Discuss* app's
|
||||
*inbox*. Messages can have the following actions taken on them: respond with an emoji by clicking
|
||||
:guilabel:`Add a Reaction`, or reply to the message by clicking on :guilabel:`Reply`. Additional
|
||||
actions may include starring the message by clicking :guilabel:`Marked as Todo`, or pinning the
|
||||
message by selecting :guilabel:`Pin` or even mark the message as unread by selecting
|
||||
:guilabel:`Marked as unread`.
|
||||
|
||||
.. image:: get_started/reactions-discuss.png
|
||||
:align: center
|
||||
:alt: View of an inbox message and its action options in Odoo Discuss.
|
||||
|
||||
Clicking :guilabel:`Mark as Todo` on a message causes it to appear on the :guilabel:`Starred` page,
|
||||
while clicking :guilabel:`Mark as Read` moves the message to :guilabel:`History`.
|
||||
|
||||
.. image:: get_started/starred-messages.png
|
||||
:align: center
|
||||
:alt: View of messages marked as todo in Odoo Discuss.
|
||||
|
||||
Start chatting
|
||||
==============
|
||||
|
||||
The first time a user logs in to their account, OdooBot sends a message asking for permission to
|
||||
send desktop notifications for chats. If accepted, the user will receive push notifications on their
|
||||
desktop for the messages they receive, regardless of where the user is in Odoo.
|
||||
|
||||
.. image:: get_started/odoobot-push.png
|
||||
:align: center
|
||||
:alt: View of the messages under the messaging menu emphasizing the request for push
|
||||
notifications for Odoo Discuss.
|
||||
|
||||
.. tip::
|
||||
To stop receiving desktop notifications, reset the notifications settings of the browser.
|
||||
|
||||
To start a chat, go to the :menuselection:`Discuss` app and click on the :guilabel:`+ (plus)` icon
|
||||
next to :guilabel:`Direct Messages` or :guilabel:`Channels` in the left menu of the dashboard.
|
||||
|
||||
.. image:: get_started/channels-direct-messages.png
|
||||
:align: center
|
||||
:height: 400
|
||||
:alt: View of Discuss's panel emphasizing the titles channels and direct messages in Odoo
|
||||
Discuss.
|
||||
|
||||
A company can also easily create :doc:`public and private channels
|
||||
</applications/productivity/discuss/overview/team_communication>`.
|
||||
|
||||
Mentions in the chat and on the chatter
|
||||
---------------------------------------
|
||||
|
||||
To mention a user within a chat or the chatter, type `@user-name`; to refer to a channel, type
|
||||
`#channel-name`. The user mentioned will be notified in their *inbox* or through an email, depending
|
||||
on their communication settings.
|
||||
|
||||
.. image:: get_started/chat-windows.png
|
||||
:align: center
|
||||
:alt: View of a couple of chat window messages for Odoo Discuss.
|
||||
|
||||
.. tip::
|
||||
When a user is mentioned, the search list (list of names) suggests values first based on the
|
||||
task's followers, and secondly on employees. If the record being searched does not match with
|
||||
either a follower or employee, the scope of the search becomes all partners.
|
||||
|
||||
User status
|
||||
-----------
|
||||
|
||||
It is helpful to see what colleagues are up to and how quickly they can respond to messages by
|
||||
checking their *status*. The status is shown on the left side of a contact's name on the
|
||||
:guilabel:`Discuss` sidebar, on the *messaging menu* and when listed in the *chatter*.
|
||||
|
||||
- Green = online
|
||||
- Orange = away
|
||||
- White = offline
|
||||
- Airplane = out of the office
|
||||
|
||||
.. image:: get_started/status.png
|
||||
:align: center
|
||||
:height: 300
|
||||
:alt: View of the contacts' status for Odoo Discuss.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`/applications/productivity/discuss/overview/team_communication`
|
||||
- :doc:`/applications/productivity/discuss/overview/plan_activities`
|
||||
@@ -1,250 +0,0 @@
|
||||
==========
|
||||
Activities
|
||||
==========
|
||||
|
||||
*Activities* are follow-up tasks tied to a record in an Odoo database. Activities can be scheduled
|
||||
on any page of the database that contains a chatter thread, kanban view, list view, or activities
|
||||
view of an application.
|
||||
|
||||
Schedule activities
|
||||
===================
|
||||
|
||||
One way that activities are created is by clicking the :guilabel:`Schedule Activity` button, located
|
||||
at the top of the *chatter* on any record. On the pop-up window that appears, select an
|
||||
:guilabel:`Activity Type` from the drop-down menu.
|
||||
|
||||
.. tip::
|
||||
Individual applications have a list of *Activity Types* dedicated to that application. For
|
||||
example, to view and edit the activities available for the *CRM* application, go to
|
||||
:menuselection:`CRM app --> Configuration --> Activity Types`.
|
||||
|
||||
Enter a title for the activity in the :guilabel:`Summary` field, located in the :guilabel:`Schedule
|
||||
Activity` pop-up window.
|
||||
|
||||
To assign the activity to a different user, select a name from the :guilabel:`Assigned to` drop-down
|
||||
menu. Otherwise, the user creating the activity is automatically assigned.
|
||||
|
||||
Lastly, feel free to add any additional information in the optional :guilabel:`Log a note...` field.
|
||||
|
||||
.. note::
|
||||
The :guilabel:`Due Date` field on the :guilabel:`Schedule Activity` pop-up window auto-populates
|
||||
based on the configuration settings for the selected :guilabel:`Activity Type`. However, this
|
||||
date can be changed by selecting a day on the calendar in the :guilabel:`Due Date` field.
|
||||
|
||||
Lastly, click one of the following buttons:
|
||||
|
||||
- :guilabel:`Schedule`: adds the activity to the chatter under :guilabel:`Planned activities`.
|
||||
- :guilabel:`Mark as Done`: adds the details of the activity to the chatter under :guilabel:`Today`.
|
||||
The activity is not scheduled, it is automatically marked as completed.
|
||||
- :guilabel:`Done \& Schedule Next`: adds the task under :guilabel:`Today` marked as done, and
|
||||
opens a new activity window.
|
||||
- :guilabel:`Discard`: discards any changes made on the pop-up window.
|
||||
|
||||
.. image:: plan_activities/schedule-pop-up.png
|
||||
:align: center
|
||||
:alt: View of CRM leads and the option to schedule an activity.
|
||||
|
||||
.. note::
|
||||
Depending on the activity type, the :guilabel:`Schedule` button may be replaced by a
|
||||
:guilabel:`Save` button, or an :guilabel:`Open Calendar` button.
|
||||
|
||||
Scheduled activities are added to the chatter for the record under :guilabel:`Planned activities`.
|
||||
|
||||
.. image:: plan_activities/chatter-activities.png
|
||||
:align: center
|
||||
:alt: View of CRM leads and the option to schedule an activity.
|
||||
|
||||
Activities can also be scheduled from the kanban, list, or activities view of an application.
|
||||
|
||||
.. tabs::
|
||||
|
||||
.. tab:: Kanban view
|
||||
|
||||
Select a record on which to schedule an activity. Click on the :guilabel:`🕘 (clock)` icon,
|
||||
then :guilabel:`Schedule An Activity`, and proceed to fill out the pop-up form.
|
||||
|
||||
.. image:: plan_activities/schedule-kanban-activity.png
|
||||
:align: center
|
||||
:alt: Kanban view of the CRM pipeline and the option to schedule an activity.
|
||||
|
||||
.. tab:: List view
|
||||
|
||||
Select a record on which to schedule an activity. Click on the :guilabel:`🕘 (clock)` icon,
|
||||
then :guilabel:`Schedule An Activity`. If the record already has an activity scheduled, the
|
||||
clock icon may be replaced by a :guilabel:`📞 (phone)` or an :guilabel:`✉️ (envelope)` icon.
|
||||
|
||||
.. image:: plan_activities/schedule-list-activity.png
|
||||
:align: center
|
||||
:alt: List view of the CRM pipeline and the option to schedule an activity.
|
||||
|
||||
.. tab:: Activity view
|
||||
|
||||
To open the activity view for an application, select the :guilabel:`🕘 (clock)` icon from the
|
||||
menu bar anywhere in the database. Select any application from the drop-down menu, and click
|
||||
the :guilabel:`🕘 (clock)` icon for the desired app.
|
||||
|
||||
.. image:: plan_activities/schedule-activity-view-menu.png
|
||||
:align: center
|
||||
:alt: Activity menu drop down with focus on where to open activity view for CRM.
|
||||
|
||||
Select a record on which to schedule an activity. Move across the row to find the desired
|
||||
activity type, then click the :guilabel:`+ (plus sign)`.
|
||||
|
||||
.. image:: plan_activities/schedule-activity-view.png
|
||||
:align: center
|
||||
:alt: Activity view of the CRM pipeline and the option to schedule an activity.
|
||||
|
||||
.. note::
|
||||
Activity colors, and their relation to an activity's due date, is consistent throughout Odoo,
|
||||
regardless of the activity type, or the view.
|
||||
|
||||
- Activities that appear in **green** indicate a due date sometime in the future.
|
||||
- **Yellow** indicates that the activity's due date is today.
|
||||
- **Red** indicates that the activity is overdue and the due date has passed.
|
||||
|
||||
For example, if an activity is created for a phone call, and the due date passes, the activity
|
||||
appears with a red phone in list view, and a red clock on the kanban view.
|
||||
|
||||
View scheduled activities
|
||||
=========================
|
||||
|
||||
To view scheduled activities, open either the :menuselection:`Sales app` or :menuselection:`CRM app`
|
||||
and click the :guilabel:`🕘 (clock)` icon, located to the far-right side of the other view options.
|
||||
|
||||
Doing so opens the activities menu, showcasing all the scheduled activities for the user, by
|
||||
default. To show all activities for every user, remove the :guilabel:`My Pipeline` filter from the
|
||||
:guilabel:`Search...` bar.
|
||||
|
||||
To view a consolidated list of activities separated by the application where they were created, and
|
||||
by deadline, click the :guilabel:`🕘 (clock)` icon on the header menu to see the activities for that
|
||||
specific application in a drop-down menu.
|
||||
|
||||
The possibility to :guilabel:`Add new note` and :guilabel:`Request a Document` appear at the bottom
|
||||
of this drop-down menu, when the :guilabel:`🕘 (clock)` icon on the header menu is clicked.
|
||||
|
||||
.. image:: plan_activities/activities-menu.png
|
||||
:align: center
|
||||
:alt: View of CRM leads page emphasizing the activities menu.
|
||||
|
||||
Configure activity types
|
||||
========================
|
||||
|
||||
To configure the types of activities in the database, go to :menuselection:`Settings app --> Discuss
|
||||
--> Activities --> Activity Types`.
|
||||
|
||||
.. image:: plan_activities/settings-activities-types.png
|
||||
:align: center
|
||||
:alt: View of the settings page emphasizing the menu activity types.
|
||||
|
||||
Doing so reveals the :guilabel:`Activity Types` page, where the existing activity types are found.
|
||||
|
||||
To edit an existing activity type, select it from the list, then click :guilabel:`Edit`. To create a
|
||||
new activity type, click :guilabel:`Create`.
|
||||
|
||||
At the top of a blank activity type form, start by choosing a :guilabel:`Name` for the new activity
|
||||
type.
|
||||
|
||||
.. image:: plan_activities/new-activity-type.png
|
||||
:align: center
|
||||
:alt: New activity type form.
|
||||
|
||||
Activity settings
|
||||
-----------------
|
||||
|
||||
Action
|
||||
~~~~~~
|
||||
|
||||
The *Action* field specifies the intent of the activity. Some actions trigger specific behaviors
|
||||
after an activity is scheduled.
|
||||
|
||||
- If :guilabel:`Upload Document` is selected, a link to upload a document is added directly to the
|
||||
planned activity in the chatter.
|
||||
- If either :guilabel:`Phonecall` or :guilabel:`Meeting` are selected, users have the option to open
|
||||
their calendar to schedule a time for this activity.
|
||||
- If :guilabel:`Request Signature` is selected, a link is added to the planned activity in the
|
||||
chatter that opens a signature request pop-up window.
|
||||
|
||||
.. note::
|
||||
The actions available to select on an activity type vary, depending on the applications currently
|
||||
installed in the database.
|
||||
|
||||
Default user
|
||||
~~~~~~~~~~~~
|
||||
|
||||
To automatically assign this activity to a specific user when this activity type is scheduled,
|
||||
choose a name from the :guilabel:`Default User` drop-down menu. If this field is left blank, the
|
||||
activity is assigned to the user who creates the activity.
|
||||
|
||||
Default summary
|
||||
~~~~~~~~~~~~~~~
|
||||
|
||||
To include notes whenever this activity type is created, enter them into the :guilabel:`Default
|
||||
Summary` field.
|
||||
|
||||
.. note::
|
||||
The information in the :guilabel:`Default User` and :guilabel:`Default Summary` fields are
|
||||
included when an activity is created. However, they can be altered before the activity is
|
||||
scheduled or saved.
|
||||
|
||||
Next activity
|
||||
-------------
|
||||
|
||||
To automatically suggest, or trigger, a new activity after an activity has been marked complete, the
|
||||
:guilabel:`Chaining Type` must be set.
|
||||
|
||||
Suggest next activity
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
In the :guilabel:`Chaining Type` field, select :guilabel:`Suggest Next Activity`. Upon doing so, the
|
||||
field underneath changes to: :guilabel:`Suggest`. Click the :guilabel:`Suggest` field drop-down menu
|
||||
to select any activities to recommend as follow-up tasks to this activity type.
|
||||
|
||||
In the :guilabel:`Schedule` field, choose a default deadline for these activities. To do so,
|
||||
configure a desired number of :guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`. Then,
|
||||
decide if it should occur :guilabel:`after completion date` or :guilabel:`after previous activity
|
||||
deadline`.
|
||||
|
||||
This :guilabel:`Schedule` field information can be altered before the activity is scheduled.
|
||||
|
||||
When all configurations are complete, click :guilabel:`Save`.
|
||||
|
||||
.. image:: plan_activities/schedule-recommended-activity.png
|
||||
:align: center
|
||||
:alt: Schedule activity popup with emphasis on recommended activities.
|
||||
|
||||
.. note::
|
||||
If an activity has the :guilabel:`Chaining Type` set to :guilabel:`Suggest Next Activity`, and
|
||||
has activities listed in the :guilabel:`Suggest` field, users are presented with recommendations
|
||||
for activities as next steps.
|
||||
|
||||
Trigger next activity
|
||||
~~~~~~~~~~~~~~~~~~~~~
|
||||
|
||||
Setting the :guilabel:`Chaining Type` to :guilabel:`Trigger Next Activity` immediately launches the
|
||||
next activity once the previous one is completed.
|
||||
|
||||
If :guilabel:`Trigger Next Activity` is selected in the :guilabel:`Chaining Type` field, the field
|
||||
beneath changes to: :guilabel:`Trigger`. From the :guilabel:`Trigger` field drop-down menu, select
|
||||
the activity that should be launched once this activity is completed.
|
||||
|
||||
In the :guilabel:`Schedule` field, choose a default deadline for these activities. To do so,
|
||||
configure a desired number of :guilabel:`Days`, :guilabel:`Weeks`, or :guilabel:`Months`. Then,
|
||||
decide if it should occur :guilabel:`after completion date` or :guilabel:`after previous activity
|
||||
deadline`.
|
||||
|
||||
This :guilabel:`Schedule` field information can be altered before the activity is scheduled.
|
||||
|
||||
When all configurations are complete, click :guilabel:`Save`.
|
||||
|
||||
.. image:: plan_activities/triggered-activities.png
|
||||
:align: center
|
||||
:alt: Schedule new activity popup with emphasis on Done and launch next button.
|
||||
|
||||
.. note::
|
||||
When an activity has the :guilabel:`Chaining Type` set to :guilabel:`Trigger Next Activity`,
|
||||
marking the activity as `Done` immediately launches the next activity listed in the
|
||||
:guilabel:`Trigger` field.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`get_started`
|
||||
- :doc:`team_communication`
|
||||
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 6.1 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 15 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 13 KiB |
|
Before Width: | Height: | Size: 11 KiB |
|
Before Width: | Height: | Size: 9.5 KiB |
|
Before Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 8.6 KiB After Width: | Height: | Size: 8.6 KiB |
|
Before Width: | Height: | Size: 5.3 KiB After Width: | Height: | Size: 5.3 KiB |
|
Before Width: | Height: | Size: 14 KiB After Width: | Height: | Size: 14 KiB |
|
Before Width: | Height: | Size: 37 KiB After Width: | Height: | Size: 37 KiB |
@@ -110,5 +110,5 @@ messages in window and pressing *enter*.
|
||||
:alt: Channel linked in chatter with the channel open on the lower right quadrant.
|
||||
|
||||
.. seealso::
|
||||
- :doc:`get_started`
|
||||
- :doc:`plan_activities`
|
||||
- :doc:`../discuss`
|
||||
- :doc:`/applications/essentials/activities`
|
||||
|
Before Width: | Height: | Size: 8.0 KiB After Width: | Height: | Size: 8.0 KiB |
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 26 KiB |
|
Before Width: | Height: | Size: 16 KiB After Width: | Height: | Size: 16 KiB |
|
Before Width: | Height: | Size: 12 KiB After Width: | Height: | Size: 12 KiB |
|
Before Width: | Height: | Size: 6.8 KiB After Width: | Height: | Size: 6.8 KiB |
|
Before Width: | Height: | Size: 10 KiB After Width: | Height: | Size: 10 KiB |