====== Inventory ======

The Inventory module manages an organisation's physical equipment, such as projectors, tools, furniture, technical devices, or sports equipment. It supports item administration, lending, reservations, event-related equipment planning, imports, exports, and history.

===== Access and roles =====

The available functions depend on the user's rights and the module settings.

  * **Inventory administrators** can manage items, fields, imports, exports, history, lending, and reservation settings
  * **Item keepers** can manage the items assigned to them, depending on the configuration, they can also manage reservations and lending for these items
  * **Members, selected roles, or guests** may submit reservation requests if this is enabled in the preferences
  * Inventory data belongs to the currently active organisation

===== General settings =====

The Inventory settings are available in the organisation preferences under **Inventory**.

^ Setting ^ Description ^
| Visible for | Defines which roles may view and use the Inventory module |
| Items per page | Defines how many items are shown per page in the inventory list |
| Days of field history | Defines how long previous inventory field values remain available in the history |
| Enable item pictures | Enables pictures for inventory items |
| Storage location for item pictures | Defines whether pictures are stored in the database or in the file system |
| Maximum picture size | Defines the maximum width and height for item pictures |
| Show obsolete selection values | Defines whether selection values which are no longer used remain visible |
| Edit system field names | Allows the display names of predefined inventory fields to be changed |
| Allow keepers to edit items | Allows keepers to edit the items assigned to them |
| Fields editable by keepers | Defines which fields keepers may edit |
| Preselect current user as keeper | Assigns the current user as the keeper when creating an item |
| Allow negative numbers | Allows negative values in numeric inventory fields |
| Decimal places | Defines the number of decimal places shown for numeric fields |
| Date and time format | Defines whether date fields contain only a date or a date and time |

==== Lending settings ====

Lending can be disabled if it is not needed. When lending is disabled, no functions for issuing, returning, or managing loans are available.

==== Profile view settings ====

The administrator can decide whether inventory information is shown in user profiles.

The inventory fields to be displayed can be selected, for example the last received item or an assigned keeper.

==== Export settings ====

A default filename can be defined for inventory exports. Optionally, the current date can be added automatically to the filename.

===== Inventory list =====

The main inventory page shows all available items. Use the filters to limit the list by:

  * category
  * keeper
  * last receiver
  * item status
  * free-text search

Retired items are normally hidden from the default list. Administrators can include them by changing the status filter.

Authorised users can create, edit, copy, retire, reinstate, or delete items from the list. Multiple items can also be selected for bulk editing.

===== Managing inventory items =====

==== Create an item ====

Inventory administrators can create a new item from the Inventory menu.

Each item uses the configured inventory fields. Typical fields include:

  * item name
  * category
  * status
  * keeper
  * manufacturer
  * serial number
  * storage location
  * other organisation-specific information

The available fields are configured by the inventory administrator.

==== Edit, copy, and bulk-edit items ====

An existing item can be edited at any time by authorised users.

The copy function creates a new item based on an existing item. This is useful when several similar items must be entered.

Bulk editing applies selected values to several items at once. It is intended for changes such as assigning a keeper, changing a category, or updating a common field.

==== Item pictures ====

If item pictures are enabled in the preferences, pictures can be uploaded and assigned to items. Pictures help users identify equipment in the inventory list and item details.

==== Retire, reinstate, and delete items ====

  * **Retire** keeps the item and its history, but removes it from normal operational use
  * **Reinstate** makes a retired item available again
  * **Delete** permanently removes an item and should only be used when the item and its data are no longer needed

Retiring is normally preferable to deleting when historical information should be retained.

===== Inventory fields =====

Inventory administrators can maintain the fields used by inventory items.

Fields can be created, edited, reordered, or removed. Depending on the field type, option values can also be maintained.

Fields allow the Inventory module to be adapted to the organisation's needs. For example, an organisation may add fields for:

  * storage location
  * purchase date
  * serial number
  * condition
  * insurance number
  * responsible keeper

Changes to fields affect item forms, lists, filters, imports, and exports.

==== Date ranges and times ====

Inventory fields can be used for periods. The preferences define whether these fields use only a date or a date and time.

This can be useful for maintenance periods, warranty periods, or other time-related item information.

===== Lending and returns =====

The lending area is used to record the actual issue and return of items.

==== Lend an item ====

When lending is enabled, authorised users can record:

  * the receiver
  * the lending date
  * additional lending information

An item with an open lending record is considered physically issued and cannot be reserved for another period.

==== Return an item ====

When an item is returned, record the return in the lending area. The item then becomes available again, subject to existing approved reservations.

==== Lending overview for reservations (available from Admidio 6.0) ====

The lending overview can show:

  * approved reservations ready for handover
  * currently borrowed items
  * the receiver and lending date
  * actions to start lending or record a return

The physical return remains a manual process.

===== Reservation requests (available from Admidio 6.0) =====

Reservation requests allow inventory items to be planned for a specific period.

==== Reservation settings ====

