Skip to content

Commit fdc8583

Browse files
committed
Created help page for Generic Logger Table
1 parent 8e2b306 commit fdc8583

File tree

2 files changed

+43
-0
lines changed

2 files changed

+43
-0
lines changed

connector/doc/Generic_Logger_Table.md

+41
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
uid: Connector_help_Generic_Logger_Table
3+
---
4+
5+
# Generic Logger Table
6+
7+
The **Generic Logger Table** is a virtual connector that allows DataMiner solutions to interact directly with a table in the underlying database.
8+
9+
## About
10+
11+
Every element using this connector will have its own unique table in the database. The connector handles incoming CRUD operations and automatic cleanup.
12+
13+
### Version Info
14+
15+
| **Range** | **Description** | **DCF Integration** | **Cassandra Compliant** |
16+
|------------------|------------------------|---------------------|-------------------------|
17+
| 1.0.0.x | Initial version | No | Yes |
18+
19+
## Configuration
20+
21+
### Virtual Connection - Main
22+
23+
This connector uses a virtual connection and does not require any input during element creation.
24+
25+
### Initialization
26+
27+
As soon as an element is created, it automatically generates a new table in the database.
28+
29+
The amount of time that each record is stored in the table can be adjusted using the *Remove Unmodified Entries After* parameter. By default this is set to 30 days. It is available on the General page of the element.
30+
31+
## How to Use
32+
33+
Manipulating the data handled by the element is done using the [Skyline.DataMiner.ConnectorAPI.GenericLoggerTable NuGet package](https://github.com/SkylineCommunications/Skyline.DataMiner.ConnectorAPI.GenericLoggerTable). This package is typically used from Automation scripts, but it can also be used from Connectors.
34+
35+
### Supported Operations
36+
37+
The connector and NuGet package support the typical CRUD operations; creating, replacing, updating and removing records.
38+
39+
### Use Case
40+
41+
The typical use case for this connector is to store large pieces of data that doesn't need to be directly accessible from Cube. As such, there is no way to monitor the data.

connector/toc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -4055,6 +4055,8 @@
40554055
topicUid: Connector_help_Generic_KAFKA_Consumer
40564056
- name: Generic KAFKA Producer
40574057
topicUid: Connector_help_Generic_KAFKA_Producer
4058+
- name: Generic Logger Table
4059+
topicUid: Connector_help_Generic_Logger_Table
40584060
- name: Generic Mail Sender
40594061
topicUid: Connector_help_Generic_Mail_Sender
40604062
- name: Generic Manager Channel Distribution

0 commit comments

Comments
 (0)