Skip to content

Commit de28fc6

Browse files
committed
Merge branch 'main' into pr/677
2 parents 77cfd12 + 4fb7d39 commit de28fc6

File tree

492 files changed

+4856
-3314
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

492 files changed

+4856
-3314
lines changed

.github/workflows/azure-static-web-apps-happy-dune-071cbee03.yml

+51-9
Original file line numberDiff line numberDiff line change
@@ -62,6 +62,38 @@ jobs:
6262
output_location: "" # Built app content directory - optional
6363
###### End of Repository/Build Configurations ######
6464

65+
deploy_job_SA_SWA_connectordocs:
66+
if: (github.event_name == 'push' && github.repository == 'SkylineCommunications/dataminer-docs-connectors')
67+
runs-on: ubuntu-latest
68+
needs: build_job
69+
name: Deploy Job to Storage Account with SWA and FD
70+
steps:
71+
- uses: actions/download-artifact@v4
72+
with:
73+
name: release
74+
path: .
75+
- name: Unzip artifact for deployment
76+
run: Expand-Archive -Path _site.zip -DestinationPath ./_site
77+
shell: pwsh
78+
- name: Upload the new files
79+
env:
80+
AZURE_STORAGE_CONNECTION_STRING: ${{ secrets.AZURE_SA_DOCSCONNECTORS_SWA }}
81+
run: |
82+
wget https://aka.ms/downloadazcopy-v10-linux
83+
tar -xvf downloadazcopy-v10-linux
84+
sudo cp ./azcopy_linux_amd64_*/azcopy /usr/bin/
85+
az storage blob sync \
86+
--source _site \
87+
--container '$web'
88+
# - name: Upload the new files
89+
# uses: bacongobbler/azure-blob-storage-upload@main
90+
# with:
91+
# source_dir: _site
92+
# container_name: $web
93+
# connection_string: ${{ secrets.AZURE_SA_DOCSCONNECTORS_SWA }}
94+
# sync: 'true'
95+
96+
6597
deploy_job_Storage_Account:
6698
if: (github.event_name == 'push' && github.repository == 'SkylineCommunications/dataminer-docs-connectors')
6799
runs-on: ubuntu-latest
@@ -81,14 +113,24 @@ jobs:
81113
rm -f ./_site/README.html
82114
find ./_site -name 'toc.html' -type f -delete
83115
- name: Upload the new files
84-
uses: bacongobbler/azure-blob-storage-upload@main
85-
with:
86-
source_dir: _site
87-
container_name: docs-connectors
88-
connection_string: ${{ secrets.AZURE_STORAGE_ACCOUNT_DOCS_CONNECTION_STRING }}
89-
# Sync: true keeps the source and destination in sync,
90-
# otherwise changed files and new would be pushed, but deleted wouldn't be removed.
91-
sync: 'true'
116+
env:
117+
AZURE_STORAGE_CONNECTION_STRING: ${{ secrets.AZURE_STORAGE_ACCOUNT_DOCS_CONNECTION_STRING }}
118+
run: |
119+
wget https://aka.ms/downloadazcopy-v10-linux
120+
tar -xvf downloadazcopy-v10-linux
121+
sudo cp ./azcopy_linux_amd64_*/azcopy /usr/bin/
122+
az storage blob sync \
123+
--source _site \
124+
--container docs-connectors
125+
# - name: Upload the new files
126+
# uses: bacongobbler/azure-blob-storage-upload@main
127+
# with:
128+
# source_dir: _site
129+
# container_name: docs-connectors
130+
# connection_string: ${{ secrets.AZURE_STORAGE_ACCOUNT_DOCS_CONNECTION_STRING }}
131+
# # Sync: true keeps the source and destination in sync,
132+
# # otherwise changed files and new would be pushed, but deleted wouldn't be removed.
133+
# sync: 'true'
92134

93135
reindex_azure_search:
94136
runs-on: ubuntu-latest
@@ -105,4 +147,4 @@ jobs:
105147
# Search indexer to reindex
106148
azure-search-indexer: azureblob-indexer-docs-connectors
107149
# Admin key used to connect to Azure Cognitive Search instance
108-
azure-search-admin-key: ${{ secrets.AZURE_SEARCH_KEY }}
150+
azure-search-admin-key: ${{ secrets.AZURE_SEARCH_KEY }}

