Advanced configuration of Qlik Web Connectors

You can adjust the default settings of the Qlik Web Connectors by changing the system settings in the system settings menu or by changing the configuration values in the deploy.config file, which you should find in the root of your Qlik Web Connectors folder.

Some of the common things you can change are:

  • The port number Qlik Web Connectors runs on (not recommended unless you have a specific application already using the default port of 5555).
  • Allow remote access (that is, from other machines on your network).
  • Allow local read/write access.
  • Setup the authentication and user accounts.
  • Setup details of a proxy server you connect to the internet through.
  • Configure the logging level.

Editing deploy.config

You will need to open the deploy.config in a text editor such as Notepad. The contents and location of deploy.config can be viewed in the System Settings page under Settings in the Qlik Web Connectors browser pages.

It is recommended that you backup the deploy.config file before editing it. When you have finished editing the file you will need to restart Qlik Web Connectors.

Port number

You can change the port number by editing this setting:

<Port>5555</Port>
Note:

It is recommended that you use the default port number 5555. Qlik Web Connectors require the default port number if they are installed on the same server as your Qlik platform installation. If a different port number must be used, it is recommended to install Qlik Web Connectors on another server.

Allow remote access

By default, the AllowRemoteAccess element is set to "false":

<!-- Whether to allow access from remote machines (i.e. non localhost). --> <AllowRemoteAccess>false</AllowRemoteAccess>

 

If you want to be able to log in to Qlik Web Connectors from other machines on your network and run loads from QlikView or Qlik Sense installations running on other machines you should set this to true but you must also change the Authentication type element from None. You might also need to whitelist addresses that will be accessing Qlik Web Connectors. This can be done in the My Settings page under Settings in the Qlik Web Connectors browser pages.

To learn more about user authentication, see Setting up user authentication for the Qlik Web Connectors.

Note: If you allow remote access you may also need to open up the firewall on the machine to allow TCP connections to be made through the port. Qlik Web Connectors is configured on port 5555 by default. Please contact your network/system administration for assistance.
Note: You can leave the Authentication type element set to None but this means that anybody will be able to browse to and use the Qlik Web Connectors installation (that is, there will be no security). This is not recommended.

Require SSL

If you are allowing remote access to Qlik Web Connectors it is recommended that you also set it up so that the traffic to and from Qlik Web Connectors is encrypted using SSL.

To do this set the RequireSSL element in deploy.config to true:

<RequireSSL>true</RequireSSL>

 

Note:

When you set the RequireSSL value to true, you have to create a certificate for the Qlik Web Connectors. If you do not create a certificate the Qlik Web Connectors will not run.

Creating an SSL certificate for the Qlik Web Connectors

Authentication

<Authentication> <Type>None</Type>

This can be changed to FormsAuthentication. This allows users to sign in to Qlik Web Connectors from other machines and generate load scripts which are secured with an access token and whitelisted IP addresses.

If you set this value to 'FormsAuthentication' then the following sections become relevant:

<FormsAuthentication> <CryptographyConfiguration> <!-- These values are used when encrypting the authentication cookies used for maintaining a users logged in status with Forms authentication. --> <RijndaelEncryptionProvider_Passphrase>SuperSecretPass123</RijndaelEncryptionProvider_Passphrase> <DefaultHmacProvider_Passphrase>UberSuperSecure123</DefaultHmacProvider_Passphrase> </CryptographyConfiguration> <!-- PlainTextPasswordChecker - User XML element should contain a Password element containing plain text password. SHA512PasswordChecker - User XML element should contain a PasswordHash element containing UTF8 SHA512 base 64 encoded password hash. SaltedPBKDF2SHA1PasswordChecker - Uses a salted hash. --> <PasswordChecker>PlainTextPasswordChecker</PasswordChecker> </FormsAuthentication>

And

<FormsUsers provider="FileBasedFormsUsersProvider" config="{app_root}/logins.xml"></FormsUsers>

Some sample deploy.config and logins.xml file pairs in the Sample Configs subdirectory of the Qlik Web Connectors with notes in a Readme.txt file.

