Skip to content

Commit 45d3733

Browse files
committed
Update Telestream_Vantage.md
1 parent 71dcae1 commit 45d3733

File tree

1 file changed

+22
-28
lines changed

1 file changed

+22
-28
lines changed

connector/doc/Telestream_Vantage.md

+22-28
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,16 @@ This connector queries a SOAP interface available on the target machine.
1212

1313
Multiple different SOAP requests are daisy-chained to query for the list of configured workflows and jobs. Additional details are also retrieved for each **workflow** and **job** (including completion percentage and other metrics, such as the total execution time).
1414

15-
The connector also queries the Vantage SOAP interface for the various **servers** available in the cluster and retrieves information for each of these machines, including their **service** **list**, state and metrics.
15+
The connector also queries the Vantage SOAP interface for the various **servers** available in the cluster and retrieves information for each of these machines, including their **service list**, state, and metrics.
1616

1717
### Version Info
1818

19-
| **Range** | **Description** | **DCF Integration** | **Cassandra Compliant** |
20-
|----------------------|-------------------------------|---------------------|-------------------------|
21-
| 1.0.0.x | Initial version | No | Yes |
22-
| 1.0.1.x | Implemented redundant pooling | No | Yes |
23-
| 1.0.2.x | Added unicode option. | No | Yes |
24-
| 1.0.3.x \[SLC Main\] | Added unicode option. Major logic refactor with performance improvements. | No | Yes |
19+
| Range | Description | DCF Integration | Cassandra Compliant |
20+
|--------------------|---------------------------------------------------------------------------|-----------------|---------------------|
21+
| 1.0.0.x | Initial version | No | Yes |
22+
| 1.0.1.x | Implemented redundant pooling | No | Yes |
23+
| 1.0.2.x | Added unicode option. | No | Yes |
24+
| 1.0.3.x [SLC Main] | Added unicode option. Major logic refactor with performance improvements. Upgrading from 1.0.2.x to 1.0.3.x has no major impact, as only changes to the internal logic are implemented. | No | Yes |
2525

2626
### Product Info
2727

@@ -42,66 +42,60 @@ This connector uses an HTTP connection and requires the following input during e
4242

4343
HTTP CONNECTION:
4444

45-
- **IP address/host**: The polling IP of the device, e.g. *10.11.12.13.*
45+
- **IP address/host**: The polling IP of the device, e.g. *10.11.12.13*.
4646
- **Port number**: The port of the connected device, by default *8676*.
4747
- **Bus Address:** By default, this field is filled in with "*ByPassProxy*". This is necessary to avoid network issues.
4848

49-
#### HTTP secondary connection:
49+
#### HTTP secondary connection
5050

5151
This connector has a secondary connection and requires the following input during element creation.
5252

5353
HTTP CONNECTION:
5454

55-
- **IP address/host**: The polling IP of the device, e.g. *10.11.12.13.*
55+
- **IP address/host**: The polling IP of the device, e.g. *10.11.12.13*.
5656
- **Port number**: The port of the connected device, by default *8676*.
5757
- **Bus Address**: By default, this field is filled in with "*ByPassProxy*". This is necessary to avoid network issues.
5858

5959
### Configuration of Redundant Polling
6060

6161
This connector supports redundant polling. If an HTTP request times out, a secondary connection will be used for a retry. In order to use this feature, you must configure the secondary HTTP connection.
6262

63-
## Usage
63+
### Web Interface
64+
65+
The web interface is only accessible when the client machine has network access to the product.
66+
67+
## How to Use
6468

6569
Two main sets of pages are available in the connector. One set displays the **cluster information** (**servers** and **services**) and the other displays the **workflows** and **jobs** information.
6670

6771
Each set consists of two pages, one displaying the information in a **tree view** and the other displaying the **source tables** that contain all the data retrieved from the server. Users can monitor either page according to preference.
6872

69-
### Domain Machines and Server
73+
### Domain Machines and Server Page
7074

7175
This page displays a list of **servers** available in the **domain**. For each server, a list of **services** is also displayed, along with all **service metrics**.
7276

7377
This page displays its data in a **tree view**.
7478

75-
### Domain Machines and Server Tables
79+
### Domain Machines and Server Tables Page
7680

7781
This page displays the same data as the "Domain Machines and Server" page, but the data is displayed in a **table structure** instead of a tree view.
7882

79-
### Workflow and Jobs
83+
### Workflow and Jobs Page
8084

8185
This page displays a list of **workflows** that are configured on the cluster. For each retrieved **workflow**, a **list of jobs** is also retrieved, along with the **current completed percentage**. For each of these jobs, a **list of sessions** is also retrieved. This information contains a historical overview of each job with each different step.
8286

8387
This page displays its data in a **tree view** format.
8488

85-
### Workflow and Jobs Tables
89+
### Workflow and Jobs Tables Page
8690

8791
This page displays the same data as the "Workflow and Jobs" page, but the data is displayed in a **table structure** instead of a tree view.
8892

89-
### Driver Configuration
93+
### Driver Configuration Page
9094

9195
This page allows you to filter the jobs by their present status, and filter the session by date.
9296

9397
These filters limit the information shown on the other pages according to the selected options.
9498

95-
### Web Interface
96-
97-
This page displays the web interface of the device. However, note that the client machine has to be able to access the device, as otherwise it will not be possible to open the web interface.
98-
99-
### Request Queue and Tasks [1.0.3.x]
100-
101-
This version features a queue that will hold the current requests to be done. It is important to mention that there is no priority ordering implemented. The requests are done by order of entry in the queue, so there is no priority given to set requests.
102-
103-
To fill the request queue and process responses, independent tasks are used. Each task has a maximum lifetime of 15 minutes.
104-
105-
### Upgrade from 1.0.2.x to 1.0.3.x
99+
### Request Queue and Tasks (range 1.0.3.x)
106100

107-
No major impact in upgrade, only changes in internal logic.
101+
Range 1.0.3.x features a queue containing the current requests to be done. No priority ordering has been implemented. The requests are done by order of entry in the queue, so set requests do not get priority. To fill the request queue and process responses, independent tasks are used. Each task has a maximum lifetime of 15 minutes.

0 commit comments

Comments
 (0)