Skip to main content

Enroll a Device

Enrolling a device registers it with the Optra portal and makes it available for workflow deployment.

Prerequisites

  • Access to the Optra portal at portal.optra.com
  • Physical access to the device to press the setup button
  • The device's 13-character serial number (starts with 8080, found on the front or bottom of the device)

Steps

  1. Open a web browser and go to portal.optra.com.

  2. Log in to your account.

  3. Click the Devices tab, then click Enroll Device.

  4. Enter the device's 13-character serial number and click Next.

    note

    The 13-character serial number can be found on the front or bottom label of the device. It begins with 8080.

  5. On the physical device, press the setup button to put it into enrollment mode.

    info

    After pressing the setup button, you have 5 minutes to complete enrollment before the window expires. The setup button or its indicator light will blink while the device is in enrollment mode.

  6. Assign a name to the device and optionally set its location from the dropdown.

    tip

    Giving devices descriptive names (e.g., Warehouse-Floor-A1) makes them easier to find and manage later. Device names must be unique within your organization.

    You can also optionally:

    • Create a new location inline by clicking + Add Location
  7. Click Save.

The device will appear in your Devices list once enrollment is complete and the device connects to the portal. Newly enrolled devices show a status of Unknown until the first telemetry report is received.

After enrollment

Once enrolled, you can:


Bulk enrollment via CSV

If you need to enroll many devices at once, you can upload a CSV file instead of enrolling each device individually.

note

Bulk enrollment must be enabled for your organization. Contact your administrator if the option is not visible.

Required CSV columns

ColumnRequiredDescription
serialNumberYes13-character device serial number
nameYesDevice display name (must be unique within the org)

Optional CSV columns

ColumnDescription
workflowNameName of an existing workflow to assign the device to
tagNamesPipe-separated list of tags to apply (e.g., warehouse|floor-a)
locationIdID of an existing location
locationNameName of an existing location (used if locationId is not provided)
latLatitude for a new location
lngLongitude for a new location
addressStreet address for a new location
envJSON-encoded array of environment variable objects (e.g., [{"key":"MY_VAR","value":"hello"}])
firmwareSettingsJSON-encoded array of firmware setting objects

How to bulk enroll

  1. Click the Devices tab, then click the dropdown arrow next to Enroll Device.
  2. Select Bulk Enroll.
  3. Download the CSV template if needed.
  4. Fill in your device data and upload the file.
  5. Review any validation errors or warnings shown before confirming.

The portal processes the CSV and returns a summary of successful enrollments, warnings, and errors.


Enrollment troubleshooting

IssueWhat to do
"Device does not exist"The serial number was not recognized. Double-check the 13-digit number on the device label.
"Device is not claimable"The device is already enrolled in an organization, or the enrollment window expired. Press the setup button again to restart the window.
"Device with the same name already exists"Choose a unique name for this device within your organization.
Device stuck in Unknown statusEnsure the device has power, is connected to the internet, and has completed its first boot. This status clears once the first telemetry report is received.
Enrollment window expiredThe setup window is approximately 5–7 minutes. If it expires before you complete the form, press the setup button on the device again to open a new window.
CSV serial number rejectedBulk enrollment requires exactly 13-character serial numbers. Check the value in the serialNumber column for any extra spaces or truncation.