Barcode app docs (#5788)

* Update settings page

* Update barcode action documentation

* Update app privacy information
This commit is contained in:
Oliver 2023-10-25 23:46:26 +11:00 committed by GitHub
parent f280e0aeaf
commit e13b57669c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 106 additions and 10 deletions

View File

@ -25,8 +25,90 @@ The following code types are known to be supported
- Data Matrix
- Aztec
## Actions
## Barcode Input Methods
The InvenTree app uses barcodes where possible to provide efficient stock control operations.
Barcodes can be scanned using the following methods:
If there is a new barcode feature you would like to see, [let us know on GitHub](https://github.com/inventree/InvenTree/issues?q=is%3Aopen+is%3Aissue+label%3Aapp)!
### Camera Input
The camera input method allows you to scan barcodes using the device's internal camera. Both the forward and rear-facing cameras are supported.
### Keyboard Input
The keyboard wedge input method allows you to scan barcodes using any scanner which presents barcode data as keyboard input. This works with external bluetooth scanners, and also provides support for integrated barcode scanner devices which run Android natively.
Note that if using keyboard wedge input mode, the scanner must be configured to append an enter (`\n`) character to the end of the barcode data.
## Barcode Actions
The InvenTree app uses barcodes where possible to provide efficient stock control operations. Some pages in the app will provide context-sensitive barcode actions. These actions are available from the *Barcode Actions* menu, which is displayed in the bottom right corner of the screen.
### Global Scan
Available from the global bottom menu, the *Scan Barcode* provides quick access for scanning a barcode already associated with an InvenTree database item (such as a stock item or location).
If a match is found, the app will navigate to the relevant page.
### Stock Location Actions
From the [Stock Location detail page](./stock.md#stock-location-view), multiple barcode actions may be available:
{% with id="location-actions", url="app/barcode_stock_location_actions.png", maxheight="240px", description="Stock location barcode actions" %}
{% include 'img.html' %}
{% endwith %}
#### Assign Barcode
Assign a custom barcode to the selected location. Scanning a barcode (which is not already associated with an item in the database) will result in that barcode being assigned to the selected location.
#### Transfer Stock Location
Transfer the currently selected stock location into another location. Scanning a valid barcode associated with a stock location will result in the current location being *moved* to the scanned location.
#### Scan Received Parts
Receive incoming purchase order items into the selected location. Scanning a *new* barcode which is associated with an item in an incoming purchase order will receive the item into the selected location.
#### Scan Items Into Location
the *Scan Items Into Location* action allows you to scan items into the selected location. Scanning a valid barcode associated with a stock item (already in the database) will result in that item being transferred to the selected location.
### Stock Item Actions
From the [Stock Item detail page](./stock.md#stock-item-detail-view), the following barcode actions may be available:
{% with id="item-actions", url="app/barcode_stock_item_actions.png", maxheight="240px", description="Stock item barcode actions" %}
{% include 'img.html' %}
{% endwith %}
#### Assign Barcode
Assign a custom barcode to the selected stock item. Scanning a barcode (which is not already associated with an item in the database) will result in that barcode being assigned to the selected stock item.
#### Scan Into Location
Scan the selected stock item into a stock location. Scanning a valid barcode associated with a stock location will result in the selected stock item being transferred to the scanned location.
### Part Actions
From the [Part detail page](./part.md#part-detail-view), the following barcode actions are available:
{% with id="part-actions", url="app/barcode_part_actions.png", maxheight="240px", description="Part barcode actions" %}
{% include 'img.html' %}
{% endwith %}
#### Assign Barcode
Assign a custom barcode to the selected part. Scanning a barcode (which is not already associated with an item in the database) will result in that barcode being assigned to the selected part.
### Purchase Order Actions
From the [Purchase Order detail page](./po.md#purchase-order-detail) page, the following barcode actions are available:
{% with id="po-actions", url="app/barcode_po_actions.png", maxheight="240px", description="Purchase order barcode actions" %}
{% include 'img.html' %}
{% endwith %}
#### Scan Received Parts
Receive incoming purchase order items against the selected purchase order. Scanning a *new* barcode which is associated with an item in an incoming purchase order will receive the item into stock.

View File

@ -48,7 +48,7 @@ The <span class='fas fa-search'></span> action opens the [Search](./search.md) s
### Scan Barcode
The <span class='fas fa-qrcode'></span> action opens the [barcode scan](./barcode.md) window, which allows quick access to the barcode scanning functionality.
The <span class='fas fa-qrcode'></span> action opens the [barcode scan](./barcode.md#global-scan) window, which allows quick access to the barcode scanning functionality.
## Context Actions

View File

@ -10,13 +10,26 @@ The InvenTree mobile app requires some extra permissions for complete functional
### User Profiles
The InvenTree app requires the user to enter profile data to connect with an InvenTree server:
For each *profile* configured in the app, the following information is stored locally on the device:
- Server address
- Account username
- Account password
- Server name (e.g. "InvenTree Demo")
- Server address (e.g. "https://demo.inventree.org)
- *API token*
Profile data is stored locally on the device, and can be deleted by the user if they wish. Profile data is only used for connection with an InvenTree server.
#### User Authentication
The InvenTree app uses an API token for user authentication. This token is requested once from the server, and then stored locally on the device.
To initially request the token, the user will be required to enter their username and password.
!!! info "Password Storage"
The user's username and password are not stored locally, or used for any purpose other than requesting an API token
#### Token Handling
A separate API token is stored locally for each profile. This token can be deleted at any time from within the app settings - this will force the user to enter their login credentials again to request a new token.
Additionally, the stored token may be revoked by the server, or expire. Either situation will again require the user to re-enter their username and password.
### Camera Permissions

View File

@ -55,7 +55,7 @@ Configure audible app notifications:
## Barcode Settings
The *Barcode Settings* view allows you to configure options relating to barcode scanning:
The *Barcode Settings* view allows you to configure options relating to [barcode scanning](./barcode.md):
{% with id="barcode_settings", url="app/barcode_settings.png", maxheight="240px", description="Barcode Settings" %}
{% include 'img.html' %}
@ -63,6 +63,7 @@ The *Barcode Settings* view allows you to configure options relating to barcode
| Option | Description |
| --- | --- |
| Scanner Input | Select barcode capture mode |
| Barcode Scan Delay | Delay between successive scans |
## Home Screen

Binary file not shown.

After

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 139 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 141 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 152 KiB