{#icons/storageBlocks /} Storage
{#links/storageBlocks /} describe areas and places where things are stored. It can be a shelf, a bin, or anywhere you put things. We don't judge.
Storage blocks can also have parents, leading to a tree structure to describe a whole facility and how the storage is related. An example layout:
-
House
-
Kitchen
- Cabinets
-
Kitchen
-
Shed
- Shelves
- Garage
{#icons/items /} Items
Items are... what's stored! Items are tracked on the {#links/inventoryItems /} page.
How Items Work
"{#icons/item /} Inventory Items" describe a type of item that is stored, but not what is actually stored where. These are high level details that apply to all related {#icons/stored /} Stored items.
"{#icons/stored /} Stored" is what describes actual physical items. These are tied to specific items and storage blocks. While most data that makes up a stored item can be edited, all changes to stored that affect the number or amount of stuff stored must happen through {#icons/transaction /} Transactions. Different storage types of the item determine what kinds of stored can be added and how they are stored.
{#icons/stored /} Stored Types
These are the types of {#icons/stored /} Stored items. Which type an item uses are defined by the Storage Type set.
{#icons/storedTypeAmount /} Amount Stored
This type describes amounts of stuff. Used in situations where you are not tracking individual items, but amounts of stuff.
{#icons/storedTypeUnique /} Unique Stored
These describe individual physical items.
Storage Types
There are may ways to track and store items. We facilitate this by giving you several options of types of storage:
Amount Based
{#icons/storageTypeBulk /} Bulk
This is meant to specify bulk items, like bolts, mulch, or other things that aren't separated by anything. Bulk items only have one stored object associated for each storage block.
{#icons/storageTypeAmtList /} Amount List
This is meant to specify a wider array of items. It can be used to keep track of different amounts of things in one storage block, separated by condition or other attribute. It can also be used to specify different items that are identified by the amount of stuff they are, such as fresh packaged food.
Unique
Unique items are meant to express items that are uniquely identified. These items don't have an amount associated with them, and are counted individually.
{#icons/storageTypeUniqueMulti /} Unique - Multi
This iteration of item allows for many unique items to be stored. Examples could be anything with a serial number, or otherwise uniquely identified.
{#icons/storageTypeUniqueSingle /} Unique - Single
This only allows a single unique item to be stored. It supports multiple blocks to be associated, just only one stored item between them. Examples could include your favorite guitar, a special tool, or momento.
{#icons/transaction /} Transactions
Transactions are the only way to change the number of stored items. This is to ensure a clear, single interface for doing so, and allows for easy tracking of items over time, as well as clear history of the item.
You can still edit stored item details, just not change anything that modifies the amount of that item.
{#icons/units /} Units
Open QuarterMaster has robust support for different units, and converting between them. For instance, an {#icons/item /} inventory item can have a unit of Kilogram, and any {#icons/stored /} stored can have a unit compatible with it (any other unit in the "Mass" category).
Below are units available to use in this system. An inventory administrator can add additional units.
Units are system-wide, and not associated with a single database.
{curCategory.getKey()}
-
{#for curUnit in curCategory.getValue()}
-
{curUnit.get("name").asText()} - (
#{curUnit.get("symbol").asText()} )
{/for}
Item Search Providers
This describes the external services supported by Open QuarterMaster to help read in data about items.
For information on enabling/ configuring these providers, see {#icons/github /} our documentation on Github
{#if extSearchEnabled}Item Lists
TODO
{#icons/coreApi /} Core API
This interface (the Base Station) is a UI wrapper for the {#icons/coreApi /} Core API. While all functionality is available here, the Open QuarterMaster system is intended to be extended to suit your needs. You can do this by connecting to the {#icons/coreApi /} Core API from your own software.
Full documentation of all endpoints is available at the {#icons/coreApi /} Core API.
For information developing your own plugins: {#icons/github /} Writing Plugins on our Github
{#icons/coreApi /} Feedback
Open QuarterMaster is, at its core, an open source system. If you find anything that is lacking, needs fixed, or improved, please don't hesitate to reach out! Any and all suggestions and reports are welcome!
Find out all the ways you can help us by visiting our {#icons/github /} Github!