Table of Contents

Segmentable Inventory: How-to & Usage Guide

Mitchell Paul-Soumis Updated by Mitchell Paul-Soumis

Read Time: 9 mins

Open Sonar Cast

What is Segmentable Inventory

Segmentable Inventory in Sonar is used to manage inventory that begins as a single item, and over the course of its lifecycle, gets subdivided into multiple items. Most commonly, this would represent anything that comes on a spool, such as fiber, ducting, or network cable.

Segmentable Inventory differentiates itself from trackable network equipment in two ways:

  1. Segmentable Inventory is defined by a unit of measure
  2. Segmentable Inventory does not support networking equipment concepts such as MAC Addresses, or ICMP/SNMP monitoring

Adding your cable spools into Sonar as Segmentable Inventory allows you to split each spool into custom lengths as required, track where each length was deployed, and track its status in the event of damage. Additionally, this layer of Inventory enables improved financial tracking and inventory reporting, a streamlined process for your field technicians, and traceability from each deployment back to a spool and purchase order.

Segmentable versus Consumable

Consumable Inventory in Sonar represents a different subset of items. While both Segmentable and Consumable items are non-networking inventory, Consumable Items are not tracked at all. If you need to track metadata such as price, or batch numbers against your deployed fiber, you must use Segmentable Inventory to do this.

Consumable inventory is focused more on non-networking items that, once used, become something that is not likely to be recovered or monitored. Think of screws and mounting hardware as examples of Consumable Inventory. For more information, and more detailed examples, refer to the Tracking and Using Consumable Inventory article.

Creating Segmentable Inventory

Segmentable Inventory follows the same creation process as most other inventory. Manufacturers, Categories, and Assignees are covered in a separate article.

Creating Segmentable Inventory starts with creating a model that defines the Unit of Measure.

  1. Click on “Inventory” from the sidebar
  2. Click on “Manage Items”
  3. On the Inventory Model Management page, click the Add Model button
  4. In the window that appears, define the Segmentable Item.
    1. Ensure the Segmentable checkbox is selected
    2. Fill out all required fields, ensuring the correct Quantity and Unit of Measure values are set
      Quantity and Unit of Measure Explanation
      The Quantity field represents the default measure used when an item is added to the defined Inventory Model, while the Unit of Measure is used to display the set unit alongside the measure defined in Quantity. This 2-stage definition provides a way to quickly add items when ordered while also allowing flexibility when adding existing items, or items that can have a slight variance.
    3. Click “Create”, which will save your created Inventory Model and prompt you to manage the additional details associated with an Inventory Model.

Inventory Model Configuration

Once your Inventory Model is created, you'll be given the option to modify additional information that will be associated with your Inventory Model and Inventory Items.

This form will prompt you to Add Items, add Deployment Types, Modify Device fields, Manage the LTE provisioning, and Add additional Purchase Order Vendors. 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 inventory items, 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 (PCRE)
    8. Text
  3. The Secondary Type field allows you to specify if a device is a Cable Modem when MAC Address is selected as the “Type”. This would typically be used exclusively for Network Inventory.
  4. The Required selector enforces whether this field must be filled out to add an item to inventory
  5. The Primary selector determines whether 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 field data
2. Deployment Types

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

Deployment Types allow you to specify different Monitoring Templates within the same Inventory Model. Because Segmentable Inventory cannot be monitored this way, Deployment Types offer comparatively less value. However, Deployment Types can still be leveraged for internal reporting and tracking.
3. Provisioning

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.

Segmentatble Inventory is non-networking equipment, and will therefore never leverage the Provisioning portion of Sonar's Inventory module. When configuring your Inventory Model, this parameter can safely be bypassed.
4. Add Vendor

The Add Vendor option allows you to associate this Inventory Model with a specific Purchase Order Vendor. You'll need to provide the model information and default price details. These will autofill when a Purchase Order is created, but can be modified during PO creation.

Adding & Viewing Items

