How do I configure a Secure Gateway between #WatsonAnalytics and an On-Premises Data Source?

Blog Home > How do I configure a Secure Gateway between #WatsonAnalytics and an On-Premises Data Source?

How do I configure a Secure Gateway between #WatsonAnalytics and an On-Premises Data Source?



I would like to configure a data connection between an on premises database and IBM Watson Analytics. I understand a Secure Gateway client is required in order to do so. What is the procedure for configuring a Secure Gateway Client in Watson Analytics, and subsequently, a database connection through that Secure Gateway?


Before following the steps outlined below, in order to configure your Secure Gateway it is important to note that not all Data Connections require the use of a Secure Gateway Client. Depending on the nature of the data source to which you are attempting to connect, it is quite possible that you may proceed with configuring the data connection without a Secure Gateway configured.

1. Click the user icon on the top right of the screen once you are logged in to Watson Analytics, then click Account settings.


2. On the left hand side of the screen, click on Secure gateways then Add Gateway.


3. Provide a name and click Add Gateway.

Note: You may name your Secure Gateway anything you wish, but it may be beneficial to choose a name which indicates the data connections that will be configured through this particular Secure Gateway to avoid future confusion. In this example we’ve used the name ‘Gateway for XXX database’.


4. Click Connect Client which will prompt the installer screen for the Secure Gateway Client.


Click IBM Installer, then the installer for your operating system. For this example, I will use Windows as the operating system. Be sure to document the provided Gateway ID and Security Token (in notepad, for instance) as it will be required later during the installation process.


5. Download the installer, launch it, and follow the on-screen steps.

When prompted, select the Install as a Windows Service check box and click Next.  In the subsequent screen, paste in the previously copied Gateway ID and Security token and click Next.


6. On the next screen, select Yes to using the client UI. It provides a high level view of the secure gateway client directly from the browser instead of the command line.

7. Install the Secured Gateway and close the Setup once it completes. You can find the secure gateway client in Start -> All Programs -> IBM -> Secure Gateway Client. (If the file directory was left to the default path).

8. Open the client and you will see the following command line:


Type Y and press Enter. The following screenshots depict a successful Secure Gateway Client Setup.

Within the command line:


Within Watson Analytics:


9. Defining access to the on-premises database.

The Secure Gateway client provides embedded Access Control List (ACL) support.  This gives you the ability to restrict or allow access to the on-premises database which is documented in detail here.

An ACL may be defined to be unbounded (i.e. the Secure Gateway may be used to connect to any database, regardless of Hostname or Port), or, the user may choose to define the ACL to be restricted (i.e. the Secure Gateway may only be used to connect to a particular Hostname/Port).

If you are aware of the hostname or port to which you would like to connect using this Secure Gateway, it is recommended that you type “acl allow hostname:port” as defined in the document.

For the purposes of this documentation, we will use the unbounded method.  Also, as a tip, unbounded access is good for initial setup to make sure it all works and can be further secured later once proven a connection is made.

To create the unbound access:  Type acl allow : in the command prompt.


10. In Watson Analytics, click Data Connections from the left panel. Click on the + icon to add a database.


11. Choose the data connector which represents the database to which you would like to connect. Fill out the required information. Make sure you select the Secure Gateway you’ve just configured:


12. Click Create.

13. To test the connection, go back to the Welcome Screen. Click + New Data, then click the Connection tab. You will see your connection listed there. You can click on it and navigate to the file you want to import to Watson Analytics.

More Information:

Please review the relevant documentation on Secure Gateways and Data Connections