If you're setting up a Qlik Sense multi-node environment to work with Vizlib Server you need to make configuration changes both the Vizlib Management Console (VMC) and the Qlik Management Console (QMC). This article contains instructions on configuring virtual proxies in the QMC. You can find instructions on the VMC configuration for a multi-node environment here and the Vizlib Server configuration reference here.
TABLE OF CONTENTS
- Example Configuration
- Creating a Virtual Proxy
- Session Cookie Domain
- Prefix and Additional Settings
- Session Cookie Header Name
- Linking to the Default Virtual Proxy
- Configuring the Remaining Nodes
This article uses an example configuration where the Central node in a Qlik Sense multi-node environment still has its default settings (no virtual proxies have been created).
Note: Any variables used to describe the configuration in this article (including in screenshots) are for demonstration purposes only.
The reason for configuring virtual proxies relates to sharing cookies with Vizlib Server. The Session Cookie Domain property in a default virtual proxy is read-only, but if it retains the read-only setting access to the system will be denied, locking out all users. To resolve this, a virtual proxy (not the default) needs to be configured which allows access via a change to the Session Cookie Domain. This can be done by either creating a new virtual proxy, or modifying an existing one.
Before you start the configuration, make sure you've gone through the items on this checklist, completing each process and collecting each piece of information.
- Check you have a QMC user account with permissions to add and change node settings.
- Vizlib Server needs to have a DNS name equal to (or sharing) the same domain name as the Qlik Sense user environment. Note: We advise using a different DNS name to the host name.
- All ports used in the configuration architecture should be opened to the firewall and the network needs to be configured correctly.
- Create a naming system to group your virtual proxies clearly. Note: The values in this example are for demonstration only, the QMC will allow you to enter your own values for each step.
- Establish how many virtual proxies will be needed. For each default virtual proxy you are using as part of your account, you will need to create a duplicate virtual proxy e.g. if you use 4 default virtual proxies, you will need to create 4 more, for a total of 8.
- Confirm which default virtual proxy node needs to be linked to each new virtual proxy.
- Check if virtual proxies are already set up and in use. If non-default virtual proxies are already created, you'll only need to change the session cookie domain to complete the configuration.
- Note the configuration of each default virtual proxy as you will need to enter these settings for the new virtual proxy.
- Check which proxy link which needs to be added to the new virtual proxy e.g. if the default virtual proxy contains a proxy link to the Central node, the new virtual proxy must have the exact same link.
Figure 1 shows the example configuration, with one Central node (Central) and two additional nodes (Rim_Node_01 and Rim_Node_02).
Figure 1: Initial Node Configuration
Creating a Virtual Proxy
- In the QMC, open the Virtual Proxies settings.
- Click Create New to create the new virtual proxy (Figure 2), which will mirror the settings for the Central Node.
Figure 2: Create New Virtual Proxy
Session Cookie Domain
- Select the Advanced properties from the menu on the right.
- Add the virtual proxy name in Description.
- Add the domain name you need to use in the Session Cookie Domain field (Figure 3). This setting will enable cookies to shared between the main domain and any subdomains.
Figure 3: Session Cookie Domain
Prefix and Additional Settings - Testing
- Add a unique Prefix to the duplicated virtual proxy for testing purposes (Figure 4).
Figure 4: Prefix
- Open the Identification settings and change the Session cookie header name of your new virtual proxy (Figure 5). You need to enter a unique value here, as you can't link to the default virtual proxy with a name that's already being used and will return an error if you try.
Figure 5: Session Cookie Header Name
- Enter any additional settings to match the new virtual proxy configuration to the default virtual proxy configuration.
- Click Apply to save your settings and create the new virtual proxy.
- Test the new duplicated virtual proxy with the updated configuration, and confirm the connection to the Qlik Sense Hub and Vizlib Server is working as expected.
- Change the prefix for the default virtual proxy to a value which isn't used in user connections (defaults and duplicates cannot share the same prefix). Repeat this step for the Session Cookie Header Name.
- Change the prefix for the duplicate virtual proxy to the original value in the default virtual proxy. Repeat this step for the Session Cookie Header Name.
Linking to the Default Virtual Proxy
Once you've entered a unique Session cookie header name you can link the new virtual proxy to the relevant default virtual proxy.
- Click the virtual proxy Description to open edit mode.
- Select Proxies from the Associated items settings.
- Select Link at the bottom of the page (Figure 6) to open the Select proxy services menu.
- Select the Node you want to link to from the list.
Figure 6: Proxies
The new virtual proxy has now been created successfully.
Configuring the Remaining Nodes
To configure any remaining nodes, (Rim_Node1 and Rim_Node2 in this example) you can use this article by returning to Creating a Virtual Proxy and following the same steps for the other default virtual proxies. Figure 7 shows the completed configuration as it would appear in the QMC.
Figure 7: Complete Configuration
The Vizlib Server Configuration article contains more information on post-install checks to ensure your installation has completed successfully.