Once the model is created, items can be added to it. Items can be added automatically through receiving Purchase Orders, or manually through the “Add Items” button on the Inventory Model. This will open a new modal, where you'll be prompted to provide more information about the item.

For more information on adding items through a Purchase Order, refer to the Purchase Orders: Overview and Usage article.
  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 SettingsInventoryInventory 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. Certain fields will vary depending on how the inventory model was configured, but two will appear on every item:
    1. Status, which is a field used to represent the item's functional condition.
    2. Purchase Price, which is the price of the item, written in the lowest currency denomination (cents for North America, centavos in Mexico, pence in the UK, etc.)
  5. The second is an icon, indicating the field can receive a scanned input value from a barcode. Simply place your cursor within the entry field and scan. Anytime this icon is shown, you can scan a barcode and extract the value.
    Most generic barcode scanners are compatible with the inventory scanning feature available in Sonar, such as the NADAMOO Wireless Barcode Scanner
  6. The “Save Items as CSV” button allows you to export a file which contains the required formatting to import devices in bulk, which will include all items currently added in the modal.
  7. The “Load Items from CSV” button allows you to add multiple items at the same time by using a filled in template which was previously exported. Each item will be added as a new line to the modal.

Once an item is added, it is added as a Parent Segment, and will appear in the Inventory List. Clicking on the item from the Inventory List will bring you to the Item Overview.

Creating New Segments

From the Parent Segment, smaller Child Segments can be created.

  1. Navigate to the “Segments” sub-tab.
  2. Click on “Add Segment”.

This will open a new modal, where, much like the original item creation, an assignee must be selected. Where Segment creation diverges from item creation is here — rather than filling out all fields set on the model, only the new Segment measurement must be provided.

Once the Child Segment is created, the list will populate with its details, and the total available amount of the Parent Segment will update to reflect the removal of the Child Segment.

The available measure of a Parent Segment is visible from the header, or from the Overview tab.
  1. The ID displayed in the ID column is the unique Inventory ID of the specific segment. This is used for both search reference, and for identification when assigning items to their installation locations.
  2. The Assignee column shows the location where the segment is currently assigned.
Dividing Sub-segments

Your segments can be further divided from their set value, without any additional navigation. From the Segments table, click on the “Edit” button for the segment you'll be further dividing.

In the window that appears, reduce the Quantity field. As soon as the modification is made, two new options will appear.

These options will only be available if reducing the Segment amount. Adding any additional amount to the value will result in that amount being subtracted from the Parent Segment and added to this Segment, instead.
  1. Adjust the parent quantity of this segment
    1. This option will adjust both the Parent Segment and current Segment quantities, and is used to correct a measurement or cutting error.
  2. Create a new segment with the difference as its length
    1. This option will create a new Segment, belonging to the primary Parent Segment. This maintains the same reporting and tracking advantages by consistently representing the primary spool or bulk item as the ultimate top-level Inventory.
Deploying Segments

Immediately upon creation, Segments need to be assigned to an initial Inventory Location. From there, they can be re-assigned like any other inventory item. From the Segments table, you can click on the “Edit” button next to the Segment. This will open the Edit Item modal, where you can modify the Assignee value. Each child segment can be assigned to an inventory location, technician, vehicle, or serviceable address.

Segments can also be created and deployed through the Sonar Field Technician app. For more information, check out the how-to guides for the Field Tech App.

Segments can also be assigned as Inventory from the destination, whether that is a Network Site, Account, or Serviceable Address.

Because Segmentable Inventory is treated the same as all inventory, it's recommended you search for the item by name when assigning it. The individual items will show the Primary field if one was added if it's the Parent item, and “Segment” if it's a created segment.

Segmentable Inventory assigned to any location can also be further segmented from that location. In this example image, the Segmentable inventory is assigned to an Account, and additional segments have been created to represent the various locations needed for the run.

All segments created from a shared parent will report that Segment Parent in the Inventory List, even if they are created as a result of segmenting an existing segment.

How did we do?

Network Inventory: How-to & Usage Guide

Setup of Inventory: Manufacturers, Categories, and Assignees

Contact