.github/workflows/cloud-catalog-connector-docs.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ jobs:
120120
for file in update_docs/*; do
121121
blob_name="$(basename "$file")"
122122
sed -E 's|xref:Connector_help_([^)]*)\)|https://docs.dataminer.services/connector/doc/\1.html)|g' $file
123-
sed -i 's~\~/connector/images/~https://api.dataminer.services/api/public-catalog/v1-0/catalog/images/~g' $file
123+
sed -i 's~\~/connector/images/~https://api.dataminer.services/api/public-catalog/v2-0/catalogs/images/~g' $file
124124
az storage blob upload --file "$file" -c 'docs' -n "$blob_name" --connection-string '${{ secrets.AZUREBLOBSTORAGECS }}' --overwrite 'true'
125125
az storage blob update -c 'docs' -n "$blob_name" --connection-string '${{ secrets.AZUREBLOBSTORAGECS }}' --content-type 'text/plain'
126126
echo $blob_name uploaded

connector/doc/2WCOM_DAB-4c.md

-8
Original file line numberDiff line numberDiff line change
@@ -73,14 +73,6 @@ SNMP Settings:
7373
- **Get community string**: The community string used when reading values from the device (default: *public*).
7474
- **Set community string**: The community string used when setting values on the device (default: *private*).
7575

76-
### Initialization
77-
78-
No extra configuration is needed.
79-
80-
### Redundancy
81-
82-
There is no redundancy defined.
83-
8476
### Web Interface
8577

8678
The web interface is only accessible when the client machine has network access to the product.

connector/doc/2WCOM_FlexDSR04+.md

-8
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ SNMP Settings:
4444
- **Get community string**: The community string used when reading values from the device (default: *public*).
4545
- **Set community string**: The community string used when setting values on the device (default: *private*).
4646

47-
### Initialization
48-
49-
No extra configuration is needed.
50-
51-
### Redundancy
52-
53-
There is no redundancy defined.
54-
5547
### Web Interface
5648

5749
The web interface is only accessible when the client machine has network access to the product.

connector/doc/2WCOM_Flex_DSR02+.md

-8
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ SNMP Settings:
4444
- **Get community string**: The community string used when reading values from the device (default: *public*).
4545
- **Set community string**: The community string used when setting values on the device (default: *private*).
4646

47-
### Initialization
48-
49-
No extra configuration is needed.
50-
51-
### Redundancy
52-
53-
There is no redundancy defined.
54-
5547
### Web Interface
5648

5749
The web interface is only accessible when the client machine has network access to the product.

connector/doc/2WCOM_IP-4C.md

-4
Original file line numberDiff line numberDiff line change
@@ -63,10 +63,6 @@ The connector does not require credentials, so setting it up is rather straightf
6363

6464
The port setting can be found on the General page and is called **Web Interface Port**.
6565

66-
### Redundancy
67-
68-
There is no redundancy defined.
69-
7066
### Web Interface
7167

7268
The web interface is only accessible when the client machine has network access to the product.

connector/doc/2WCOM_MPX-1g.md

-4
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,6 @@ SNMP CONNECTION:
3838
- **IP port**: The IP port of the destination
3939
- **Bus address**: The bus address of the device.
4040

41-
### Redundancy
42-
43-
There is no redundancy defined.
44-
4541
### Web Interface
4642

4743
The web interface is only accessible when the client machine has network access to the product.

connector/doc/2WCOM_MPX-2ds.md

+11-5
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,18 @@ SNMP Settings:
4646
- **Get community string**: The community string used when reading values from the device (default: *public*).
4747
- **Set community string**: The community string used when setting values on the device (default: *private*).
4848

49-
### Web Interface
49+
## Available Data Pages
5050

51-
The web interface is only accessible when the client machine has network access to the product.
51+
- **General**: Includes information on the status of the device, including some general information.
5252

53-
## How to Use
53+
- **Services**: Displays the available services as entries in the table **Services Info**, each representing a decoder channel. Information about each decoder channel will be displayed here.
5454

55-
On the **Polling Config** page, you can configure which polling groups should be polled. By default, they are all disabled.
55+
- **Virtual Tables** subpage: Displays virtual tables, which contain information that is used to build the **Service Info** table on the Services page. The **Virtual Common Audio Decoder Input Sources Ts Demux** table shows which SAT tuner each service uses by displaying "RF1" or "RF2" in the StrInfo column. This affects the **RF Level**, **C/N**, and **TS Sync** values of the **Services Info** table.
5656

57-
The **Virtual Common Audio Decoder Input Sources Ts Demux** table shows which SAT tuner each service uses by displaying "RF1" or "RF2" in the StrInfo column. This impacts the **RF Level**, **C/N**, and **TS Sync** values of the **Service Info** table.
57+
- **Audio Sources**: Contains information and settings for the device's audio sources. At present, RTP is the only available audio source.
58+
59+
- **Settings**: Shows the available settings. Currently, you can configure the SNMP trap destinations and XLR channel routing.
60+
61+
- **Polling Config**: Allows you to configure which polling groups should be polled. By default, they are all disabled.
62+
63+
- **Web Interface**: The device's web interface, which is only accessible when the client machine has network access to the device.

connector/doc/2Wcom_Flex_DRS02+.md

-8
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ SNMP Settings:
4444
- **Get community string**: The community string used when reading values from the device default: *public.*
4545
- **Set community string**: The community string used when setting values on the device default: *private*.
4646

47-
### Initialization
48-
49-
No extra configuration is needed.
50-
51-
### Redundancy
52-
53-
There is no redundancy defined.
54-
5547
### Web Interface
5648

5749
The web interface is only accessible when the client machine has network access to the product.

connector/doc/ABB_Newave_UPS.md

+88
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,88 @@
1+
---
2+
uid: Connector_help_ABB_Newave_UPS
3+
---
4+
5+
# ABB Newave UPS
6+
7+
The connector allows you to monitor and configure the ABB Newave UPS through the USHA+ interface, which obtains the status from a UPS and issues commands to it.
8+
9+
USHA+ supports HTTP and SNMP protocols.
10+
11+
## About
12+
13+
### Version Info
14+
15+
| Range | Features | Based on | System Impact |
16+
|--------------------|-----------------|----------|---------------|
17+
| 1.0.0.x [SLC Main] | Initial version | - | - |
18+
19+
### Product Info
20+
21+
| Range | Supported Firmware |
22+
|---------|--------------------|
23+
| 1.0.0.x | - |
24+
25+
### System Info
26+
27+
| Range | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
28+
|---------|-----------------|---------------------|-------------------|---------------------|
29+
| 1.0.0.x | No | Yes | - | - |
30+
31+
## Configuration
32+
33+
### Connections
34+
35+
#### SNMP Connection
36+
37+
This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
38+
39+
SNMP CONNECTION:
40+
41+
- **IP address/host**: The polling IP or URL of the destination.
42+
- **IP port**: The IP port of the destination.
43+
- **Bus address**: The bus address of the device.
44+
45+
SNMP Settings:
46+
47+
- **Get community string**: The community string used when reading values from the device (default: *public*).
48+
- **Set community string**: The community string used when setting values on the device (default: *private*).
49+
50+
### Web Interface
51+
52+
The web interface is only accessible when the client machine has network access to the product.
53+
54+
## How to use
55+
56+
SNMP is used to retrieve the device information. To see the actual traffic between the element and the device, a built-in DataMiner tool called Stream Viewer can be used. You can access it by right-clicking the element in the Surveyor and selecting **View** > **Stream Viewer**.
57+
58+
Below, you can find an overview of the available data pages.
59+
60+
### General
61+
62+
This page contains general information about the UPS, such as the name, manufacturer, model, etc.
63+
64+
### UPS Unit Summary
65+
66+
This page contains information about the UPS battery, such as **Battery Status**, **Battery Runtime Remaining**, **Battery Temperature**, etc.
67+
68+
On the subpages, more information is available on the UPS battery, output, and input.
69+
70+
### UPS Global Configuration
71+
72+
This page allows you to configure various settings for the UPS, such as the **UPS Input voltage**, **UPS Input Frequency**, etc.
73+
74+
### Global UPS Shutdown Control
75+
76+
On this page, you can configure the shutdown settings: **UPS Shutdown Type**, **UPS Shutdown After Delay**, **UPS Auto Restart**, etc.
77+
78+
### UPS Battery Test
79+
80+
This page shows battery test information, such as **UPS Test Results Summary**, **UPS Test Start Time**, **UPS Test Elapsed Time**, etc.
81+
82+
### UPS Bypass
83+
84+
This page shows the **UPS Bypass Frequency**, **UPS Bypass Table**, and **UPS Bypass Number of Lines**.
85+
86+
### Global Alarm Table
87+
88+
This page shows the number of alarms present, as well as a table with additional details for each alarm.

connector/doc/ADB_3000.md

-8
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,6 @@ SNMP Settings:
6262
- **Get community string**: The community string used when reading values from the device (default: *public*).
6363
- **Set community string**: The community string used when setting values on the device (default: *private*).
6464

65-
### Initialization
66-
67-
No extra configuration is needed.
68-
69-
### Redundancy
70-
71-
There is no redundancy defined.
72-
7365
### Web Interface
7466

7567
The web interface is only accessible when the client machine has network access to the product.

connector/doc/ADVA_Optical_Networking_FSP_Network_Manager.md

-8
Original file line numberDiff line numberDiff line change
@@ -44,14 +44,6 @@ SNMP Settings:
4444
- **Get community string**: The community string used when reading values from the device (default: *public*).
4545
- **Set community string**: The community string used when setting values on the device (default: *private*).
4646

47-
### Initialization
48-
49-
No extra configuration is needed.
50-
51-
### Redundancy
52-
53-
There is no redundancy defined.
54-
5547
### Web Interface
5648

5749
The web interface is only accessible when the client machine has network access to the product.

connector/doc/ADVA_Optical_Networking_OSA_5422.md

-8
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ SNMP Settings:
4545
- **Get community string**: The community string used when reading values from the device (default: *public*).
4646
- **Set community string**: The community string used when setting values on the device (default: *private*).
4747

48-
### Initialization
49-
50-
No extra configuration is needed.
51-
52-
### Redundancy
53-
54-
There is no redundancy defined.
55-
5648
### Web Interface
5749

5850
The web interface is only accessible when the client machine has network access to the product.

connector/doc/AETA_AUDIO_SYSTEMS_MultiScoop_AES67.md

-8
Original file line numberDiff line numberDiff line change
@@ -58,14 +58,6 @@ SNMP Settings:
5858
- **Get community string**: The community string used when reading values from the device (default: *public*).
5959
- **Set community string**: The community string used when setting values on the device (default: *private*).
6060

61-
### Initialization
62-
63-
No extra configuration is needed.
64-
65-
### Redundancy
66-
67-
There is no redundancy defined.
68-
6961
### Web Interface
7062

7163
The web interface is only accessible when the client machine has network access to the product.

connector/doc/AMWA_NMOS_IS-04_Registry.md

+1-9
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,6 @@ HTTP CONNECTION:
4242
- **IP port**: The IP port of the destination.
4343
- **Device address**: The bus address of the device. If the proxy server has to be bypassed, specify *BypassProxy*.
4444

45-
### Initialization
46-
47-
No extra configuration is needed.
48-
49-
### Redundancy
50-
51-
There is no redundancy defined.
52-
5345
## How to use
5446

55-
Set Element configurations. Websockets will be open in run time.
47+
Set element configurations. Websockets will be open at runtime.

connector/doc/APA_Sound_Monitoring.md

-4
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,6 @@ HTTP CONNECTION:
3939
- **IP address/host**: The polling IP or URL of the destination.
4040
- **IP port**: The IP port of the destination, default: *80.*
4141

42-
### Redundancy
43-
44-
There is no redundancy defined.
45-
4642
## How to Use
4743

4844
### General page

connector/doc/APC_NetBotz_200.md

-8
Original file line numberDiff line numberDiff line change
@@ -45,14 +45,6 @@ SNMP Settings:
4545
- **Get community string**: The community string used when reading values from the device (default: *public*).
4646
- **Set community string**: The community string used when setting values on the device (default: *private*).
4747

48-
### Initialization
49-
50-
No extra configuration is needed.
51-
52-
### Redundancy
53-
54-
There is no redundancy defined.
55-
5648
### Web Interface
5749

5850
The web interface is only accessible when the client machine has network access to the product.

0 commit comments

Comments
 (0)