Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions content/applications/general/users.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ User` or :guilabel:`Portal User`.
Odoo databases have three types of users: :guilabel:`Internal User`, :guilabel:`Portal`, and
:guilabel:`Public`. Users are considered *internal database* users. Portal users are *external
users*, who only have access to the database portal to view records. Public users are those visiting
websites, via the website's frontend. See the documentation on :doc:`users/portal`.
websites, via the website's frontend. See the documentation on :doc:`users/user_portals`.

The :guilabel:`Portal` user option does **not** allow the administrator to choose access rights.
These users have specific access rights pre-set (such as, record rules and restricted menus), and
Expand Down Expand Up @@ -278,7 +278,7 @@ company.
users/language
users/2fa
users/access_rights
users/portal
users/user_portals
users/facebook
users/google
users/azure
Expand Down
160 changes: 0 additions & 160 deletions content/applications/general/users/portal.rst

This file was deleted.

Binary file not shown.
Binary file not shown.
29 changes: 29 additions & 0 deletions content/applications/general/users/user_portals.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
:show-content:

============
User portals
============

.. _user_portals/main:

The user portal is a module available by default in Odoo. Users, both customers and vendors, can be
granted :doc:`access to the portal </applications/general/users/access_rights>` by businesses in
order to view certain documents or information within an Odoo database. For example, some common use
cases for providing portal access include allowing customers and vendors to:

- Follow, view, and pay orders
- Follow, download, or pay invoices, including partial payments and down payments
- Manage payment methods
- Manage subscriptions
- Add, remove, or modify their addresses
- Configure connection parameters between Odoo and 3rd-party services

.. note::
Portal users only have read/view access, and will **not** be able to edit any documents in the
database.

.. toctree::
:titlesonly:

user_portals/portal_access
user_portals/updating_portal_info
52 changes: 52 additions & 0 deletions content/applications/general/users/user_portals/portal_access.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
======================
Granting portal access
======================

In order for the customers and vendors of a business to begin using the user portal, they must first
be granted access by the business. The process to do this begins in the **Contacts** application.

Adding portal access to a contact
=================================

From the main Odoo dashboard, open the :guilabel:`Contacts` application. If the contact to be
granted access is not yet in the database, create an entry for them by clicking on the
:guilabel:`Create` button and entering their details. Otherwise, choose an existing contact, then
click on the :icon:`fa-gear` :guilabel:`(Actions)` drop-down menu located at the top-center of the
interface, and select :guilabel:`Grant portal access`.

.. image:: portal_access/grant-portal-access.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

VERY minor and not necessary, but you can chop/crop the tabs beneath the drop-down sinc ewe don't need to see that for this step.

:alt: Use the Contacts application to give portal access to users.

This brings up the :guilabel:`Portal Access Management` window, which has three fields:

- :guilabel:`Contact`: the recorded name of the contact in the Odoo database
- :guilabel:`Email`: the contact's email address used to log into the portal
- :guilabel:`Latest Authentication`: the last time the user accessed the portal
Comment on lines +22 to +24
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- :guilabel:`Contact`: the recorded name of the contact in the Odoo database
- :guilabel:`Email`: the contact's email address used to log into the portal
- :guilabel:`Latest Authentication`: the last time the user accessed the portal
- :guilabel:`Contact`: This field is automatically populated with the name on the contact form.
- :guilabel:`Email`: If the contact has an email address on the form, it is automatically populated in this field.
- :guilabel:`Latest Authentication`: The last time the user accessed the portal appears on this line. If the user has never logged into the portal, this field remeans blank.

Just for context 0- since I noticed that the email either appears or not (it's because if it's on the form it's there, if it isn't, it's not.). Juts to give more of an explanation of where it comes form if anything appears. You can even add in a note admonsition that the last column wil always be blank since the user hasn't been given access, and this doc is to explain how to do that)


.. image:: portal_access/portal-access-management.png
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I recommend putting this beneath the next sentence - I like ot put images at the end of a block of text, epsecially if all the steps in the explanation is visible in the image. I only space out image sif they change, or if differen tiages are needed to show the flow.

:alt: Grant access in the Portal Access Management window.

To grant portal access, first enter the email address the contact will use to log into the portal.
This may have been automatically entered by the system if an existing contact is being granted
access. Then click the :guilabel:`Grant Access` button to finish.

Granting accesss to multiple users at once
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

THIS SI WHAT I GET FOR NOT READING A WHOLE DOC =D =D =D

Suggested change
Granting accesss to multiple users at once
Granting accesss to multiple users at once
Suggested change
Granting accesss to multiple users at once
Granting accesss to a company

OK, so you already had this in here! I still recommend perhaps framing this as adding a "Perosn" or a "Company" since I Feel like th emost likely scenario is a Perosn will ususally be a single ocntact/one email address, and a cpompany will have multiple ocntacts/people. So just a title change for these sections I think may help.

------------------------------------------

To grant portal access to multiple users from a single company at once, navigate to the contact
listing for that company, then click :menuselection:`Action --> Grant portal access` to view a list
of the company's related contacts. Click :guilabel:`Grant Access` for each contact that needs portal
access. An email is sent to the specified email address, indicating that the contact is now a portal
user for that Odoo database.

.. image:: portal_access/multiple-user-access.png
:alt: Grant access to multiple users at once.

Revoking portal access
----------------------

Portal access can be revoked from a contact at any time by navigating to a contact, clicking
:menuselection:`Action --> Grant portal access`, and then clicking :guilabel:`Revoke Access`.
Comment on lines +48 to +49
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Portal access can be revoked from a contact at any time by navigating to a contact, clicking
:menuselection:`Action --> Grant portal access`, and then clicking :guilabel:`Revoke Access`.
Some situations may require revoking portal access for an individual, such as when an individual retires or leaves a company. Portal access can be revoked from a contact at any time by navigating to a contact, clicking
:menuselection:`Action --> Grant portal access`, and then clicking :guilabel:`Revoke Access`.

Just to provide ocntext as to why you would do this.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also, does the user get an email,or they just won't be able to log-in?


.. image:: portal_access/revoke-user-access.png
:alt: Revoke access from a user.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
@@ -0,0 +1,131 @@
====================
Updating portal info
====================

There may be times when a user would like to make changes to their contact, security, or payment
information connected to their portal account. Portal users can update most information by logging
into their account and making the changes themselves, but some updates may require a database user
with administrator access rights.

Updating user information begins with logging into the user portal. Once a user has logged in and is
on the portal dashboard, they can begin making changes to their information.

User-driven updates
===================

.. _user_portal_user_info:

.. note::
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personal preference- I don't like to start sections with an admonition block. Also, this seems important, not just a note- somoene may try to log into a portal with their database passwrod and not know why it's happening. I recommend this is moved right above the "User-driven updates" line, and end the begining with this- since you mention loggin into the potal right above (so ti seems like it fits)

Passwords for portal users and Odoo.com users remain separate, even if the same email address is
used.

Changing contact info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't log into the portal - I tried to invite myself with my tutorial demo email, but I never got the email, so i cannot ocnfirm these steps, FYI. I assume you did though!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Changing contact info
Update contact info

Since the doc is called "Updating info" I fel tht these sections would be more "matchy matchy" if you used the same verbiage =)

---------------------

From the portal dashboard, click the :guilabel:`Edit information` button under the user contact
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add the pencil icon that appears before the text

information. This brings up a new page where contact information can be updated.

On this screen, users can update their:

- Contact name
- Email address and phone number
- Company name and VAT (if applicable)
- Mailing address
- Invoice delivery preference
- Electronic format for documents (This is generally only relevant for portal users in the European
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would chek this against a blank test database for 19.0 - NOT located in the EU. Then I would remove anything that is country-specific. I wouldn't mention this field if it is only visible in the EU. IInstead, I would add a note or general statement of "additional feld may appear depending on the locaiton of the database. - then peopl ewill jnow that some things may or may not appear.

Union.)
Comment on lines +28 to +36
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On this screen, users can update their:
- Contact name
- Email address and phone number
- Company name and VAT (if applicable)
- Mailing address
- Invoice delivery preference
- Electronic format for documents (This is generally only relevant for portal users in the European
Union.)
On this screen, users can update the following fields:
- :guilabel:`Your name'
- :guilabel:`Email`
- :guilabel:`Phone`
- Company name and VAT (if applicable)
- Mailing address
- Invoice delivery preference
- Electronic format for documents (This is generally only relevant for portal users in the European
Union.)

