Table of Contents

Inventory Model Management: General Overview

Mitchell Paul-Soumis Updated by Mitchell Paul-Soumis

Unlike the Inventory List view covered in another article, the Model Management view provides a tiled list of models, with the count or information on specific inventory items nowhere to be seen on this page. Instead, this portion of the inventory section of Sonar deals uniquely with creating and managing the Inventory Models in your instance. In this article, we'll be looking at navigating around this page, how to create a new Inventory Model, how to manage and modify an existing Inventory Model, and how to add new items to each model. The inventory Model Management view is accessible by clicking on the "Manage Items" button visible from the Inventory Item List view, and returning to the List view requires clicking on the "Inventory" button in the main navigation pane.

The Inventory Model Management View

The inventory Model view displays a series of tiled images for all models added to the instance. If no custom image is supplied, a non-specific default image will be used, but the model's given name, manufacturer, and type will still be displayed underneath the generic image. We'll start by exploring the process behind adding a new Inventory Model.

Adding a New Model

Adding a new Inventory Model to your instance is a multi-step process which begins by clicking on the "Add Model" button, available in the upper-right corner of the Model Management view, and pictured below:

Once you click on the "Add Model" button, you'll be sent to the Create Inventory Model window. This window allows you to provide information which will create your new inventory model.

  1. The Enabled toggle allows you to set whether or not the Inventory Model you're adding will be available to add or assign items to
  2. The Generic toggle allows you to set an item as generic, which has no distinct fields and is designed to allow you to track consumable items
  3. The icon allows easy identification of the inventory, and contains a large selection of available icons
  4. The Manufacturer selection, which allows you to select from the list of Inventory Manufacturers you've added to your Sonar instance
  5. The Category of the device, with available selections determined by what Device Categories you've configured in your instance
  6. The Model Name, which is an optional field and allows you to set a unique, more descriptive name for the device while allowing the Display Name to be simpler
  7. The Display Name, which is shown when viewing, modifying, or assigning devices to or from this Inventory Model
  8. The Protocol, which is used in conjunction with the Port to facilitate remote communication to individual devices of this model
  9. The Port, used in conjunction with the communication protocol, to facilitate remote communication to individual devices of this model
  10. The Device Type, which allows you to set the type of device you're adding, between "Cable Modem" or "Other"
  11. The Files section, which allows you to upload a single image to serve as the display image for your new Inventory Model
  12. The Description allows you to add details to the file you're uploading for the Model image

Once you enter in the information and click on Create, you'll be presented with an additional form which will prompt you to Add Items, add Deployment Types, Modify Device fields, and Manage the LTE provisioning. Below, we'll cover these sections in the ideal order.

1. Modify Fields

Field Modification allows you to create new data entry fields for your hardware devices, which can be filled out for searching, reporting, and provisioning purposes:

  1. The Name of the field, which allows for custom text entry
  2. The Type of the field being added, from a preset list of options:
    1. Decimal
    2. IMSI
    3. Integer
    4. LTE Auth Key
    5. MAC address
    6. OP/OPc
    7. Regular Expression
    8. Text
  3. The Secondary Type allows you to define if this field is also a MAC Address. This is used when another field being defined could also be used as the MAC Address.
  4. The Required selector enforces whether or not this field must be filled out in order to add an item to inventory
  5. The Primary selector determines whether or not this field is the primary field, used for searching, reporting, and identification
  6. The Unique dropdown, which allows you to enforce a unique value:
    1. Globally, which means all models across your instance
    2. Locally, which means local to only this Inventory model
    3. None, which doesn't enforce a unique value of any kind
  7. The REGEXP column allows you to define the format of the Regular Expression being entered. This column can only be filled out if the field type is set to Regular Expression
    1. You might use REGEXP to force a non-fqdn host name to conform to some internal standard. For example, a host name with the requirements of a letter followed by any combination of letters, dashes, and numbers but must be at least 3 characters long would be defined as ^[a-z][-0-9a-z]{2,}
  8. The "Apply" button saves the field date for the current row
  9. The "Add Row" button allows you to add additional row to the Model, each one can contain its own field data
2. Deployment Types

Deployment Types are text fields which allow you to add additional precision when assigning a device to location or user.

Deployment Types allow you to specify different Monitoring Templates within the same Inventory Model. For example, a Ubiquiti Rocket AC might be deployed as a backhaul, an access point on a network site, or even a CPE on a customer account. In all three examples, you would want entirely different monitoring applied to the same inventory model depending on it's deployment.
3. Provisioning (optional)

The Provisioning option allows you to select the type of LTE SIM in use by this device. This option is used exclusively for Inventory Models which deliver LTE-based service

4. Adding Items

Once you've set the model fields, you can begin adding new inventory items to the model. This is done using the "Add Items" button, and will bring you to the Create Item window.

  1. Directly below the Assignee header, there's the primary assignee selector. The options which can be selected as an assignee are:
    1. Address
    2. Generic Inventory Assignee
    3. Inventory Location
    4. Network Site
    5. User
    6. Vehicle
  2. Below the main assignee, you have the specifier for that assignee. For example, an address assignee will have you select the serviceable address, while an Inventory Location will have you select the warehouse
  3. If you select an inventory location, you'll be prompted to select the internal location after that. The Internal location field will be empty unless internal locations have been created in Settings -> Inventory -> Inventory Locations
  4. The top of each column displays two things, the first of which is the name of the field that is being filled out
  5. The second thing is a check box which allows you select one or multiple fields to be filled in by scanning a device's bar codes
  6. The Export Template button allows you to export a file which contains the required formatting to import devices in bulk
  7. The Import CSV button allows you to add multiple items at the same time by using a filled in template which was exported

Modifying a model

Once you've created a model, you have the option of waiting until later to complete the various additional steps. You can do that by going to the model and expanding the drop down, as pictured below:

The Model allows you to:

  • Add new inventory items
  • Modify Inventory Model fields (such as adding new ones or removing existing ones)
  • Modify the Provisioning method
  • Edit the details of the Model
  • Updated the attached display image
  • Delete the model entirely

Searching and filtering

Unlike the Inventory List view, the searching and filtering within the model management view doesn't give you a series of filters. The filtering of Inventory Models is limited to a series of check boxes, allowing you to narrow down the visible results to various manufacturers, and various categories of the model:

How did we do?

Inventory List View: Overview