Orb

Learn how to enrich client statistics in the Live View by connecting to Orb.

If your network infrastructure is connected to Hamina Network Planner with the Live View, and has clients that have Orb installed ("Orbs"), you can connect the Live View with Orb to enrich client details with data from Orb.

Pre-Requisites

To view Orbs in the Live View, you must have:

• An active Hamina Network Planner Plus subscription.

• A project with the Live View enabled (e.g. a Hamina project connected to your network infrastructure).

• An Orb Cloud Business or Orb Cloud Enterprise subscription tier.

• An API key from Orb.

Forging an Orb API Key

1. Log into Orb Cloud.

2. Navigate to the Orchestration tab.

   

3. In the API Keys section, click the New API Key button.

4. In the Create API Key window:

   1. Give the API key a name of your choosing.

   2. Under Organizations, check Read.

   3. Under Devices, check Read and Stream.

   4. Under Datasets, check Write.

5. Click the Create button.

   

6. In the API Keys section, the new key will appear. Click on it to copy it to the clipboard.

Setup

1. Open a project that is already connected to network infrastructure. If you haven't set up the Live View, see Live View (Beta) for more information.

2. In the Projects menu, select the current project, and select Live analysis settings from the menu.

   

3. The Integration Settings window will appear. Click the blue Continue button.

   

4. The Integration Settings window will display the current connected network infrastructure and location settings. At the bottom under Add a connection, paste in your Orb API key, select an Organization, and click the blue Connect button.

   

5. Click the Close button in the upper right to return to the project.

   

Usage

To view the Orb Score or associated statistics from an Orb-equipped client device, activate the Live Clients tool in the toolbar. The View Clients pane will appear, showing all of the clients on the network. Any client equipped with Orb will show an Orb Score.

Select a client with an Orb Score, and the Client Details window will appear on the map next to the client. Note: You might need to zoom out to find the client and associated Client Details window.

As usual, the Client Details window will show statistics from the network infrastructure vendor, but it will be augmented with information from Orb.