Skip to content

Commit 196902a

Browse files
authored
Merge pull request SkylineCommunications#628 from Joachim-Ally-Skyline/UpdateStarlinkEnterpriseConnectorDoc
Update Starlink Enterprise Connector Documentation to new major range
2 parents a0bcce6 + cd0ea10 commit 196902a

File tree

2 files changed

+22
-3
lines changed

2 files changed

+22
-3
lines changed

connector/doc/Starlink_Enterprise.md

+18-3
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ The Starlink Enterprise connector was previously known as the Starlink Telemetry
2626

2727
| Range | Key Features | Based on | System Impact |
2828
|--------------------|-----------------|--------------------------------|---------------|
29-
| 1.0.0.x [SLC Main] | Initial version | Starlink Telemetry API 1.0.0.4 | - |
29+
| 1.0.0.x [Obsolete] | Initial version | Starlink Telemetry API 1.0.0.4 | - |
30+
| 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. |
3031

3132
### Product Info
3233

@@ -121,6 +122,12 @@ To **remove a DVE**:
121122

122123
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*.
123124

125+
#### Relations to other tables
126+
127+
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.
128+
129+
![Relations between tables](~/connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg)
130+
124131
### Alerts Page
125132

126133
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.
@@ -133,11 +140,19 @@ Information related to routers is stored in the **Routers** table.
133140

134141
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.
135142

136-
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.
143+
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.
137144

138145
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.
139146

140-
The **Dish ID** column contains the router dish ID, which is linked to the **Device ID** column from the User Terminals table.
147+
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**.
148+
149+
### IP Allocations Page
150+
151+
Information related to IP allocations is stored in the **IP Allocations** table.
152+
153+
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.
154+
155+
The **User Terminal Device ID** column contains the reference to the device ID of the user terminal.
141156

142157
### Services Page
143158

connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg

+4
Loading

0 commit comments

Comments
 (0)