Create a connection template
In the top left-hand corner of the main dashboard screen, click the Manage icon:
.On the Manage panel, click Data Pipeline
.On the right-hand side of the Connectors screen, click the Connection Templates icon:
.In the Select Type option, choose a connector type from the list:
HTTP - A REST interface or other HTTP-based integration.
FILE - A file.
SOCKET - A TCP sockets interface.
MQTT - Connect to an MQTT (Message Queuing Telemetry Transport) broker.
FTP - A client/server protocol used for transferring files to or exchanging files with a host computer.
SFTP - A secure FTP (File Transfer Protocol) used for transferring files to or exchanging files with a host computer.
MS SQL - A Microsoft SQL Server relational database.
MySQL - An open-source relational database.
Oracle - An Oracle relational database.
PostgreSQL - An open-source object-relational database.
On the right-hand side of the screen, click on the Create Connection Template button:
Configure General Properties as required:
Setting
Description
Name
The text that is displayed in the list of connection templates.
Note
It must be 3-30 characters only.
Description
A longer description of the connection template.
Tags
One or more optional descriptive tags for the connection template.
Depending on the data source type, edit the corresponding Configuration Properties as indicated below.
For a HTTP source, provide the following Configuration Properties:
Setting
Description
Base URL
The network URL for the data source. This may be a complete URL or it may be the base (that is, left-hand side) of the URL, in this case the individual datasets would specify the remainder of the URL to be appended to this base to construct the complete URL.
Auth Strategy
The options are as follows:
No Auth No authentication is required to connect to the data source.
Basic Auth Enter user name and password for basic authentication.
Custom Auth Provide URL and connection details for a custom authentication server.
OAuth2 Use Open Authentication tokens to connect to the data source.
Params
One or more key–value pairs for HTTP request parameters.
Headers
One or more key–value pairs for HTTP request headers.
For a MS SQL , MySQL, Oracle or PostgreSQL data source, provide the following Configuration Properties:
Setting
Description
Host
The host name or URL of the database server.
Port
The network port to be used to connect to the database server.
User
The user name to authenticate with the database server.
Password
The password to authenticate with the database server.
Database Name
Name of the database.
Database Type
The corresponding database type that was selected earlier. The options are as follows:
PostgreSQL
MySQL
MS SQL
Oracle
Encryption Connection
If enabled, the connection will be encrypted by enabling the encryption option of the MS SQL database.
Note
It is displayed only if the Database Type is selected as MS SQL.
For a Socket source, provide the following Configuration Properties:
Setting
Description
Type
The options are as follows:
HTTP – used to connect to a web resource.
WebSocket – uses the standard WebSocket API to connect to a WebSocket server.
TCPIP – used to establish a raw TCP/IP network connection.
Host
The host name or URL of the socket server.
Port
The network port to be used to connect to the socket server.
Hooks
The scripts executed during the life cycle operations of a socket connection. The options are as follows:
onConnect
afterConnect
onError
onEnd
onConnectError
onReconnectError
onConnectTimeout
You can add a script by clicking on the
icon and remove an added script by clicking on the 
icon.Options
Any server-specific connection options.
For an MQTT source, provide the following Configuration Properties:
Setting
Description
Host
The host name or URL of the server.
Port
The network port to be used to connect to the MQTT server.
Hooks
The scripts executed during the life cycle operations of a MQTT connection. The options are as follows:
onConnect
afterConnect
onClose
onError
onDisconnect
onOffline
onEnd
You can add a script by clicking on the
icon and remove an added script by clicking on the icon.Options
Any server-specific connection options.
Certification:
Authentication Type
The type of authentication used in the MQTT connection. The options are the following:
None – No authentication is used.
Static - The authentication data is written in the Options section.
Certificate - A certificate with the CRT extension is uploaded along with the Private Key with the PEM extension for authentication.
aws - A Certificate or CACertificate with the CRT extension is uploaded along with the Private Key with the PEM extension for authentication.
For an FTP source, provide the following Configuration Properties:
Setting
Description
Host
Host name or URL of the FTP server.
Port
Network port to be used to connect to the FTP server.
User
The user to be used to authenticate with the FTP server.
Password
The password to be used to authenticate with the FTP server.
Root Directory
The base directory of the FTP server.
Type
The options are as follows:
FTP - to transfer files with TCP/IP protocols.
For a SFTP source, provide the following Configuration Properties:
Setting
Description
Host
Host name or URL of the SFTP server.
Port
Network port to be used to connect to the SFTP server.
User
The user to be used to authenticate with the SFTP server.
Password
The password to be used to authenticate with the SFTP server.
Root Directory
The base directory of the SFTP server.
Type
The options are as follows:
SFTP - implements secure file transfer over SSH.
Click Submit to create the connection template.