# 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 Orb Scores and latency measurements.

## 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](https://docs.hamina.com/hamina/live/live-view)).
* An [Orb Cloud Business](https://orb.net/plans/business) or [Orb Cloud Enterprise](https://orb.net/plans/enterprise) subscription tier.
* An API key from Orb.

## Setup

### Forge an Orb API Key

1. Log into [Orb Cloud](https://orb.cloud.net/).

2. Navigate to the **Orchestration** tab.<br>

   <div align="left"><figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FEdEHDnt5W50DjPPflDVM%2Forchestration.png?alt=media&#x26;token=fa048057-4c6d-4c2d-8227-92d4dba7f102" alt="" width="563"><figcaption></figcaption></figure></div>

3. In the **API Keys** section, click the **New API Key** button.<br>

4. In the **Create API Key** window:
   1. Give the API key a name of your choosing.&#x20;
   2. Check all of the options under **Scopes:**
      1. Under **Organizations**, check **Read**.
      2. Under **Devices**, check **Read**, **Stream**, and **Speedtest**.
      3. Under **Datasets**, check **Write**.<br>

5. Click the **Create** button.<br>

   <div align="left"><figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2Ftq1nH7dju9EI5um8IhKC%2Forb-api-key.png?alt=media&#x26;token=05a47640-fab8-477a-8c9d-5e0c355d6139" alt="" width="375"><figcaption></figcaption></figure></div>

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

### Enable Identifiable Data

To integrate with Hamina, Orb requires additional identifiable information (such as a MAC address) to match Orb clients with clients in the network infrastructure. This must be enabled in Orb.

1. Visit the **Orchestration** page.

2. Click the elipsis (...) menu next to your Configuration profile, and select **Edit**.<br>

   <div align="left"><figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FJTAn6NsiIbc8mPW0UnPy%2Fedit-configuration.png?alt=media&#x26;token=352cd83c-0ae7-45ca-90c3-bd9e52dd71a0" alt="" width="375"><figcaption></figcaption></figure></div>

3. In the **Edit configuration** window, click on the **Advanced** tab.

4. Add the following to the JSON configuration, and then click **Save & Apply**.<br>

   ```
   {
       "orb.identifiable_level": [
       ]
   }
   ```

   <div align="left"><figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FN2d79Jy4xQM2Cqcbot3O%2Fedit-config-window.png?alt=media&#x26;token=1482f48c-b1ee-40a3-b322-faa87881ef14" alt="" width="375"><figcaption></figcaption></figure></div>

### Setup Orb in Hamina

1. Open a project that is already connected to network infrastructure. If you haven't set up the Live View, see [live-view](https://docs.hamina.com/hamina/live/live-view "mention") for more information.

2. In the **Projects** menu, select the current project, and select **Live analysis settings** from the menu.<br>

   <div align="left"><figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FS02XTb9Hojn0rb879UjZ%2Flive-analysis-settings.png?alt=media&#x26;token=c39c69d2-e60f-4252-ba04-7e8aa1b3ae36" alt="" width="375"><figcaption></figcaption></figure></div>

3. The **Integration Settings** window will appear. Click the blue **Continue** button.<br>

   <figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FQs0WanPr4aedl0u4QIZr%2Fintegration-settings.png?alt=media&#x26;token=a1ea1e02-530e-4225-bd60-8035d26a2600" alt=""><figcaption></figcaption></figure>

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.<br>

   <figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FFwdhXJWJY8TOOEozMjOG%2Forb-api-key.png?alt=media&#x26;token=caeab742-5e0e-4714-9890-809fa46a0d8e" alt=""><figcaption></figcaption></figure>

5. Click the **Close** button in the upper right to return to the project.<br>

   <figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FoE9BCLq7TE5jqtQlwSeH%2Forb-connected.png?alt=media&#x26;token=139e87ec-b6fa-41b9-9895-065ae7e71279" alt=""><figcaption></figcaption></figure>

## 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. *<mark style="color:blue;background-color:blue;">Note: You might need to zoom out to find the client and associated Client Details window</mark><mark style="color:blue;background-color:blue;">**.**</mark>*

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

<figure><img src="https://1547340717-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FzUQ3TfKTYBeb6nf9W8Hv%2Fuploads%2FYE4e4gbEy65rsulXSRux%2Forb-score.png?alt=media&#x26;token=bb3d7257-1df8-4a0e-88c2-5145ffd5e9e7" alt=""><figcaption></figcaption></figure>
