Bulk Manage Devices

You can add multiple devices to inventory and register them at the same time using a .csv file that you upload to the server.

Add the Devices

To bulk add devices:

  1. Create a correctly formatted .csv file that includes the required information for each device. You can download a sample .csv file below.
  2. Go to Control Center > Inventory.
  3. Click Bulk Manage.
  4. Select your .csv file and upload it.

Uploads take some time to process, depending on the number of devices you are adding. You can see completed jobs in your Audit Log.

Format Your CSV File

For a bulk upload to work, the file must be correctly formatted.
You can download a sample .csv file.
If there is an error related to a particular line in your file, you will be notified of the line number and device ID affected.

CSV File Requirements

On upload, some pre-checks will be performed:

  • The file size must not exceed 10Mb.
  • Each device_id (first column) may only appear once in the file.
  • Each device_id must be new, that is, cannot already be registered in EyeSaaS, as editing through bulk upload is not currently supported.

Formatting:

  • The first line of the  file must be the column headers and must read: "device_id,customer_id,optional_id". You can use semicolons in place of commas, but do not mix the two.
  • All lines must end with a linebreak.
  • For data fields:
    • Device ID and Customer ID are both required.
    • Optional ID is, unsurprisingly, optional.
    • The supported characters are _A-Za-z0-9 (which means no spaces).
    • Each field may contain 4-32 characters.

A Note on Privacy

As always, ensure that the Customer ID and Optional ID do not contain any customer-identifying information, such as phone numbers, addresses, or similar. For more information, see Customer Privacy.

Register and Unregister Devices

You must register devices to fully manage them, but any device configured with the server ACS URL will show up in your inventory. For more detail on how this works, see How Device Management Works.

Register Devices Using Control Center

  1. You have two main options for registration:
    • Device has not yet contacted the server: click the Register Device button.
    • Device is already online and has contacted the server: locate it in inventory by searching for the device ID (serial number), select the device and click the Register button next to the device entry.
  2. Fill in the registration fields:
    • Device ID corresponds to the serial number of the device. If the device has already contacted the server itself, this field will be populated.
    • Customer ID must be linked to an entry in your customer database, but not contain any identifiable information.
    • Optional ID may be used to tie the device to a specific project or other group of devices, but may also not contain any identifiable information.

Note that no ID fields may contain spaces or special characters. Hyphens and underscores are allowed.
The device will be added to inventory, and the Last Contact column will remain empty until the device comes online.

Unregister a Device

Select a device from the Inventory list and click the Unregister button next to the entry to remove:

  • The Customer ID.
  • The Optional ID (if present).

 

How Device Management Works

This is an overview of how device management works in EyeSaaS. For instructions on adding and managing devices, see Register and Delete Devices.

Devices Contact Your Server Using the ACS URL

You must ensure that the ACS URL of your EyeSaaS server instance is present on all devices that you want the server to manage. The device will then contact your server as soon as it comes online.
In many cases, your vendor or reseller will have pre-configured the devices with the ACS URL for you. If this is not the case, there are three main options for adding the URL to a device:
  • The device's own web interface
  • The device's command line interface
  • DHCP Option 43

For instructions, see the documentation for your device and/or DHCP server. The ACS URL must be complete and include the desired protocol--http or https depending on what the device supports.
EyeSaaS does not check for username and password. If the device does not support leaving credentials blank, you can populate these fields with dummy data.
When the device contacts the server, it will show up in your Control Center inventory and in Customer Center.

You Must Register Devices to Manage Them

In order for you to fully manage a device associated with a customer, you must register each device with both a device ID (serial number) and a customer ID on your server.
You can register devices through the Control Center interface, or using systems integrated with the server using Steel API. All devices will show up in inventory regardless of how they were added to the server.
You can register devices before or after they first contact the server.

You Cannot Use Personal Identifiers for Device Management

Registering the device involves tying it to a customer ID (CID). There is also a field called Optional ID that may be used for project identification or similar.
It is important that none of these identifiers contain any kind of personal information.
Use customer IDs that are:

  • Unique to each customer, preferably numeric or alphanumeric.
  • Non-identifiable to anyone without access to your customer database.

Do NOT use potentially identifiable and/or non-unique identifiers such as:

  • Email addresses
  • Usernames
  • Phone numbers or parts of phone numbers

Using identifiable customer IDs or optional IDs is a breach of customer privacy and EyeSaaS terms and conditions.