Skip to content

Commit bf9e20a

Browse files
committedDec 26, 2024
Added driver help page for the Avid iNews driver.
1 parent 8ec8e57 commit bf9e20a

File tree

2 files changed

+64
-0
lines changed

2 files changed

+64
-0
lines changed
 

‎connector/doc/Avid_iNews.md

+62
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
---
2+
uid: Connector_help_Avid_iNews
3+
---
4+
5+
# Avid iNews
6+
7+
This connector monitors input booking details associated with the **Avid iNews**.
8+
9+
## About
10+
11+
This connector monitors input booking details, retrieves these entries from iNews, processes them, and displays them as a table within DataMiner. These entries are then used to create bookings in the system.
12+
13+
### Version Info
14+
15+
| Range | Description | DCF Integration | Cassandra Compliant |
16+
|------------------|-----------------|---------------------|-------------------------|
17+
| 1.0.0.x | Initial version | No | Yes |
18+
19+
## Installation and configuration
20+
21+
### Creation
22+
23+
#### HTTP Main Connection
24+
25+
This connector uses an HTTP connection and requires the following input during element creation:
26+
27+
HTTP CONNECTION:
28+
29+
- **IP address/host**: The address of the host that is hosting the Avid iNews service.
30+
- **IP port**: The port on which the Avid iNews service is listening.
31+
- **Bus address**: If the proxy server has to be bypassed, specify *bypassproxy.*
32+
33+
### Initialization
34+
35+
When a new element is created, the **username, password and server name** of the Avid iNews should be entered on the **General** page. These credentials are necessary for a successful connection and communication during sessions.
36+
37+
## Usage
38+
39+
This connector presents the booking details in two different data display pages on the element card.
40+
41+
### General
42+
43+
This page contains information about the system:
44+
45+
- **Server**: Server name of the iNews.
46+
- **User Name**: User name of the iNews user.
47+
- **Password**: Password that is necessary for a successful login.
48+
49+
### Bookings
50+
51+
This page contains all of the bookings that have been made during the period of time that is determined by the user (default: last 7 days):
52+
53+
- **Days to Retrieve:** Time period for which the bookings are listed in the table.
54+
- **Booking Table:** Booking table containing the necessary information about each individual booking from the said time period.
55+
- **Booking Table Row Max Count:** Maximum number of rows diplayed in the table (default: 500 rows).
56+
57+
### Historical Bookings
58+
59+
This page contains all of the bookings for a certain date that is chosen by the user:
60+
61+
- **Date of the Booking:** Date for which the user wants to list the bookings.
62+
- **Historical Booking:** Table that contains the bookings for the chosen date.

‎connector/toc.yml

+2
Original file line numberDiff line numberDiff line change
@@ -1006,6 +1006,8 @@
10061006
topicUid: Connector_help_Aviat_Networks_Provision_-_Device
10071007
- name: Avid
10081008
items:
1009+
- name: Avid iNews
1010+
topicUid: Connector_help_Avid_iNews
10091011
- name: Avid Interplay Engine
10101012
topicUid: Connector_help_Avid_Interplay_Engine
10111013
- name: Avid Interplay PAM

0 commit comments

Comments
 (0)