Merge branch 'SkylineCommunications:main' into main

jwoSkyline · Mar 5, 2024 · 35391e4 · 35391e4
2 parents 568b758 + d6776b6
commit 35391e4
Show file tree

Hide file tree

Showing 101 changed files with 1,789 additions and 12,788 deletions.
diff --git a/.github/workflows/cloud-catalog-connector-docs.yml b/.github/workflows/cloud-catalog-connector-docs.yml
@@ -119,7 +119,7 @@ jobs:
           inlineScript: |
             for file in update_docs/*; do
               blob_name="$(basename "$file")"
-              sed -i 's~\~/connector/images/~/api/public-catalog/v1-0/catalog/images/~g' $file
+              sed -i 's~\~/connector/images/~https://api.dataminer.services/api/public-catalog/v1-0/catalog/images/~g' $file
               az storage blob upload --file "$file" -c 'docs' -n "$blob_name" --connection-string '${{ secrets.AZUREBLOBSTORAGECS }}' --overwrite 'true'
               az storage blob update -c 'docs' -n "$blob_name" --connection-string '${{ secrets.AZUREBLOBSTORAGECS }}' --content-type 'text/plain'
               echo $blob_name uploaded

diff --git a/connector/doc/2WCOM_MPX-2ds.md b/connector/doc/2WCOM_MPX-2ds.md
@@ -0,0 +1,55 @@
+---
+uid: Connector_help_2WCOM_MPX-2ds
+---
+
+# 2WCOM MPX-2ds
+
+The MPX-2ds is a two-channel decoder designed for MPX distribution via satellite or IP.
+
+The 2WCOM MPX-2ds connector's main purpose is to monitor the two channels of the decoder.
+
+## About
+
+### Version Info
+
+| Range              | Features        | Based on | System Impact |
+|--------------------|-----------------|----------|---------------|
+| 1.0.0.x [SLC Main] | Initial version | -        | -             |
+
+### Product Info
+
+| Range   | Supported Firmware |
+|---------|--------------------|
+| 1.0.0.x | 1.24               |
+
+### System Info
+
+| Range   | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
+|---------|-----------------|---------------------|-------------------|---------------------|
+| 1.0.0.x | No              | Yes                 | -                 | -                   |
+
+## Configuration
+
+### Connections
+
+#### SNMP Connection
+
+This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
+
+SNMP CONNECTION:
+
+- **IP address/host**: The polling IP or URL of the destination.
+- **IP port**: The IP port of the destination (default: *161*).
+
+SNMP Settings:
+
+- **Get community string**: The community string used when reading values from the device (default: *public*).
+- **Set community string**: The community string used when setting values on the device (default: *private*).
+
+### Web Interface
+
+The web interface is only accessible when the client machine has network access to the product.
+
+## How to Use
+
+On the **Polling Config** page, you can configure which polling groups should be polled. By default, they are all disabled.
diff --git a/connector/doc/Akamai_CDN_Manager.md b/connector/doc/Akamai_CDN_Manager.md
@@ -22,9 +22,9 @@ Akamai is a **C**ontent **D**elivery **N**etwork services provider. This connect
 
 ### System Info
 
-| Range     | DCF Integration     | Cassandra Compliant     | Linked Components     | Exported Components     |
-|-----------|---------------------|-------------------------|-----------------------|-------------------------|
-| 1.0.0.x   | No                  | Yes                     | -                     | -                       |
+|Range  |DCF Integration  |Cassandra Compliant  |Linked Components  |Exported Components   |
+|---------|---------|---------|---------|---------|
+|1.0.0.x    |No       |Yes         |-         |[Akamai CDN Manager - CP Code](xref:Connector_help_Akamai_CDN_Manager_-_CP_Code)   |
 
 ## Configuration
 
@@ -51,8 +51,10 @@ If a connection has been established, data will be displayed on the following pa
 - **Contracts**: Displays the Contracts table.
 - **Groups**: Displays the Groups table.
 - **CP Codes**: Displays the CP Codes table.
-- **Traffic Per CP Code**: Displays the Traffic per CP code table.
+- **Network Storage**: Displays the storage groups and associated upload accounts.
+- **Traffic**: Displays the Traffic per CP code table.
 - **Structure Overview**: Contains the Structure Overview tree control.
+- **Media Services Live**: Displays a list of all streams.
 - **Alert Summaries**: Displays the Alert Summaries table.
 - **Alert Details**: Displays the Alert Details table.
 - **Alert Overview**: Displays the relationship between the Alert Summaries and Alert Details tables.
diff --git a/connector/doc/Akamai_CDN_Manager_-_CP_Code.md b/connector/doc/Akamai_CDN_Manager_-_CP_Code.md
@@ -0,0 +1,29 @@
+---
+uid: Connector_help_Akamai_CDN_Manager_-_CP_Code
+---
+
+# Akamai CDN Manager - CP Code
+
+This connector is automatically generated by the **Akamai CDN Manager** of range 1.0.0.x.
+
+This connector displays the traffic information of a given CP code managed by the parent Akamai CDN Manager connector.
+
+## About
+
+### Product Info
+
+| Range     | Supported Firmware     |
+|-----------|------------------------|
+| 1.0.0.x   | -                      |
+
+## Configuration
+
+### Creation
+
+This connector is automatically created by the parent connector [Akamai CDN Manager](xref:Connector_help_Akamai_CDN_Manager) from range 1.0.0.x onwards.
+
+## How to use
+
+This connector only has one page.
+
+The **General** page displays all the traffic hits received by a specified CP Code. This information corresponds to the **Traffic per CP Code** table in the parent element.
diff --git a/connector/doc/Alea_MCxPTT.md b/connector/doc/Alea_MCxPTT.md
@@ -0,0 +1,60 @@
+---
+uid: Connector_help_Alea_MCxPTT
+---
+
+# Alea MCxPTT
+
+Alea MCxPTT is a system that guarantees immediate communication services and makes it possible to decide, disclose information, and effectively carry out mission-critical tasks.
+
+This connector can be used to consult the service alarms of this system.
+
+## About
+
+### Version Info
+
+| Range              | Key Features    | Based on | System Impact |
+|--------------------|-----------------|----------|---------------|
+| 1.0.0.x [SLC Main] | Initial version | -        | -             |
+
+### Product Info
+
+| Range     | Supported Firmware     |
+|-----------|------------------------|
+| 1.0.0.x   | -                      |
+
+### System Info
+
+| Range     | DCF Integration     | Cassandra Compliant     | Linked Components     | Exported Components     |
+|-----------|---------------------|-------------------------|-----------------------|-------------------------|
+| 1.0.0.x   | No                  | Yes                     | -                     | -                       |
+
+## Configuration
+
+### Connections
+
+#### SNMP Connection
+
+This connector uses a Simple Network Management Protocol (SNMP) connection and requires the following input during element creation:
+
+SNMP CONNECTION:
+
+- **IP address/host**: The polling IP or URL of the destination.
+- **IP port**: The IP port of the destination.
+- **Bus address**: The bus address of the device.
+
+SNMP Settings:
+
+- **Get community string**: The community string used when reading values from the device (default: *public*).
+- **Set community string**: The community string used when setting values on the device (default: *private*).
+
+### Web Interface
+
+The web interface is only accessible when the client machine has network access to the product.
+
+## How to use
+
+The **General** page displays the system information.
+
+The **Alarms** page displays the list of services available in the MCxPTT system and their alarm status.
+
+On the **Polling** page, you can define the frequency of the polling groups.
diff --git a/connector/doc/AmagiCLOUDPORTServiceManager.md b/connector/doc/AmagiCLOUDPORTServiceManager.md
@@ -0,0 +1,59 @@
+---
+uid: Connector_help_Amagi_Cloudport_Service_Manager
+---
+
+# Amagi CLOUDPORT Service Manager
+
+The Amagi CLOUDPORT Service Manager is a playout server that manages broadcast or OTT channels over IP, satellite, and FAST OTT platforms.
+
+## About
+
+### Version Info
+
+| Range              | Key Features     | Based on | System Impact |
+|--------------------|------------------|----------|---------------|
+| 1.0.0.x [SLC Main] | Initial version. | -        | -             |
+
+### Product Info
+
+| Range   | Supported Firmware |
+|---------|--------------------|
+| 1.0.0.x | -                  |
+
+### System Info
+
+| Range   | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
+|---------|-----------------|---------------------|-------------------|---------------------|
+| 1.0.0.x | No              | Yes                 | -                 | -                   |
+
+## Configuration
+
+### Connections
+
+#### HTTP Connection
+
+This connector uses an HTTP connection and requires the following input during element creation:
+
+HTTP CONNECTION:
+
+- **IP address/host**: The polling IP of the device.
+- **IP port**: The IP port of the device, by default *443*.
+- **Device address**: The device address, by default *ByPassProxy*.
+
+### Initialization
+
+Specify the **Username** and **Password** on the **General** page. The connector will automatically send requests using these credentials and will report the response code in the **HTTP Request Status** parameter.
+
+### Web Interface
+
+The web interface is only accessible when the client machine has network access to the product.
+
+## How to use
+
+The element created using this connector has the following data pages:
+
+- **General**: This page displays general information such as the **Customer Name** and **Health Status**. You can also specify the **Username** and **Password** here.
+- **Service Monitor**: This page displays the **Cloudport Services** table.
+- **Cloudport Control**: This page contains various switchover-related parameters as well as the **Switchover** and **Fix** buttons and the **Poll Switchover Status Flag**. The flag will remain active from the moment a switchover starts until it is complete.
+- **Logging**: This page contains the **Incident History Logs** table, which can be filled with the **Retrieve Logs** button. Do note that the Max Logs parameter has to have a value for this to be successful.
+- **Web Interface**: This page contains the web interface.
diff --git a/connector/doc/Amagi_CLOUDPORT_Playout_Service_Manager.md b/connector/doc/Amagi_CLOUDPORT_Playout_Service_Manager.md
@@ -0,0 +1,53 @@
+---
+uid: Connector_help_Amagi_CLOUDPORT_Playout_Service_Manager
+---
+
+# Amagi CLOUDPORT Playout Service Manager
+
+This connector is used to monitor the Amagi CLOUDPORT Playout Service Manager.
+
+## About
+
+### Version Info
+
+| Range                | Key Features     | Based on     | System Impact     |
+|----------------------|------------------|--------------|-------------------|
+| 1.0.0.x [SLC Main]   | Initial version  | -            | -                 |
+
+### Product Info
+
+| Range   | Supported Firmware |
+|---------|--------------------|
+| 1.0.0.x | -                  |
+
+### System Info
+
+| Range     | DCF Integration     | Cassandra Compliant     | Linked Components     | Exported Components     |
+|-----------|---------------------|-------------------------|-----------------------|-------------------------|
+| 1.0.0.x   | No                  | Yes                     | -                     | -                       |
+
+## Configuration
+
+### Connections
+
+#### HTTP Connection
+
+This connector uses an HTTP connection and requires the following input during element creation:
+
+HTTP CONNECTION:
+
+- **IP address/host**: The polling IP or URL of the destination.
+- **IP port**: The IP port of the destination (default: *443*).
+- **Device address**: The bus address of the device. If the proxy server has to be bypassed, specify *BypassProxy*.
+
+### Initialization
+
+On the **Security** page, you will need to configure a token obtained from the GUI or vendor. This will be used for all the requests sent by the connector.
+
+### Web Interface
+
+The web interface is only accessible when the client machine has network access to the product.
+
+## How to use
+
+On the **General** page, you can find all the information you need to monitor the HTTP connection, the on-air feeds, and the headends.
diff --git a/connector/doc/Arqiva_Radio_Trap_Receiver.md b/connector/doc/Arqiva_Radio_Trap_Receiver.md
@@ -50,6 +50,6 @@ SNMP Settings:
 
 ### General
 
-This page contains the **Alarm Traps** table, which displays all alarms that came in through traps. The **ID**, **Timestamp**, **Source** **IP**, **OID**, **Radio** **link**, **Alarm** **condition**, **Alarm** **state** and **ECAM** **cct** **number** of the trap are displayed in the different columns.
+This page contains the **Alarm Traps** table, which displays all alarms that came in through traps. The **ID**, **Timestamp**, **Source IP**, **OID**, **Radio link**, **Alarm condition**, **Alarm state** and **ECAM cct number** of the trap are displayed in the different columns.
 
 With the **Clear Table** button above the table, you can delete all rows from the table.
diff --git a/connector/doc/Atlassian_Jira_Service_Management.md b/connector/doc/Atlassian_Jira_Service_Management.md
@@ -0,0 +1,57 @@
+---
+uid: Connector_help_Atlassian_Jira_Service_Management
+---
+
+# Atlassian Jira Service Management
+
+This connector polls all issues and requests for Jira projects within a domain. You can also use it to create simple issue tickets on a service desk.
+
+## About
+
+### Version Info
+
+| Range              | Key Features     | Based on | System Impact |
+|--------------------|------------------|----------|---------------|
+| 1.0.0.x [SLC Main] | Initial version. | -        | -             |
+
+### Product Info
+
+| Range   | Supported Firmware |
+|---------|--------------------|
+| 1.0.0.x | -                  |
+
+### System Info
+
+| Range   | DCF Integration | Cassandra Compliant | Linked Components | Exported Components |
+|---------|-----------------|---------------------|-------------------|---------------------|
+| 1.0.0.x | No              | Yes                 | -                 | -                   |
+
+## Configuration
+
+### Connections
+
+#### HTTP Main Connection
+
+This connector uses an HTTP connection and requires the following input during element creation:
+
+HTTP CONNECTION:
+
+- **IP address/host**: The polling IP or URL of the destination.
+- **IP port**: The IP port of the destination (default: *443*).
+- **Device address**: The bus address of the device. If the proxy server has to be bypassed, specify *BypassProxy*.
+
+### Initialization
+
+Fill in the **Username** and **API Key** on the **General** page. Basic authentication with passwords is deprecated, and instead of the password an **API token needs to be used** (see also [Manage API tokens for your Atlassian account \| Atlassian Support](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/)).
+
+### Redundancy
+
+There is no redundancy defined.
+
+## How to use
+
+The element polls all service desks for the environment specified in the URL of the element. This includes the **Service Desks**, **Queues**, and **Issues**. You can choose to enable or disable polling of certain queues.
+
+From the **Issues** page, it is possible to create a small issue given some input data.
+
+Alternatively, by following the given format in the API documentation for [Create Request](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-rest-servicedeskapi-request-post), you can also use an Automation script to set PID 2 with your own JSON data.