I didn't mark up all of them, but I would GUI them with what exactly appears on the form itself. You can add extra info if needed, like:

'guilabel'Phone number


Once users have updated their information, they can click :guilabel:`Save Address` to save any
changes they've made or :guilabel:`Discard` to return to the portal dashboard. By default, the only
fields that need to be filled out to save users' information are their names, emails, phone numbers,
and addresses.
Comment on lines +38 to +41
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Once users have updated their information, they can click :guilabel:`Save Address` to save any
changes they've made or :guilabel:`Discard` to return to the portal dashboard. By default, the only
fields that need to be filled out to save users' information are their names, emails, phone numbers,
and addresses.
Once thr information is updated, click :guilabel:`Save Address` to save any
changes, or :guilabel:`Discard` to return to the portal dashboard. By default, the names, emails, phone numbers, and addresses fields **must** be filed out to save any changes.

In the firts sentence, yu use the "click this' as opposed to "they can click". I generall avoid "can" and make the steps "mandatory"sunding - do this, then this, then do this. So since the opening is writren like that, I made these changes.

Also, I think the last edit is what you meant - but if I am mistaken, please change or modify!


.. important::
Once the system has generated any documents for a user's account, their country **cannot** be
updated. If users need to update their country at that point, they must reach out to a database
user with administrator access rights.

