First-run setup

The first time you sign in with the administrator account you created during installation, KPImailer walks you through a 3-step setup wizard before showing the dashboard: license & company details, connecting Qlik Sense, and email delivery.

Permissions

The wizard only appears once, for that first administrator sign-in. If KPImailer is already set up for your organization, skip ahead to Signing in - and every screen in the wizard can be revisited later from Settings.

Steps

1. License & company details (Step 1 of 3)

Fill in Company name, Contact name, Contact email, Phone number, and Country, then select Next. Relevance Management uses these details for licensing and support - registering here is what activates your license, so this step can’t be skipped.

2. Connect Qlik Sense (Step 2 of 3)

Choose Add on-premise server, Add Qlik Cloud tenant, or both. Unlike Step 1, this step is optional - select Do it later to connect Qlik Sense afterwards from Settings → Qlik servers instead.

For an on-premise Qlik Sense Enterprise server, give it a Display name and Server URL, the User directory and Service account user KPImailer signs in as, and upload its client certificate (.pfx/.p12, exported from the QMC - see Installing → Exporting a client certificate).

For a Qlik Cloud tenant, give it a Display name and Tenant URL, then the OAuth client ID, Web integration ID, and OAuth client secret from the OAuth client and Web integration you create in that tenant - see Qlik servers → Setting up Qlik Cloud access for the exact steps in Qlik Cloud, including the minimum privileges to grant.

Either way, select Test connection before moving on - see Qlik servers for what each check verifies, and for editing or rotating credentials afterwards.

Note

For an on-premise server, Test connection also creates a dedicated virtual proxy named kpimailer in your Qlik Sense environment automatically, the first time it succeeds - nothing to set up in QMC yourself. KPImailer authenticates through this virtual proxy rather than your default hub proxy, so its sessions stay isolated from end users browsing Qlik Sense directly. Re-running Test connection later is safe; it only adjusts this virtual proxy if something about the connection has changed.

Note

For a Qlik Cloud tenant, Test connection similarly provisions a webhook subscription in that tenant the first time it succeeds, so Qlik Cloud app reload alerts fire the moment a reload finishes instead of KPImailer polling for it - see Setting up Qlik Cloud access for what privileges that requires.

3. Configure email delivery (Step 3 of 3)

Fill in your SMTP host, port, and security mode, a from address and display name, and the credentials your mail provider requires. Next stays disabled until Send test email succeeds - select Do it later instead if you’d rather configure email afterwards from Settings → Email.

Tip

Debug recipients is worth setting now: any address you add there gets a blind copy of every report and alert KPImailer sends, which is useful while you’re still configuring reports and want to see exactly what goes out.

Worked example

A typical first run looks like this: fill in the company’s details on Step 1 to activate the license, add the on-premise Qlik Sense server on Step 2 and confirm Test connection passes, then fill in the SMTP settings on Step 3 and send a test email to yourself. Once that test arrives, select Next to finish the wizard and land on the dashboard - from there, move on to signing in day to day and creating your first report.

Caution

Skipping Qlik Sense or email with Do it later doesn’t block you from exploring the app, but scheduled reports will fail at send time until both are configured - if a report isn’t running or arriving, Settings → Qlik servers and Settings → Email are the first places to check.