Skip to content

Commit f3ae6d3

Browse files
committed
Update TDF_BIP_Collector.md
1 parent 50a5d04 commit f3ae6d3

File tree

1 file changed

+14
-11
lines changed

1 file changed

+14
-11
lines changed

connector/doc/TDF_BIP_Collector.md

+14-11
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ uid: Connector_help_TDF_BIP_Collector
44

55
# TDF BIP Collector
66

7-
This connector is used to collect from the **BIP (Production Incident Database)** system, responsible for interfacing all the Collector subsystems, the storage subsystem and all potential customers using the collected and correlated data.
7+
This connector is used to collect data from the **BIP (Production Incident Database)** system, responsible for interfacing all the collector subsystems, the storage subsystem, and all potential customers using the collected and correlated data.
88

99
## About
1010

@@ -18,7 +18,7 @@ This connector is used to collect from the **BIP (Production Incident Database)*
1818

1919
| Range | Supported Firmware |
2020
|---------|--------------------|
21-
| 1.0.0.x | 4.58 |
21+
| 1.0.0.x | 4.58 |
2222

2323
### System Info
2424

@@ -32,24 +32,27 @@ This connector is used to collect from the **BIP (Production Incident Database)*
3232

3333
#### HTTP Main Connection
3434

35-
This connector uses HTTPA connection and requires the following input during element creation:
35+
This connector uses an HTTPS connection and requires the following input during element creation:
36+
3637
HTTP CONNECTION:
3738

38-
- **IP address/host**: The polling IP or URL of the destination.Should always start with _https://_
39-
- **IP port**: Default:*8443*.
39+
- **IP address/host**: The polling IP or URL of the destination. Should always start with `https://`
40+
- **IP port**: Default: *8443*.
4041

4142
##### Initialization
42-
In order to perform requests, first the **Domains List** parameter needs to be configured.
43-
It is possible to define only one Domain or multiple separated by **;**.
43+
44+
In order to perform requests, first the **Domains List** parameter needs to be configured. You can define only one domain or define multiple domains separated by semicolons (";").
4445

4546
## How to use
4647

4748
The connector contains the following data pages:
4849

49-
- **General**: This page contains the **Domains List** parameter that allows the user to define from each domain should the requests be directed. Without this parameter defined there is no possibility to perform requests.
50+
- **General**: Contains the **Domains List** parameter, which allows you to define from which domain requests should be directed. If this parameter is not defined, the connector cannot request any data.
51+
52+
- **Resources**: Contains the **Resources Table**, with all the information obtained from the get resources request.
5053

51-
- **Resources**: This page contains the **Resources Table** that contains all the information obtained from the get resources request.
54+
- **Alarms**: Contains the **Event Types Table**, with all the possible event types, and the **Event Table**, with the active events, limited to the last 15 minutes.
5255

53-
- **Alarms**: This page contains the **Event Types Table** that contains all the possible Event Types and the **Event Table** that contains the active events limited to the last 15 minutes. Also from this page it is possible to define the Display key of the Events Table. The parameter **Events Table Display Key Selection** is used to select this. If **Internal Description** is selected the Display Key will have the following format _Event ID/Event Internal Description/Resource Internal Description_ if **External Description** is selected th format will be _Event ID/Event External Description/Resource External Description_.
56+
On this page, you can also define the display key of the Events Table, by means of the parameter **Events Table Display Key Selection**. If *Internal Description* is selected, the display key will have the following format: `Event ID/Event Internal Description/Resource Internal Description`. If *External Description* is selected, the format will be `Event ID/Event External Description/Resource External Description`.
5457

55-
- **Polling Configuration**: From this page it is possible to select which and when the 3 available requests are polled. Also it is possible to poll the requests on demand pressing the button **Poll** available on every entry of the table. There is also a **Poll All** button that allows the user to poll all requests at once.
58+
- **Polling Configuration**: On this page, you can select which of the available requests is polled and when. You can also poll the requests on demand with the **Poll** button for each entry in the table. With the **Poll All** button, you can poll all requests on demand at once.

0 commit comments

Comments
 (0)