.. _users-portal-payment-methods:

Change payment info
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Change payment info
Update payment info

same lgoic as the other one

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also noticed the titles use "ing" or not, so some are 'Change' and some are 'Changing". If yu tae ym suggesiton for "Update" just be consistent thorughout the doc with the heaidngs

-------------------

From the portal dashboard, click the :guilabel:`Payment methods` button. This brings up a new page
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
From the portal dashboard, click the :guilabel:`Payment methods` button. This brings up a new page
From the portal dashboard, click :guilabel:`Payment methods`. This brings up a new page

I am torn- it doen'st seem like a "button" mor elike a Kanban card. Not sure the proper nomenclature for this, but I woudl check to see what this actually is -becaus eI don't htink it's a "button" per se.

that shows any saved payment methods.

* To add a new payment option, choose from the available payment methods, enter the new payment
information, and click :guilabel:`Save` to save the details.
* To erase a payment option, click the :icon:`fa-trash` :guilabel:`(Trash)` icon, then click the
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* To erase a payment option, click the :icon:`fa-trash` :guilabel:`(Trash)` icon, then click the
* To remove a payment option, click the :icon:`fa-trash` :guilabel:`(Trash)` icon, then click the

Just sounds more correct since we are deleting/removing, not "erasing" in a literal sense.

Comment on lines +56 to +58
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* To add a new payment option, choose from the available payment methods, enter the new payment
information, and click :guilabel:`Save` to save the details.
* To erase a payment option, click the :icon:`fa-trash` :guilabel:`(Trash)` icon, then click the
To add a new payment option, choose from the available payment methods, enter the new payment
information, and click :guilabel:`Save` to save the details. To erase a payment option, click the :icon:`fa-trash` :guilabel:`(Delete payment method)` icon, then click the

I odn't htink these need to be bulleted- they are just 2 sentencnes, and can just be explained in a sentnece or two.

lso, I don't see a 'select payment mehtos- it's just a place for a number and the status?
image

Also, the icon hover name is not Trash, so we want ot use what the user sees on the UI

:guilabel:`Confirm Deletion` button.

.. important::
Users that need to update payment information must delete any existing information and enter
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Users that need to update payment information must delete any existing information and enter
Users that need to update payment information **must** delete any existing information and enter

