View Data stream
View Data Stream
1. On the top menu, click
to view the settings menu. Refer to the following screen.
Figure 1 Setting
2. On the Settings screen, click DATA STREAM to view the Data stream details. Refer to the following screen
If selected both events, in view section. Refer to the following screen.
Figure 3 Data Stream
3. The following Data Stream details are displayed on the screen.
Field | Description |
|---|---|
Stream Name | Indicates the name of the Data Stream. |
Stream ID | Indicates the unique ID of the Data Stream. |
Account Name | Indicates the account name of organisation by whom the Data stream was created. |
Stream Type | Indicates the type of Data Stream. SFTP Push and SFTP Pull are the two options for this, |
Event Type | Indicates the type of Events that are collected from the specific stream E.g. Mobility Events or/and Usage Events |
Status | Indicates the present status of Data Stream. |
Start/Pause | Start/Pause button will be active only when the status is set to Activated for the data stream by BICS button, system will change the stream status to start. System will start generating the file in this state. Start button is available to users with the right permissions. button, system will change the stream status to pause. In Pause status, stream is producing the files without them been forwarded to the customer. Pause button is available to users with the right permissions. |
Stop | Stop button will be active only when the stream status is either Running/Paused button, system will change the stream status to stop. System will not produce any files in stop state. Stop button is available to users with the right permissions. |
View | Click on View icon to see the summary view of the Data Stream. |
Edit | Click on Edit icon to edit the SFTP push or pull details of the Data Stream. |
Delete | On click of delete button, system will remove the data stream from DB. |
Summary View of Data Stream
To see the summary of the selected Data Stream, click on
to view icon the quick description of data stream.Refer to the following screen
Figure 4 View Data Stream
4. After clicking the button, the following screen is displayed
Summary View of SFTP Push with Authentication type as Username/password Data Stream and selected both events.
Figure 5 Summary View of SFTP PUSH
Summary View of SFTP Push with Authentication Type as Public/Private Key Data Stream and selected only Mobility Events.
Figure 6 Summary View
The following Data Stream details are displayed on the summary screen of SFTP Push data stream.
Field | Description |
Stream Name | Indicates the name of the Data Stream. |
Stream ID | Indicates the unique ID of the Data Stream. |
Account Name | Indicates the account name of organization by whom the data stream was created. |
Status | Indicates the present status of Data Stream. Various statuses are Deactivated, Running, Stopped, Deleted, Paused. |
Stream Type | Indicates the type of Data Stream. This will be SFTP Push in this scenario. |
Mobility Events | Shows the mobility events that were selected during the creation of data stream or/and Usage Events. |
Usage Events | Shows the Usage Events as All that were selected of Usage Events during the creation of data stream |
Contact Name | Indicates the name of the user that created the data stream |
Contact Email | Indicates the email provided during the creation of data stream for contact. |
Host Name | Indicates the host name of SFTP server, for BICS to connect and transfer the files. |
Destination IP Address | Indicates the public IP of SFTP server, for BICS to connect and transfer the files. |
Port | Indicates the port of SFTP server, for BICS to connect and transfer the files. |
Authentication Type | Indicates the type of the authentication that will be used to connect to server. |
User Name | Indicates the username of the account that will be used to connect to SFTP server. (if Authentication type- Username/Password) |
Password | Indicates the password of the account that will be used to connect to SFTP server. (if Authentication type- Username/Password) |
Path | Indicates the path relative to the home directory of the user. |
Frequency | Indicates the frequency among 10 min, once per hour, once per day. how often you want files to be transfer to your server. |
Comments | Indicates the comments provided while creating data stream. |
5. Summary View of SFTP Pull with Authentication Type as Public/Private Key Data Stream and selected only Usage Events.
Figure 7 Summary View
6. Summary View of SFTP Pull with Authentication Type Username/Password Data Stream and selected only Usage Events
Figure 8 Summary View of SFTP PULL
The following Data Stream details are displayed on the summary screen of SFTP Pull data stream.
Field | Description |
Stream Name | Indicates the name of the Data Stream. |
Stream ID | Indicates the unique ID of the Data Stream. |
Account Name | Indicates the account name of organization by whom the data stream was created. |
Status | Indicates the present status of Data Stream. Various statuses are Deactivated, Running, Stopped, Deleted, Paused. |
Stream Type | Indicates the type of Data Stream. This will be SFTP Pull in this scenario. |
Mobility Events | Shows the mobility events that were selected during the creation of data stream or/and Usage Events. |
Usage Events | Shows the Usage events that were selected during the creation of data stream. |
Contact Name | Indicates the User name of the user that created the data stream. |
Contact Email | Indicates the email provided during the creation of data stream for contact. |
Source Hostname | Indicates the host name of the server that will be connected to the SFTP server, for BICS to connect and transfer the files. |
Source IP address(es) | Indicates the IP of the server that will be connected to the SFTP server, for BICS to connect and transfer the files. |
Authentication Type | Indicates the type of the authentication that will be used to connect to server. |
Public key used for authentication | Indicates the public key for the username(account) provided by BICS |
Frequency | Indicates the frequency among 10 min, once per hour, once per day. how often you want files to be transfer to your server. |
Comments | Indicates the comments provided while creating data stream. |
7. Summary View of Callback API(Bulk) Data Stream and selected Usage and Mobility Events
Figure 9 Confirmation message
The following Data Stream details are displayed on the summary screen of Callback API(Bulk) data stream.
Field | Description |
Stream Name | Indicates the name of the Data Stream. |
Stream ID | Indicates the unique ID of the Data Stream. |
Account Name | Indicates the account name of organization by whom the data stream was created. |
Status | Indicates the present status of Data Stream. Various statuses are Deactivated, Running, Stopped, Deleted |
Stream Type | Indicates the type of Data Stream. This will be Callback API(Bulk) in this scenario. |
Mobility Events | Shows the mobility events that were selected during the creation of data stream or/and Usage Events. |
Usage Events | Shows the Usage Events as All that were selected of Usage Events during the creation of data stream |
Callback API (Bulk) | Indicates the Callback API (Bulk) details |