Add Server
The server configuration section allows you to add and manage servers within the Code Management application. This includes setting up connections to Qlik Enterprise or Qlik SaaS environments, configuring server details, and ensuring proper communication between the application and the servers. This guide provides detailed instructions for adding a server to the Code Management platform.
Info
(Only for Qlik Enterprise) The user must whitelist ports "4747" (Qlik engine port) and "4242" (Qlik repository service port) in the firewall to access the Qlik sense server through Code Management.
Creation of Server
- Login to the Code Management, Navigate to the Settings section, open the "Servers" page. If you are creating your first server, the following page will appear. Click on Add new.
- If servers already exist on the Servers page, click the Action button at the top right corner, then click New server to initiate the creation of a new server.
Server creation thorugh Qlik Enterprise
Step 1: Upon clicking 'New server', a panel titled Add server will slide in from the right. Input the essential details:
- Name: Enter the server name.
- Environment Type: Select On-premise for Qlik Enterprise.
- Host Name: Enter the host name.
- Port: (Only for On-premise) Enter the port number. The default port "443" is provided, but if you changed the port in the central node of QMC proxies, add that port.
- Qlik Root Admin: Enter the Qlik root admin credentials.
- Certificates: Add the
root.pem
,client.pem
, andclient_key.pem
certificates from the Qlik certificate. You can find Qlik certificates in theC:\ProgramData\Qlik\Sense\Repository\Exported Certificates
path. - Qlik Hub URL: This is required if you are using the server for SSO. Add the URL in the form
https://<qlik-hub-url>/<virtual-proxy>
.
Step 2: Check the details provided and click "Test connection" to test the connection. A popup message will appear saying "Test successful". Click "Save" to save the server.
Server creation through Qlik SaaS
Step 1: Upon clicking 'New server', a panel titled Add server will slide in from the right. Input the essential details:
- Name: Enter the server name.
- Environment Type: Select SaaS for Qlik SaaS.
- Tenant: Enter the host name from url.
- User mail: Enter the mail Id of the user.
- Web Integration Id: Paste the web integration Id from Qlik SaaS. To generate Web Integration Id go through Web-Integration id Generation guide.
- Client Id and Client Secret: Paste the Client Id and Client secret key from Qlik SaaS. To generate these, refer OAuth-generation guide.
Step 2: Review the details and click Test connection to verify connectivity. If the test is successful, click Save to add the server.
Viewing Created Servers
After creating a server, the newly added server becomes accessible from the Server page. This page presents a comprehensive list of all created servers, featuring essential details like Server name, type, Host, Created by, and Actions.
You can Edit or Delete the servers by using the actions available for each specific server.
Web Integration Id generation
To generate web integration Id, follow the below steps:
1. Log in to Qlik SaaS Administration.
2. Go to Administration, then click on Web.
3. Select Create new on top right corner.
4. Fill the given details like name and add the Origins. Click "Create" to create the Web id.
5. Copy the Web Integration Id from the three dots and paste it in the server creation step.
OAuth generation
To generate a Client Secret, follow these steps:
1. Log in to Qlik SaaS Administration.
2. Go to Administration, then click on OAuth.
3. Select Create new on top right corner.
4. Fill in the details below,
- Client type: Since it is a web integration - select Web, other available types "Single-page app".
- Name: Give a appropriate name of OAuth.
- Description: Add the description for the OAuth.
- Scope: Specifically select user_default, apps, app.data:export,users scopes.
- Add redirectURLs: Add the redirecting URLs for the OAuth.
- Add allowed origins: Add the path that are allowed to access thig OAuth. For example -
http://localhost:5010
. - Check Allow Machine to Machine (M2M) and Allow M2M user impersonation.
- Finally click on Create button to create web integration and get Client Id and one time generation Client Secret (Store the Client Secret).
- After the OAuth is created, set the consent method to trusted. To do this, click on the three dots of the created OAuth.
- Select the option Change consent method and change it to trusted.