Just seems like an important word to empahsize

their new or updated info. Payment information **cannot** be edited and must be re-entered.


Changing passwords and managing security
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this portion nested beneath the 'payment info' changes section? It seems like it soudl have the same level as the other 2 secitons above- UNLESS it can only be accessed thorugh the payment changes. I can't see this in the portal, so I cannot confirm.

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

From the portal dashboard, click the :guilabel:`Connection & Security` button. This brings up a new
page with five sections:
Comment on lines +69 to +70
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there are a lot of stpes for each one (not for all of them, but PPasskeys has a lot for example) you can say:

The following sections can be edited and updated, if desired.

Then you can have each section a sub-section:

Two-Factor Authentication



etc, etc, etc. 


- Change Password. Here the user can enter their current password and a new password they wish to
change to. The new password can be saved by clicking :guilabel:`Change Password`.
- Two-factor authentication. An :icon:`fa-info-circle` :guilabel:`info tooltip` explains how
Comment on lines +72 to +74
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Change Password. Here the user can enter their current password and a new password they wish to
change to. The new password can be saved by clicking :guilabel:`Change Password`.
- Two-factor authentication. An :icon:`fa-info-circle` :guilabel:`info tooltip` explains how
- :guilabel:`Change Password`: To change the password, enter the current pasword in the :guilabel:`Password` field, then enter the new password in both the :guilabel:`New Password` and :guilabel:` Verify New Password` fields. Click:guilabel:`Change Password` so save the new password.
- :guilabel:`Two-factor authentication`. A :icon:`fa-info-circle` :guilabel:`Documentation` link open the corresponding documentation, which explains how

These sections are all ON the UI, so I woudl use a GUI for these, since htey are 'section' titles.

two-factor authentication (2FA) works and the user's currrent 2FA status is shown. If 2FA is not
enabled, an :guilabel:`Enable two-factor authentication` appears. If it is enabled, a link reading
:guilabel:`Disable two-factor authentication` appears instead.
- Passkeys. Click :guilabel:`Add Passkey` to create a passkey that simplifies the login process. Any
previously created passkeys are shown here, alongside information on when they were created and
when they were last used. They can be renamed by clicking their :icon:`fa-pencil` :guilabel:`edit`
button or deleted by clicking their :icon:`fa-trash` :guilabel:`Delete` button.
- Revoke All Sessions. Clicking the :guilabel:`Log out from all devices` button brings up a pop-up
Comment on lines +78 to +82
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Passkeys. Click :guilabel:`Add Passkey` to create a passkey that simplifies the login process. Any
previously created passkeys are shown here, alongside information on when they were created and
when they were last used. They can be renamed by clicking their :icon:`fa-pencil` :guilabel:`edit`
button or deleted by clicking their :icon:`fa-trash` :guilabel:`Delete` button.
- Revoke All Sessions. Clicking the :guilabel:`Log out from all devices` button brings up a pop-up
- Passkeys. A passkey is a shortcut to loginto the databse, without having to type in the full password. To add a passkey, click the :guilabel:`Add Passkey` button, and a :guilabel:`Security Control` poip-up window loads, requesting to enter the current password for security purposes. Once entered, click :guilabel:`Confirm Password`, and a :guilabel:`Create Passkey` pop-up window loads. Enter the passkey into the field, and click guilabel:`Create` to add the passkey. to create a passkey that simplifies the login process.
Any
previously created passkeys are shown here, alongside information on when they were created and
when they were last used. They can be renamed by clicking their :icon:`fa-pencil` :guilabel:`edit`
button or deleted by clicking their :icon:`fa-trash` :guilabel:`Delete` button.
- Revoke All Sessions. Clicking the :guilabel:`Log out from all devices` button brings up a pop-up

There are a lot more steps ot creating the passkey, so I recommend to always put in al lth esteps, so people can follow along, with nothing different from the directions and their experience.

