Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Starlink Enterprise Connector Documentation to new major range #628

Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 18 additions & 3 deletions connector/doc/Starlink_Enterprise.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ The Starlink Enterprise connector was previously known as the Starlink Telemetry

| Range | Key Features | Based on | System Impact |
|--------------------|-----------------|--------------------------------|---------------|
| 1.0.0.x [SLC Main] | Initial version | Starlink Telemetry API 1.0.0.4 | - |
| 1.0.0.x [Obsolete] | Initial version | Starlink Telemetry API 1.0.0.4 | - |
| 1.0.1.x [SLC Main] | Version with standardized foreign keys | Starlink Enterprise 1.0.0.16 | Foreign key parameters have been renamed, which impacts Automation scripts that retrieve a parameter of this protocol by name. |

### Product Info

Expand Down Expand Up @@ -121,6 +122,12 @@ To **remove a DVE**:

User terminal DVEs can only be removed if the DVE Creation column contains a value other than *Enabled*. User terminals for which a dynamic virtual element was created will not be removed automatically if they are no longer returned by the API for more than one day and have DVE Creation set to *Enabled*.

#### Relations to other tables

The data retrieved and stored in the different tables can be linked to each other. For the hardware-related information, this is with the column **User Terminal Device ID**, while for the more service-related data, the **Service Line Number** is used.

![Relations between tables](~/connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg)

### Alerts Page

Each row in the **Alerts** table represents an alert that comes from a user terminal (not from a router). Alerts will persist for as long as they are active.
Expand All @@ -133,11 +140,19 @@ Information related to routers is stored in the **Routers** table.

The **Account Number** column in this table is hidden by default. You can show it by right-clicking the table column header, selecting **Columns**, and then selecting this column.

As the Telemetry API does not always return the routers consistently, the connector will keep the routers that are no longer returned by the API in the table for maximum one day. When the **Info Logging Level** of the element log file is raised to *Level 1* or higher, you will see a line in the log file when one or more routers are still in the table but were not returned by the API.
As the Telemetry API does not always return the routers consistently, the connector will keep the routers that are no longer returned by the API in the table for at most one day. When the **Info Logging Level** of the element log file is raised to *Level 1* or higher, you will see a line in the log file when one or more routers are still in the table but were not returned by the API.

Routers that are no longer returned by the API for more than one day will be removed from the table. This action can also be logged in the element log file. The **Timestamp** column is used to determine the latest timestamp of when a row was updated.

The **Dish ID** column contains the router dish ID, which is linked to the **Device ID** column from the User Terminals table.
The **User Terminal Device ID** column contains the reference to the Device ID of the user terminal. In the API, this is referred to as the **Router Dish ID**.

### IP Allocations Page

Information related to IP allocations is stored in the **IP Allocations** table.

The **IP Allocation Device ID** column in this table is hidden by default. You can show it by right-clicking the table column header, selecting **Columns**, and then selecting this column.

The **User Terminal Device ID** column contains the reference to the device ID of the user terminal.

### Services Page

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.