Create Data stream

Create New Data Stream

On the Data Stream screen, click CREATE NEW DATA STREAM to create a new Data Stream. Refer to the following screen

2. After clicking the button, the CREATE NEW DATA STREAM screen is displayed.
2.1. SFTP Push Data Stream with Authentication Type selected as Username/Password creation screen

2.2. SFTP Push Data Stream and Authentication Type selected as Public/Private Key creation screen

Enter or select the following details in the corresponding fields for SFTP push case, fields marked with "|"are mandatory

Field	Description
Stream Name	Enter the Stream name. Note: Stream name is always alphanumeric.
Event Type	Select the type of Event Types For example, Mobility Events,Usage Events Select Mobility Events or/and Usage Events and atleast one Event Type should be selected.
Mobility Events	Select the Event, For example All, Authentication, Cancel Location, Data Session, Purge Subscriber, SMS, Update Location these fields will be listed in alphabetical order. Mobility Events drop list is not mandatory by default but only if Mobility events are checked and only then select.
Usage Events	Select Usage Event, Usage Events will not have an option to select specific fields and all fields will be available by default, For example DATA Usage and SMS Usage.
Stream type	Select the type of SFTP stream For example, SFTP Push,SFTP Pull or Callback API(Bulk) Note : The stream details form will be changed base on the selection of the type of stream and By default, SFTP push radio button will be preselected. On each of the selection there will be a tooltip where the user can get more information about the stream type. SFTP Push – Files will be pushed to the remote SFTP server SFTP Pull – Files will be pulled from remote SFTP server
Contact Name	Enter a contact name to setup SFTP Note: You cannot modify the Contact Name on your own after the Data Stream is created, If needed ask your customer support.
Contact Email	Enter the email ID for contact. Note: You cannot modify the Contact Email on your own after the Data Stream is created, If needed ask your customer support.
Host Name	Enter the hostname of SFTP server. Note: This field will be available on SFTP push details form.You cannot modify the Host Name after the Data Stream is created.
Destination IP address	Enter Destination IP address of the SFTP server. Note: You cannot modify the IP after the Data Stream is created. This field will be available on SFTP push details form.
Port	The port of customer's SFTP server. Recommended is TCP / 22000 Note: You cannot modify the Port on your own after the Data Stream is created, If needed ask your customer support.. This field will be available on SFTP push details form
Authentication Type	Select authentication type - username/password or Public/Private Key. By default, Username/password radio button will be preselected. The type of the authentication that will be used to connect to customer's server. Note: When the Username/password or Public key will selected the stream Details form will be changed base on the selection. You cannot modify the Authentication Type after the Data Stream is created.
Username	Enter the account name that will be used to connect to your SFTP server. (if Authentication type- Username/Password)
Password	Enter the password of the account that will be used to connect to your SFTP server. (if Authentication type- Username/Password)
Path	Enter the path relative to the home directory of the customer. Note: This field will be available on SFTP push details form. You cannot modify the Path after the Data Stream is created.
Frequency	Select the frequency among 10 min, once per hour, once per day. how often you want files to be transfer to your server. By default, frequency with 10 min will be preselected. You cannot modify the frequency after the Data Stream is created.
Comment	Enter text in the comment field. Note: You cannot modify the Comment on your own after the Data Stream is created, If needed ask your customer support..

3. SFTP Pull Data Stream and Authentication Type selected as Public/Private Key creation

3.1. SFTP Pull Data Stream and Authentication Type selected as Username/Password creation screen

Enter or select the following details in the corresponding fields. Fields marked with "|"are mandatory

