Q
Qlik SDK

Configuration

Configure the Qlik TypeScript SDK for different environments and use cases.

Constructor Options

The Qlik constructor accepts a configuration object with the following options:

Required Options

host: string
Required

The hostname of your Qlik environment.

typescript
// Qlik Cloud
host: 'your-tenant.us.qlikcloud.com'

// Qlik Sense Enterprise  
host: 'qlik-server.company.com'
webIntegrationId: string
Qlik Cloud only

Your Web Integration ID from the Qlik Cloud Management Console.

typescript
webIntegrationId: 'abcd1234-5678-90ef-ghij-klmnopqrstuv'

Optional Options

port: number

Custom port number. Defaults to 443 for HTTPS, 80 for HTTP.

typescript
port: 4848 // Common for Qlik Sense Enterprise
prefix: string

Virtual proxy prefix for Qlik Sense Enterprise.

typescript
prefix: '/my-virtual-proxy'
secure: boolean

Use HTTPS. Defaults to true.

typescript
secure: false // Only for development environments
identity: string

User identity for authentication context.

typescript
identity: 'DOMAIN\username' // Enterprise
identity: 'user@company.com' // Cloud

Environment Examples

Production Qlik Cloud Setup

Configuration for production Qlik Cloud environments

typescript
const qlik = new Qlik({
  host: 'company-prod.us.qlikcloud.com',
  webIntegrationId: process.env.QLIK_WEB_INTEGRATION_ID,
  identity: userSession.email,
  // Additional security options
  secure: true
});

Environment Variables

Recommended Setup

Create a .env file for sensitive configuration

bash
# .env
QLIK_HOST=your-tenant.us.qlikcloud.com
QLIK_WEB_INTEGRATION_ID=your-web-integration-id
QLIK_USER_IDENTITY=user@company.com
typescript
// Use in your application
const qlik = new Qlik({
  host: process.env.QLIK_HOST,
  webIntegrationId: process.env.QLIK_WEB_INTEGRATION_ID,
  identity: process.env.QLIK_USER_IDENTITY
});

Best Practices

Security

• Never commit Web Integration IDs to version control
• Use environment variables for sensitive configuration
• Enable HTTPS in production environments
• Validate user identity before authentication

Performance

• Reuse Qlik instances across your application
• Configure appropriate timeout values
• Use connection pooling for high-traffic applications
• Cache authentication tokens when possible