^ Setting ^ Description ^
| Enable reservation requests | Enables requests for inventory item reservations |
| Allow reservations for events | Allows inventory items to be selected while editing an event |
| Allow keepers to manage reservations | Allows the responsible keepers of an item to manage its reservations |
| Approval of reservation requests | Defines whether reservations are approved automatically or manually |
| Who may request reservations | Defines whether guests, logged-in members, or members of selected roles may submit requests |
| Roles allowed to request reservations | Defines the roles whose members may submit reservation requests |
| Enable email notifications | Enables notifications about reservation requests and status changes |
| Notification roles | Defines one or more roles whose members receive notifications |
| Notify responsible persons for these actions | Defines which status changes notify responsible persons |
| Notify requester by email | Defines whether requesters receive notifications about changes to their reservation |

==== Who may request reservations? ====

The administrator can allow reservation requests from:

  * all visitors
  * logged-in members
  * members of selected roles

Guest requests require a name and email address.

==== Request an item ====

A reservation request contains:

  * the inventory item
  * start and end date and time
  * an optional comment
  * requester information

The system checks whether the item is available for the requested period. An active lending record or an overlapping approved reservation prevents approval for the same period.

==== Approval workflow ====

The approval mode can be configured as:

  * **Manual approval**, new requests receive the status ''Requested''
  * **Automatic approval**, new requests receive the status ''Approved'' when the item is available

==== Reservation lifecycle ====

A reservation can follow these status transitions:

  * ''Requested'' → ''Approved''
  * ''Requested'' → ''Rejected''
  * ''Requested'' → ''Cancelled''
  * ''Approved'' → ''Borrowed''
  * ''Approved'' → ''Cancelled''
  * ''Borrowed'' → ''Returned''

''Rejected'', ''Cancelled'', and ''Returned'' are final states. They remain in the history and cannot be changed back into an active reservation.

If an item is needed again after rejection or cancellation, a new reservation request must be created.

==== Manage reservations ====

Inventory administrators and, if enabled, responsible item keepers can manage reservations.

They can:

  * approve or reject requested reservations
  * cancel approved reservations before handover
  * view reservation details and requester information
  * record the handover of an item
  * record the return of an item

Requesters can withdraw their own open or approved reservations when they are logged in.

===== Reservations for events (available from Admidio 6.0) =====

Event reservations support organisers when planning the equipment needed for an event.

==== Add items to an event ====

When creating or editing an event, open the **Reservations** tab and add the required inventory items.

A reservation is created for every selected item for the event period. Depending on the configured approval workflow, requests are approved automatically or must be reviewed by a responsible person.

The status of every reservation is shown in the event form.

==== Change an event period ====

When the event period changes, the reservation period of the assigned items is adjusted accordingly.

If an item is not available for the new period, the responsible persons should review the reservation.

==== Remove items from an event ====

Removing an item from an event cancels reservations for which no handover has taken place yet.

Items that have already been handed over remain in the lending overview until their return is recorded manually.

==== Request an item again ====

If an event reservation was rejected or cancelled, the event editor can select **Request again** in the reservation status list.

A new request is created for the same item and event period. The earlier rejected or cancelled reservation remains available in the history.

===== Reservation notifications (available from Admidio 6.0) =====

Reservation email notifications can be enabled in the Inventory preferences.

Administrators can define:

  * whether notifications are sent
  * which roles receive reservation management notifications
  * which reservation actions notify responsible persons
  * whether requesters receive notifications

Notifications can be sent for new requests, approvals, rejections, cancellations, handovers, and returns.

Each notification contains the item, reservation period, current status, and requester information.

===== Import and export =====

==== Import ====

Inventory administrators can import items from the following file formats:

  * CSV
  * Microsoft Excel, XLS and XLSX
  * OpenDocument Spreadsheet, ODS
  * HTML tables

During import, file columns are assigned to the configured inventory fields.

==== Export and print ====

The filtered inventory list can be exported or printed. The following export formats are available:

  * CSV
  * Microsoft Excel, XLSX
  * OpenDocument Spreadsheet, ODS
  * PDF

The active inventory filters are applied to the export.

===== History =====

Inventory administrators can open the history to review changes to:

  * inventory items
  * item values
  * lending records
  * inventory fields and selection values
  * reservations, available from Admidio 6.0

The history shows who changed an item, reservation, or configuration value.

===== Recommended workflows =====

==== Initial setup ====

  - Create the inventory fields required by the organisation
  - Define categories, status values, and keepers
  - Add the inventory items
  - Configure lending and reservation preferences
  - Configure notification roles if reservation emails are required

==== Daily lending ====

  - Select an available item
  - Record the handover
  - Record the return when the item is returned

==== Plan inventory for an event (available from Admidio 6.0) ====

  - Create or edit the event
  - Open the **Reservations** tab
  - Add the required items
  - Save the event
  - Review and approve the resulting reservation requests when manual approval is enabled
  - Record handover and return when applicable

==== Handle rejected requests (available from Admidio 6.0) ====

  - Review the reason for rejection and the availability of the item
  - If the item is still needed for an event, select **Request again**
  - Process the new request through the normal approval workflow