From 5fe83f4e29967026347b355c55b35dff90c3586b Mon Sep 17 00:00:00 2001 From: Joachim Ally Date: Thu, 2 Jan 2025 10:45:34 +0100 Subject: [PATCH 1/3] Update Connector Documentation to new major range --- connector/doc/Starlink_Enterprise.md | 19 +++++++++++++++++-- ...rise_UserTerminalsRelationships.drawio.svg | 4 ++++ 2 files changed, 21 insertions(+), 2 deletions(-) create mode 100644 connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg diff --git a/connector/doc/Starlink_Enterprise.md b/connector/doc/Starlink_Enterprise.md index d1bedfc5..0e0d6948 100644 --- a/connector/doc/Starlink_Enterprise.md +++ b/connector/doc/Starlink_Enterprise.md @@ -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 | - | ### Product Info @@ -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. @@ -137,7 +144,15 @@ As the Telemetry API does not always return the routers consistently, the connec 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 diff --git a/connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg b/connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg new file mode 100644 index 00000000..2153d41a --- /dev/null +++ b/connector/images/Starlink_Enterprise_UserTerminalsRelationships.drawio.svg @@ -0,0 +1,4 @@ + + + +
User Terminals
🔑 User Terminal Device ID
🔑 Service Line Number
Alerts
Routers
IP Allocations
Services
Overage Lines
Monthly Data Usage
Daily Data Usage
Device Name 🖋️
 \ No newline at end of file From 127fab4e638ec14e0220a8a98716695150437c1a Mon Sep 17 00:00:00 2001 From: Joachim Ally <121804974+Joachim-Ally-Skyline@users.noreply.github.com> Date: Fri, 3 Jan 2025 09:27:34 +0100 Subject: [PATCH 2/3] Update Starlink_Enterprise.md --- connector/doc/Starlink_Enterprise.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/connector/doc/Starlink_Enterprise.md b/connector/doc/Starlink_Enterprise.md index 0e0d6948..a8f3c560 100644 --- a/connector/doc/Starlink_Enterprise.md +++ b/connector/doc/Starlink_Enterprise.md @@ -27,7 +27,7 @@ The Starlink Enterprise connector was previously known as the Starlink Telemetry | Range | Key Features | Based on | System Impact | |--------------------|-----------------|--------------------------------|---------------| | 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 | - | +| 1.0.1.x [SLC Main] | Version with standardized foreign keys | Starlink Enterprise 1.0.0.16 | Foreign key parameters have been renamed, this impacts Automation Scripts that get a parameter of this protocol by name. | ### Product Info From cd0ea10b1618395b7008cf1e27de8325b258c047 Mon Sep 17 00:00:00 2001 From: Marieke Goethals Date: Tue, 7 Jan 2025 13:57:18 +0100 Subject: [PATCH 3/3] Update Starlink_Enterprise.md --- connector/doc/Starlink_Enterprise.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/connector/doc/Starlink_Enterprise.md b/connector/doc/Starlink_Enterprise.md index a8f3c560..82202a5e 100644 --- a/connector/doc/Starlink_Enterprise.md +++ b/connector/doc/Starlink_Enterprise.md @@ -27,7 +27,7 @@ The Starlink Enterprise connector was previously known as the Starlink Telemetry | Range | Key Features | Based on | System Impact | |--------------------|-----------------|--------------------------------|---------------| | 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, this impacts Automation Scripts that get a parameter of this protocol by name. | +| 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 @@ -124,7 +124,7 @@ User terminal DVEs can only be removed if the DVE Creation column contains a val #### 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. +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) @@ -140,19 +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 **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_. +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. +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. +The **User Terminal Device ID** column contains the reference to the device ID of the user terminal. ### Services Page