Preliminary pack variant docs #30
Open
+102
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
roxy-dao
reviewed
Apr 25, 2024
|
|
||
|  | ||
|
|
||
| New pack variants are added via **New Pack Variant** button, existing pack variants are edited by clicking on the table row. Deletion can be done via editing modal or by selecting lines via checkboxes and using the 'Select' drop down option. |
There was a problem hiding this comment.
Suggested change
| New pack variants are added via **New Pack Variant** button, existing pack variants are edited by clicking on the table row. Deletion can be done via editing modal or by selecting lines via checkboxes and using the 'Select' drop down option. | |
| New pack variants are added via the **New Pack Variant** button, existing pack variants are edited by clicking on the table row. Deletion can be done via the editing modal or by selecting the checkboxes and using the 'Select' drop down option. |
Can each of these steps be broken down with screenshots that either have arrows pointed to the New Pack Variant button or the delete button?
|
|
||
|  | ||
|
|
||
| - **Pack Size**: The pack size of this pack variant, unique for item |
There was a problem hiding this comment.
Suggested change
| - **Pack Size**: The pack size of this pack variant, unique for item | |
| - **Pack Size**: The pack size of this pack variant. The pack size is unique for the item |
|  | ||
|
|
||
| - **Pack Size**: The pack size of this pack variant, unique for item | ||
| - **Abbreviation**: How this pack size will appear in UI when window space is limited |
There was a problem hiding this comment.
Suggested change
| - **Abbreviation**: How this pack size will appear in UI when window space is limited | |
| - **Abbreviation**: How this pack size will appear in the UI when window space is limited |
|
|
||
| - **Pack Size**: The pack size of this pack variant, unique for item | ||
| - **Abbreviation**: How this pack size will appear in UI when window space is limited | ||
| - **Name**: How this pack size will appear in UI when windows space is not limited |
There was a problem hiding this comment.
Suggested change
| - **Name**: How this pack size will appear in UI when windows space is not limited | |
| - **Name**: How this pack size will appear in the UI when there is enough space to display it |
| - **Abbreviation**: How this pack size will appear in UI when window space is limited | ||
| - **Name**: How this pack size will appear in UI when windows space is not limited | ||
|
|
||
| Editing configurations is restricted to central server, when configurations have changed they will appear on the remote sites after synchronisation |
There was a problem hiding this comment.
Suggested change
| Editing configurations is restricted to central server, when configurations have changed they will appear on the remote sites after synchronisation | |
| Editing configurations is restricted to the central server and will appear on remote sites after synchronisation |
|
|
||
| Editing configurations is restricted to central server, when configurations have changed they will appear on the remote sites after synchronisation | ||
|
|
||
| [](/docs/introduction/central/#remote-site-vs-central-server) |
There was a problem hiding this comment.
This icon seems really random... doesn't really indicate anything to me... I would probably just prefer to have central server link to the central server docs page... can't really tell it's a link unless you hover over it...
|
|
||
| Items can have pack variants which help: | ||
| - Display unit and pack size combination for stock batches in a more readable form | ||
| - Allows user to see item other then base unit, but in a pack size of the pack variant they've chosen |
There was a problem hiding this comment.
Suggested change
| - Allows user to see item other then base unit, but in a pack size of the pack variant they've chosen | |
| - Allows the user to see the item in the format that the user has chosen instead of the base unit |
| - Display unit and pack size combination for stock batches in a more readable form | ||
| - Allows user to see item other then base unit, but in a pack size of the pack variant they've chosen | ||
|
|
||
| Pack variants are configured in item [pack variant tab](/docs/catalogue/items/#pack-variants) |
There was a problem hiding this comment.
Suggested change
| Pack variants are configured in item [pack variant tab](/docs/catalogue/items/#pack-variants) | |
| Pack variants are configured in the item [pack variant tab](/docs/catalogue/items/#pack-variants) |
|
|
||
| Pack variants are configured in item [pack variant tab](/docs/catalogue/items/#pack-variants) | ||
|
|
||
| For documentation below, let's consider these pack variants were created for Acetylsalicylic Acid 100mg item. |
There was a problem hiding this comment.
Suggested change
| For documentation below, let's consider these pack variants were created for Acetylsalicylic Acid 100mg item. | |
| In the example below, we are creating pack variants for Acetylsalicylic Acid 100mg. |
roxy-dao
requested changes
Apr 28, 2024
|
|
||
| ## Pack variants for viewing stock batches | ||
|
|
||
| When pack variants were introduced, we've merged unit and pack size columns, into one **Pack** column, which will now display the following: |
There was a problem hiding this comment.
Suggested change
| When pack variants were introduced, we've merged unit and pack size columns, into one **Pack** column, which will now display the following: | |
| The unit and pack size columns have been merged into one **Pack** column, which displays the following: |
|
|
||
| | Base Unit | Pack Size | Description | **Pack** | | ||
| |-----------|-----------|---------------------------------------------------------------------------------------|--------------| | ||
| | | 1 | No unit is configured so will display as "Unit" and pack size 1 so no number is shown | Unit | |
There was a problem hiding this comment.
Suggested change
| | | 1 | No unit is configured so will display as "Unit" and pack size 1 so no number is shown | Unit | | |
| | | 1 | No unit is configured. `Unit` will be displayed with no number as pack size is 1 | Unit | |
| | Base Unit | Pack Size | Description | **Pack** | | ||
| |-----------|-----------|---------------------------------------------------------------------------------------|--------------| | ||
| | | 1 | No unit is configured so will display as "Unit" and pack size 1 so no number is shown | Unit | | ||
| | | 10 | No unit is configured so will display as "Unit" and pack size is shown as multiplier | 10 x Unit | |
There was a problem hiding this comment.
Suggested change
| | | 10 | No unit is configured so will display as "Unit" and pack size is shown as multiplier | 10 x Unit | | |
| | | 10 | No unit is configured. `Unit` and pack size is displayed | 10 x Unit | |
| |-----------|-----------|---------------------------------------------------------------------------------------|--------------| | ||
| | | 1 | No unit is configured so will display as "Unit" and pack size 1 so no number is shown | Unit | | ||
| | | 10 | No unit is configured so will display as "Unit" and pack size is shown as multiplier | 10 x Unit | | ||
| | Capsule | 1 | Unit is configured "Capsule" will be displayed and pack size 1 so no number is shown | Capsule | |
There was a problem hiding this comment.
Suggested change
| | Capsule | 1 | Unit is configured "Capsule" will be displayed and pack size 1 so no number is shown | Capsule | | |
| | Capsule | 1 | Unit is configured. `Capsule` will be displayed and no number will be shown as pack size is 1 | Capsule | |
| | | 1 | No unit is configured so will display as "Unit" and pack size 1 so no number is shown | Unit | | ||
| | | 10 | No unit is configured so will display as "Unit" and pack size is shown as multiplier | 10 x Unit | | ||
| | Capsule | 1 | Unit is configured "Capsule" will be displayed and pack size 1 so no number is shown | Capsule | | ||
| | Capsule | 10 | Unit is configured "Capsule" will be displayed and pack size is shown as multiplier | 10 x Capsule | |
There was a problem hiding this comment.
Suggested change
| | Capsule | 10 | Unit is configured "Capsule" will be displayed and pack size is shown as multiplier | 10 x Capsule | | |
| | Capsule | 10 | Unit is configured. `Capsule` and pack size are displayed | 10 x Capsule | |
|
|
||
|  | ||
|
|
||
| In above example Acetylisalicylic Acid has three batches in stock, two of them have defined pack variant that match stock pack size and one pack size does not match any pack variant (20). Ibuprofen and Amoxicillin don't have matching pack variants. Ibuprofen does not have defined unit and Amoxicillin unit is configured as 'Tab'. |
There was a problem hiding this comment.
Suggested change
| In above example Acetylisalicylic Acid has three batches in stock, two of them have defined pack variant that match stock pack size and one pack size does not match any pack variant (20). Ibuprofen and Amoxicillin don't have matching pack variants. Ibuprofen does not have defined unit and Amoxicillin unit is configured as 'Tab'. | |
| In the example below, Acetylsalicylic Acid has three batches in stock. Two of the batches have defined pack variants that match stock pack size and one pack size which does not match any pack variants (20). Ibuprofen and Amoxicillin don't have matching pack variants, but Ibuprofen does not have a unit defined while Amoxicillin has `Tab` defined for its unit. |
Move this sentence up and remove for example
|
|
||
| ## Pack variants for entering stock batches | ||
|
|
||
| If item has pack variants defined then stock entry view will allow you to select existing pack variant or enter custom pack size |
There was a problem hiding this comment.
Suggested change
| If item has pack variants defined then stock entry view will allow you to select existing pack variant or enter custom pack size | |
| If an item has pack variants defined then the stock entry window will allow you to select existing pack variants or enter a custom pack size |
|
|
||
|  | ||
|
|
||
| The [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will always be pre selected for new bathes |
There was a problem hiding this comment.
Suggested change
| The [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will always be pre selected for new bathes | |
| The [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will always be pre-selected for new batches |
|
|
||
| ## Pack variants for item view | ||
|
|
||
| When viewing items where stock lines are not visible, for example in item catalogue or when making internal order, pack variants replace the base unit. A drop down will be presented for items with pack variants and [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will be pre selected. Quantities will adjust based on the selected pack variant. |
There was a problem hiding this comment.
Suggested change
| When viewing items where stock lines are not visible, for example in item catalogue or when making internal order, pack variants replace the base unit. A drop down will be presented for items with pack variants and [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will be pre selected. Quantities will adjust based on the selected pack variant. | |
| When viewing items where stock lines are not visible, for example in item catalogue or when making an internal order, pack variants replace the base unit. A drop down will be presented for items with pack variants and the [default pack variant](/docs/catalogue/pack-variants/#default-pack-variant) will be pre-selected. Quantities will be adjusted based on the selected pack variant. |
Comment on lines
+68
to
+70
| Default pack variant would either be *last selected pack variant for this store, or if pack variant has not be selected yet, it would be the pack variant matching the most used pack size for this store | ||
|
|
||
| *last selected pack - this preference is saved in the client, for example the browser instance or Open mSupply client instance (it's not saved for user and store for the entire Open mSupply instance) |
There was a problem hiding this comment.
Suggested change
| Default pack variant would either be *last selected pack variant for this store, or if pack variant has not be selected yet, it would be the pack variant matching the most used pack size for this store | |
| *last selected pack - this preference is saved in the client, for example the browser instance or Open mSupply client instance (it's not saved for user and store for the entire Open mSupply instance) | |
| Default pack variant would either be last selected pack variant for this store, or if pack variant has not be selected yet, it would be the pack variant matching the most used pack size for this store. | |
| The last selected pack will be saved in the browser (e.g. Firefox, Chrome, etc) or Open mSupply client (desktop or mobile). It is not saved for the user and store. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.