Field	Description
Stream Name	Enter the Stream name. Note: Stream name is always alphanumeric.
Event Type	Select the type of Event Types For example, Mobility Events,Usage Events Select Mobility Events or/and Usage Events and atleast one Event Type should be selected.
Mobility Events	Select the Event, For example All, Authentication, Cancel Location, Data Session, Purge Subscriber, SMS, Update Location these fields will be listed in alphabetical order. Mobility Events drop list is not mandatory by default but only if Mobility events are checked and only then select.
Usage Events	Select Usage Event, Usage Events will not have an option to select specific fields and all fields will be available by default, For example DATA Usage and SMS Usage.
Stream type	Select the type of SFTP stream For example, SFTP Push,SFTP Pull or Callback API(Bulk) Note : The stream details form will be changed base on the selection of the type of stream and By default, SFTP push radio button will be preselected. On each of the selection there will be a tooltip where the user can get more information about the stream type. SFTP Push – Files will be pushed to the remote SFTP server SFTP Pull – Files will be pulled from remote SFTP server
Contact Name	Enter a contact name to setup SFTP Note: You cannot modify the Contact Name on your own after the Data Stream is created, If needed ask your customer support.
Contact Email	Enter the email ID for contact. Note: You cannot modify the Contact Email on your own after the Data Stream is created, If needed ask your customer support.
Source Hostname	Enter the hostname of the server that will be connected to the SFTP server.
Source IP address	Enter IP of the server that will be connected to the SFTP server
Authentication Type	Select authentication type - username/password or Public/Private Key. By default, Username/password radio button will be preselected. The type of the authentication that will be used to connect to customer's server. Note :When the Username/password or Public key will selected the stream details form will be changed base on the selection. You cannot modify the Authentication Type after the Data Stream is created. Username/Password should be provided by the own SFTP server. In case they change please inform your customer support. Public key is provided by the platform and will be communicated to you during the SFTP establishment process.
Public Key used for Authentication	Enterprise to provide public key for the username(account) provided by BICS Note : This will be available only if authentication type is selected as Public/Private Key.
Frequency	Select the frequency among 10 min, once per hour, once per day, how often you want files to be transfer to your server. By default, frequency with 10 min will be preselected. You cannot modify the frequency after the Data Stream is created.
Comment	Enter text in the comment field. Note: You cannot modify the Comment on your own after the Data Stream is created, If needed ask your customer support.

4. After entering/selecting required fields click on Submit. A confirmation message is displayed as below,

4.1 Once data stream is created an email will be sent to the list of emails(Account email, contact email, first user email).
4.2 By default stream will be deactive and a background SFTP establishment process needs to be completed before stream is activated. As soon as it is activated stream will change to stopped.

5. For Callback API(Bulk) data stream creation click on Callback API (Bulk) radio button, on click of Callback API (Bulk) details form changes. Refer to the following screen.

Enter or select the following details in the corresponding fields. Fields marked with "|"are mandatory

Field	Description
Stream Name	Enter the Stream name. Note: Stream name is always alphanumeric.
Event Type	Select the type of Event Types For example, Mobility Events, Usage Events Select Mobility Events or/and Usage Events and at least one Event Type should be selected.
Mobility Events	Select the Event, For example All, Authentication, Cancel Location, Data Session, Purge Subscriber, SMS, Update Location these fields will be listed in alphabetical order. Mobility Events drop list is not mandatory by default but only if Mobility events are checked and only then select. URI should configure for mobility events from "CALLBACK URI" in TOOLSCALLBACK API Mobility Events will be transferred using URI configured for the process name "Mobility Events (Bulk)".
Usage Events	Select Usage Event, Usage Events will not have an option to select specific fields and all fields will be available by default, For example DATA Usage and SMS Usage. URI should configure for Usage events from "CALLBACK URI" in TOOLSCALLBACK API Usage Events will be transferred using URI configured for the process name "Usage Events (Bulk)".
Account Events	Select Account Event, Account events will generate events for Callback API URI should configure for Account events from "CALLBACK URI" in TOOLSCALLBACK API Account Events will be transferred using URI configured for the process name "Account Events (Bulk)".
Endpoint Events	Select Endpoint Event, Endpoint events will generate events for Callback API URI should configure for Endpoint events from "CALLBACK URI" in TOOLSCALLBACK API Endpoint Events will be transferred using URI configured for the process name "Endpoint Events (Bulk)".
Stream type	Select the type of stream For example, Callback API(bulk) Note : The stream details form will be changed base on the selection of the type of stream and By default, SFTP push radio button will be preselected. On click Callback API(Bulk) radio button details will display

5.1 After entering/selecting required fields click on Submit. A confirmation message is displayed as below

5.2 By default Callback API(Bulk) stream will be activated automatically from Bics level and new stream should be created as Stopped.

If data stream creation reached maximum limit, on click of create new data stream button receives an alert message. Refer to the following screen