Skip to content

Commit 411ba28

Browse files
committed
Updated the driver doc to follow the new guidelines
1 parent cd12e04 commit 411ba28

File tree

3 files changed

+65
-38
lines changed

3 files changed

+65
-38
lines changed

connector/doc/Skyline_Table_Checker.md

+19-38
Original file line numberDiff line numberDiff line change
@@ -4,58 +4,39 @@ uid: Connector_help_Skyline_Table_Checker
44

55
# Skyline Table Checker
66

7-
This connector will search through the elements with the corresponding protocol on the DataMiner System and look for entries in the desired table based on the configuration parameters set by the user.
8-
97
## About
108

11-
### Version Info
12-
13-
| Range | Key Features | Based on | System Impact |
14-
|----------------------|------------------|--------------|-------------------|
15-
| 1.0.0.x [SLC Main] | Initial version | - | - |
16-
17-
### Product Info
18-
19-
| Range | Supported Firmware |
20-
|-----------|------------------------|
21-
| 1.0.0.x | - |
9+
This connector will search through the elements with the corresponding protocol on the DataMiner System and look for entries in the desired table based on the configuration parameters set by the user.
2210

23-
### System Info
11+
### Key Features
2412

25-
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
26-
|-----------|---------------------|-------------------------|-----------------------|-------------------------|
27-
| 1.0.0.x | No | Yes | - | - |
13+
- **Automated Table Checks**: Periodically scans tables based on a configurable update interval (default: 30 minutes).
14+
- **Detailed Check Results**: Provides a comprehensive table with information about checked elements, including protocol name, table and column IDs, match status, and instance counts.
15+
- **Regex-Based Filtering**: Supports an *Optional Element Name Regex Filter* to refine element searches for more precise results.
2816

29-
## Configuration
17+
## Use Cases
3018

31-
### Connections
19+
### Proactive System Monitoring
3220

33-
#### Virtual connection
21+
**Challenge:** Ensuring that critical table entries (e.g., device status, service configurations) exist and remain updated.
3422

35-
This connector uses a virtual connection and does not require any input during element creation.
23+
**Solution:** The connector automatically checks specified tables at a set interval, verifying if key entries are present and up to date.
3624

37-
## How to use
25+
**Benefit:** Provides real-time visibility into the system’s health.
3826

39-
### General
27+
### Troubleshooting & Diagnostics
4028

41-
The **General** page includes several key parameters:
29+
**Challenge:** Finding the root cause of missing or incorrect entries often requires manual effort.
4230

43-
- **Update Interval** - Determines how often table checks are performed. The default interval is *30 minutes*.
44-
- **Execute Checks Now** - Button to trigger immediate check instead of waiting for the update interval.
45-
- **Table Checker Last Update** - Displays the timestamp of the most recent table check.
46-
- **Check Results** - A table that provides details on the checked entries, including the element and protocol name, table and column ID, whether the entry was found, and the number of instances found. These entries are configured in the *Configuration of Checks* table on the **Configuration** Page.
31+
**Solution:** The tool quickly scans tables to identify missing values, incorrect mappings, or unexpected data changes.
4732

48-
### Configuration
33+
**Benefit:** Speeds up troubleshooting by instantly detecting configuration issues.
4934

50-
The **Configuration** page allows users to define and manage the table checks by specifying key parameters for each test.
35+
## Prerequisites
5136

52-
**Configuration of Checks** table contains the following columns:
37+
- **DataMiner version 10.3 or higher** is required.
5338

54-
- *Test Name* – The name of the check.
55-
- *Protocol Name* – The protocol name which acts as a filter to filter only the elements using it.
56-
- *Optional Element Name Regex Filter* – A regular expression filter to refine the element name search.
57-
- *Table PID* – The unique identifier for the table being checked.
58-
- *Column ID* – The specific column within the table being checked.
59-
- *Text to Search On* – The text pattern used to find matches within the column.
39+
## Technical Information
6040

61-
The **Update Result Table** button refreshes the results based on the defined checks.
41+
> [!NOTE]
42+
> For detailed technical information, refer to our [technical documentation](xref:Connector_help_Skyline_Table_Checker_Technical).
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
---
2+
uid: Connector_help_Skyline_Table_Checker_Technical
3+
---
4+
5+
# Skyline Table Checker
6+
7+
## About
8+
9+
This connector will search through the elements with the corresponding protocol on the DataMiner System and look for entries in the desired table based on the configuration parameters set by the user.
10+
11+
## Configuration
12+
13+
### Connections
14+
15+
#### Virtual connection
16+
17+
This connector uses a virtual connection and does not require any input during element creation.
18+
19+
## How to use
20+
21+
### General
22+
23+
The **General** page includes several key parameters:
24+
25+
- **Update Interval** - Determines how often table checks are performed. The default interval is *30 minutes*.
26+
- **Execute Checks Now** - Button to trigger immediate check instead of waiting for the update interval.
27+
- **Table Checker Last Update** - Displays the timestamp of the most recent table check.
28+
- **Check Results** - A table that provides details on the checked entries, including the element and protocol name, table and column ID, whether the entry was found, and the number of instances found. These entries are configured in the *Configuration of Checks* table on the **Configuration** Page.
29+
30+
### Configuration
31+
32+
The **Configuration** page allows users to define and manage the table checks by specifying key parameters for each test.
33+
34+
**Configuration of Checks** table contains the following columns:
35+
36+
- *Test Name* – The name of the check.
37+
- *Protocol Name* – The protocol name which acts as a filter to filter only the elements using it.
38+
- *Optional Element Name Regex Filter* – A regular expression filter to refine the element name search.
39+
- *Table PID* – The unique identifier for the table being checked.
40+
- *Column ID* – The specific column within the table being checked.
41+
- *Text to Search On* – The text pattern used to find matches within the column.
42+
43+
The **Update Result Table** button refreshes the results based on the defined checks.

connector/toc.yml

+3
Original file line numberDiff line numberDiff line change
@@ -8234,6 +8234,9 @@
82348234
topicUid: Connector_help_Skyline_Synthetic_Test_-_Ping
82358235
- name: Skyline Table Checker
82368236
topicUid: Connector_help_Skyline_Table_Checker
8237+
items:
8238+
- name: Skyline Table Checker Technical
8239+
topicUid: Connector_help_Skyline_Table_Checker_Technical
82378240
- name: Skyline Universal Weather
82388241
topicUid: Connector_help_Skyline_Universal_Weather
82398242
- name: Skyline VOD Workflow Application

0 commit comments

Comments
 (0)