prompting the user to enter their password. Once they do so and click
:guilabel:`Confirm Password`, the system logs them out of all sessions except for the current one.
- Delete Account. Clicking the :guilabel:`Delete Account` button brings up a pop-up to completely
and irrevocably delete the user's account. Users must enter their password and their login name to
complete the process. They can also choose to have their email address and phone number added to
an internal block list to prevent any future communication.

Database administrator-driven updates
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Database administrator-driven updates
Administrator-driven updates
``
I feel like this implies the same thing? Just to shorten the title a bit`

=====================================

Accessing users' information as an administrator
------------------------------------------------

First, navigate to :menuselection:`Settings app --> Users` and click :icon:`oi-arrow-right`
:guilabel:`Manage Users` Then, click the drop-down arrow in the search bar and add :guilabel:`Portal
Users` as a filter. After making this selection, search for and open the portal user that needs to
be edited.
Comment on lines +96 to +99
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
First, navigate to :menuselection:`Settings app --> Users` and click :icon:`oi-arrow-right`
:guilabel:`Manage Users` Then, click the drop-down arrow in the search bar and add :guilabel:`Portal
Users` as a filter. After making this selection, search for and open the portal user that needs to
be edited.
First, navigate to the :menuselection:`Settings app` and inthe :guilabel:`Users` section, click :icon:`oi-arrow-right`
:guilabel:`Manage Users` In the search bar, remove the default (filter icon) 'Internal Users' filter. Next, click into the drop-down menu in the search bar, and select :guilabel:`Portal
Users` in the (filter icon) 'Filters' column. After making this selection, search for and open the portal user to be edited.

Just becaise you aren't clicking "users".

The other thing is you should clear out the other filter so thye are not comingled.

I got tired of typing out all the 'guis' so I just put ' and said 'icon' =D


Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You cna add a note to explain that any PORTAL only user will have a (key icon)'Portal' appear beneath their name, and a n 'External User' banne ron the irght- and you cna have an image of it. If somoene does NOT see that, it means they are a USER of the databs,e(And could also be a portal user?) .
image

Update email address
~~~~~~~~~~~~~~~~~~~~

The :icon:`fa-envelope` :guilabel:`Email Address` field shows the email address the user uses to log
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
The :icon:`fa-envelope` :guilabel:`Email Address` field shows the email address the user uses to log
The :icon:`fa-envelope` :guilabel:`(Email Address)` field shows the email address the user uses to log

Becsuse it's just the icon that appears

into the Odoo database. A database user with administrator access rights can make any necessary
changes by clicking into the field, updating the user's email address, and clicking the
:icon:`fa-cloud-upload` :guilabel:`Save` button.
Comment on lines +106 to +107
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
changes by clicking into the field, updating the user's email address, and clicking the
:icon:`fa-cloud-upload` :guilabel:`Save` button.
changes by clicking into the field, and updating the user's email address.

It saves automatically, so we usually don't add this info, since it's kind of unnecessary.


.. note::
Users **cannot** change their own login usernames. Changing the :icon:`fa-key`
:guilabel:`(Login)` only changes the *username* on the user's portal login. Users' email
addresses can be changed in the :guilabel:`Manage Users` module, the **Contacts** app, or by
the users themselves in the portal.

Update passwords
~~~~~~~~~~~~~~~~

Users' security settings can be adjusted under the :guilabel:`Security` tab on their Contact form.
Under the :guilabel:`Security` tab, there are options to:

- :guilabel:`Change password` Click the :guilabel:`Change password` button to bring up a form that
shows what logins the user has access to and enter a new password. Click :guilabel:`Change
Password` to save the password or click :guilabel:`Cancel` to return to the previous screen.
- :guilabel:`Send Password Reset`. Click the :guilabel:`Send Password Reset` button to bring up a
pop-up notification that a password reset link has been sent by email.
- :guilabel:`Invite to use 2FA`. Click the :guilabel:`Invite to use 2FA` button to bring up a pop-up
notification that an invitation to use two-factor authentication was sent.

.. seealso::
- :doc:`Access rights </applications/general/users/access_rights>`
- :doc:`Portal access documentation <portal_access>`
Loading