mirror of
https://github.com/inventree/InvenTree.git
synced 2026-09-04 03:48:54 +00:00
[docs] Docs updates (#10678)
* Display PendingShipments panel - Overview of all outstanding shipments * Update UI tests * add separate page for troubleshooting * Restructure menus a bit * Fix top-level page for mobile app * Add option to override default value in docs * Update global.md * Formatting updates * Update sales pages * Move order images to "purchasing" * Small tweaks * Make "Concepts" a top-level documentation item * Update image
This commit is contained in:
@@ -2,15 +2,31 @@
|
||||
title: InvenTree Admin Interfaces
|
||||
---
|
||||
|
||||
## InvenTree Admin Interfaces
|
||||
|
||||
There are multiple administration interfaces available in InvenTree, which provide different levels of access to the underlying resources and different operational safety.
|
||||
|
||||
- Admin Center - Main interface for managing InvenTree - Robust verification and safety checks
|
||||
- System Settings - Access to all settings - Robust verification, requires reading the documentation
|
||||
- Backend Admin Interface - Low level access to the database - Few verification or safety checks
|
||||
[**Admin Center**](#admin-center):
|
||||
|
||||
- Main interface for managing InvenTree
|
||||
- Robust verification and safety checks
|
||||
|
||||
[**System Settings**](#system-settings):
|
||||
|
||||
- Access to all settings
|
||||
- Robust verification, requires reading the documentation
|
||||
|
||||
[**Backend Admin Interface**](#backend-admin-interface):
|
||||
|
||||
- Low level access to the database
|
||||
- Few verification or safety checks
|
||||
- Requires knowledge of InvenTree internals
|
||||
- Recommended for advanced users only
|
||||
|
||||
### Admin Center
|
||||
|
||||
The Admin Center is the main interface for managing InvenTree. It provides a user-friendly interface for managing all aspects of the system, including:
|
||||
|
||||
- Users / Groups
|
||||
- Data import / export
|
||||
- Customisation (e.g. project codes, custom states, parameters and units)
|
||||
|
||||
@@ -4,8 +4,22 @@ title: Exporting Data
|
||||
|
||||
## Exporting Data
|
||||
|
||||
InvenTree provides data export functionality for a variety of data types. Most data tables provide an "Export Data" button, which allows the user to export the data in a variety of formats.
|
||||
InvenTree provides data export functionality for a variety of data types. Most data tables provide an "Download" button, which allows the user to export the data in a variety of formats.
|
||||
|
||||
In the top right corner of the table, click the "Export Data" button to export the data in the table.
|
||||
In the top right corner of the table, click the "Download" button to export the data in the table.
|
||||
|
||||
{{ image("admin/export.png", "Export data") }}
|
||||
{{ image("admin/export.png", "Download") }}
|
||||
|
||||
This will present a dialog box with the available export options:
|
||||
|
||||
{{ image("admin/export_options.png", "Export Dialog") }}
|
||||
|
||||
## Plugin Support
|
||||
|
||||
InvenTree plugins can also provide custom export functionality for specific data types. If a plugin provides export functionality, it will be listed in the export options.
|
||||
|
||||
Refer to the [export plugin mixin documentation](../plugins/mixins/export.md) for more information on how to create export plugins.
|
||||
|
||||
## API Export
|
||||
|
||||
Data can also be exported via the InvenTree REST API, by appending the appropriate format suffix (and other export options) to the API endpoint URL.
|
||||
|
||||
@@ -25,7 +25,7 @@ Configuration of basic server settings:
|
||||
{{ globalsetting("INVENTREE_COMPANY_NAME") }}
|
||||
{{ globalsetting("INVENTREE_INSTANCE") }}
|
||||
{{ globalsetting("INVENTREE_INSTANCE_TITLE") }}
|
||||
{{ globalsetting("INVENTREE_INSTANCE_ID") }}
|
||||
{{ globalsetting("INVENTREE_INSTANCE_ID", default="Randomly generated value") }}
|
||||
{{ globalsetting("INVENTREE_ANNOUNCE_ID") }}
|
||||
{{ globalsetting("INVENTREE_RESTRICT_ABOUT") }}
|
||||
{{ globalsetting("DISPLAY_FULL_NAMES") }}
|
||||
@@ -186,10 +186,10 @@ In this section of the settings, staff users can set a list of parameters associ
|
||||
|
||||
To add a parameter to a part category:
|
||||
|
||||
1. select the category in the dropdown list
|
||||
2. click the <span class="badge inventree add">{{ icon("plus-circle") }} New Parameter</span> button on the top right
|
||||
3. fill out the "Create Category Parameter Template" form
|
||||
4. click the <span class="badge inventree confirm">Submit</span> button.
|
||||
1. Select the category in the dropdown list
|
||||
2. Click the <span class="badge inventree add">{{ icon("plus-circle") }} New Parameter</span> button on the top right
|
||||
3. Fill out the "Create Category Parameter Template" form
|
||||
4. Click the <span class="badge inventree confirm">Submit</span> button.
|
||||
|
||||
After a list of parameters is added to a part category and upon creation of a new part in this category, this list of parameters will be added by default to the new part.
|
||||
|
||||
|
||||
@@ -25,15 +25,17 @@ A *role* is a set of distinct permissions linked to a given subset of InvenTree
|
||||
|
||||
InvenTree functionality is split into a number of distinct roles. A group will have a set of permissions assigned to each of the following roles:
|
||||
|
||||
- **Admin** - The *admin* role is related to assigning user permissions.
|
||||
- **Part Category** - The *part category* role is related to accessing Part Category data
|
||||
- **Part** - The *part* role is related to accessing Part data
|
||||
- **Stock Location** - The *stock location* role is related to accessing Stock Location data
|
||||
- **Stock Item** - The *stock item* role is related to accessing Stock Item data
|
||||
- **Build** - The *build* role is related to accessing Build Order and Bill of Materials data
|
||||
- **Purchase Order** - The *purchase* role is related to accessing Purchase Order data
|
||||
- **Sales Order** - The *sales* role is related to accessing Sales Order data
|
||||
- **Return Order** - The *return* role is related to accessing Return Order data
|
||||
| Role | Description |
|
||||
| ---- | ----------- |
|
||||
| **Admin** | The *admin* role is related to assigning user permissions. |
|
||||
| **Build** | The *build* role is related to accessing Build Order and Bill of Materials data |
|
||||
| **Part** | The *part* role is related to accessing Part data |
|
||||
| **Part Category** | The *part category* role is related to accessing Part Category data |
|
||||
| **Purchase Order** | The *purchase* role is related to accessing Purchase Order data |
|
||||
| **Return Order** | The *return* role is related to accessing Return Order data |
|
||||
| **Sales Order** | The *sales* role is related to accessing Sales Order data |
|
||||
| **Stock Item** | The *stock item* role is related to accessing Stock Item data |
|
||||
| **Stock Location** | The *stock location* role is related to accessing Stock Location data |
|
||||
|
||||
{{ image("admin/roles.png", "Roles") }}
|
||||
|
||||
@@ -41,10 +43,12 @@ InvenTree functionality is split into a number of distinct roles. A group will h
|
||||
|
||||
Within each role, there are four levels of available permissions:
|
||||
|
||||
- **View** - The *view* permission allows viewing of content related to the particular role
|
||||
- **Change** - The *change* permission allows the user to edit / alter / change data associated with the particular role
|
||||
- **Add** - The *add* permission allows the user to add / create database records associated with the particular role
|
||||
- **Delete** - The *delete* permission allows the user to delete / remove database records associated with the particular role
|
||||
| Permission | Description |
|
||||
| ---------- | ----------- |
|
||||
| **View** | The *view* permission allows viewing of content related to the particular role |
|
||||
| **Change** | The *change* permission allows the user to edit / alter / change data associated with the particular role |
|
||||
| **Add** | The *add* permission allows the user to add / create database records associated with the particular role |
|
||||
| **Delete** | The *delete* permission allows the user to delete / remove database records associated with the particular role |
|
||||
|
||||
## Admin Interface Permissions
|
||||
|
||||
|
||||
Reference in New Issue
Block a user