The deploy.config and logins.xml files from the Sample Configs\Forms Auth and Remote Access directory sets Qlik Web Connectors up with two users and these configure Qlik Web Connectors for Forms Authentication, with remote access allowed and with the secure password management system (SaltedPBKDF2SHA1PasswordChecker).

When you have copied these into the Qlik Web Connectors root directory you should be able to log in with either:

admin@yourdomain.com

password01

or

user@yourdomain.com

password01

The first user has admin privileges. You can edit the element in logins.xml to be your own username or email address.

Once logged in as Admin, you can go to the user management screen to add or edit users. To learn more on managing Qlik Web Connectors users, see Managing multiple users for Qlik Web Connectors.

Proxy server

If you are behind a proxy you will need to set UseProxy to true. By default UseProxy is set to false.

<Proxy> <UseProxy>false</UseProxy> <ProxyAddress></ProxyAddress> <ProxyUsername></ProxyUsername> <ProxyDomain></ProxyDomain> <ProxyPassword></ProxyPassword> </Proxy>
Note:

The proxy address should contain only the hostname and optional port.

<ProxyAddress>myproxyhost:555</ProxyAddress>

Logging

You can change the logging level by changing the following element:

<!-- Valid values: Off, Trace, Info, Warn, Error --><LoggingLevel>Warn</LoggingLevel>

 

System wide log files will appear in the \Logs directory of the root folder. These are log files which cannot be related to a specifically defined system user.

User specific log files are logs relating to the activity of a particular user. The location of these is defined in the UserLogs section of the Providers section of deploy.config. By default this is:

{app_root}/App_Data/{user_guid}/Logs

<Providers> <!-- User specific log implementation. Note that the logging level is currently set using the LoggingLevel element in deploy.config and if this is set to Off it will also override this setting. --> <UserLogs enabled="true" provider="FileBasedLogger" config="{app_root}/App_Data/{user_name}/Logs"></UserLogs> <!-- User specific API call logger. --> <UserAPICallLogs enabled="true" provider="FileBasedLogger" config="{app_root}/App_Data/{user_name}/Logs/APICalls/{connector_id}"></UserAPICallLogs> </Providers>

 

Allow file system access for specified paths

Some connectors require read and write access for the local disk. Any connectors that download tables to the disk, upload files to a remote server, populate multiline input parameters from the disk, or make use any of the processParams methods, will require a defined FileSystemAccessAllowedPaths value. Multiple paths are separated by a semicolon. This element is blank by default which is equivalent to denying read and write access.

Examples:  

<FileSystemAccessAllowedPaths>c:\QWC\TempFiles;c:\Data</FileSystemAccessAllowedPaths> (multiple paths)
<FileSystemAccessAllowedPaths>c:\</FileSystemAccessAllowedPaths> (parent folder and all child folders and files)
<FileSystemAccessAllowedPaths>*</FileSystemAccessAllowedPaths> (all files)
<FileSystemAccessAllowedPaths></FileSystemAccessAllowedPaths> (none)

Allow local host access

Some connectors access their data sources from a host, such as a file server or mail host. The ConnectorConfig element controls whether the connector can access this data over the network. By default, each connector's AllowLocalHostAccess value is set to false.

<ConnectorConfig> <!-- Some connectors have connector specific configuration options which are managed here --> <Connector> <WebConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </WebConnector> <SugarCRMConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </SugarCRMConnector> <TextAnalyser_RepustateConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </TextAnalyser_RepustateConnector> <MongoDBConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </MongoDBConnector> <MSCRMConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </MSCRMConnector> <ODataConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </ODataConnector> <JIRAConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </JIRAConnector> <NotificationConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </NotificationConnector> <MailboxIMAPConnector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </MailboxIMAPConnector> <MailboxPOP3Connector> <AllowLocalHostAccess>false</AllowLocalHostAccess> </MailboxPOP3Connector> </Connector> </ConnectorConfig>

Did this information help you?

Thanks for letting us know. Is there anything you'd like to tell us about this topic?

Can you tell us why it did not help you and how we can improve it?