jfinn
/
edan_f0
Watch 1
Star 0
Fork 0
Code Issues 0 Pull Requests 0 Releases 0 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8957 Commits
1 Branch
Tree: c78c3f079e
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'c78c3f079e'
${ noResults }
edan_f0/docs/source/ref/apps/dashboard.rst

dashboard.rst 2.6KB
History Raw

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364 
  1. =========

  2. Dashboard

  3. =========

  4. 

  5. The dashboard is the backend interface for managing the store. That includes the

  6. product catalogue, orders and stock, offers etc. It is intended as a

  7. complete replacement of the Django admin interface.

  8. The app itself only contains a view that serves as a kind of homepage, and

  9. some logic for managing the navigation (in ``nav.py``). There's several sub-apps

  10. that are responsible for managing the different parts of the Oscar store.

  11. 

  12. Permission-based dashboard

  13. --------------------------

  14. Staff users (users with ``is_staff==True``) get access to all views in the

  15. dashboard. To better support Oscar's use for marketplace scenarios, the

  16. permission-based dashboard has been introduced. If a non-staff user has

  17. the ``partner.dashboard_access`` permission set, they are given access to a subset

  18. of views, and their access to products and orders is limited.

  19. 

  20. :class:`~oscar.apps.partner.abstract_models.AbstractPartner` instances

  21. have a :attr:`~oscar.apps.partner.abstract_models.AbstractPartner.users` field.

  22. Prior to Oscar 0.6, this field was not used. Since Oscar 0.6, it is used solely

  23. for modelling dashboard access.

  24. 

  25. If a non-staff user with the ``partner.dashboard_access`` permission is in

  26. :attr:`~oscar.apps.partner.abstract_models.AbstractPartner.users`, they can:

  27. 

  28. * Create products. It is enforced that at least one stock record's partner has

  29.   the current user in ``users``.

  30. * Update products. At least one stock record must have the user in the stock

  31.   record's partner's ``users``.

  32. * Delete and list products. Limited to products the user is allowed to update.

  33. * Managing orders. Similar to products, a user get access if one of an order's

  34.   lines is associated with a matching partner. By default, user will get

  35.   access to all lines of the order, even though supplies only one of them.

  36.   If you need user to see only own lines or apply additional filtering - you

  37.   can customise

  38.   :meth:`~oscar.apps.dashboard.order.views.OrderDetailView.get_order_lines`

  39.   method.

  40. 

  41. For many marketplace scenarios, it will make sense to ensure at checkout that

  42. a basket only contains lines from one partner.

  43. Please note that the dashboard currently ignores any other permissions,

  44. including `Django's default permissions`_.

  45. 

  46. .. note::

  47. 

  48.   The permission-based dashboard currently does not support parent or child

  49.   products. Supporting this requires a modelling change. If you require this,

  50.   please get in touch so we can first learn about your use case.

  51. 

  52. .. _Django's default permissions: https://docs.djangoproject.com/en/stable/topics/auth/default/#default-permissions

  53. 

  54. 

  55. Abstract models

  56. ---------------

  57. 

  58. None.

  59. 

  60. Views

  61. -----

  62. 

  63. .. automodule:: oscar.apps.dashboard.views

  64.     :members: