Qlik Sense Documents

[#1]

Qlik Sense QMC Utilities

A collection of management console utilities for use with Qlik Sense.

____________________________________________________________________________________________________________

Introduction

QMC Utilities is an application designed to assist with administration capabilities and workflows within the Qlik Sense platform. An open source project, QMC Utilities is built using the fully supported Qlik Sense APIs while taking advantage of your existing security modules.

Minimum Requirements

QMC Utilities requires the following environment to function properly:

• QMC Utilities must be installed on a server running Qlik Sense Enterprise or QAP software.
• Qlik Sense Enterprise 3.0 and higher **or** Qlik Analytics Platform 3.0 and higher.
• Qlik Sense service account for running the EA PowerTools service dispatcher.
• Ability to make requests to the Qlik Repository Service API on the Central Node using port 4242.
• An available port (by default port 9945) to connect to the QMC Utilities user interface.

Installation

The preferred method for installing QMC Utilities is the installer found here: QMCUtilities.exe. The installer includes includes all node and bower modules (npm not required).

For a walkthrough of the installation process, please have a look at the install documentation here: **(Installing QMC Utilities · eapowertools/QlikSenseQMCUtility Wiki · GitHub)**

QMC Utilities may be installed by downloading the source from GitHub and running npm install. However, some manual configuration of the config.js configuration file will be required before running if installed using this method. No documentation is provided for this method.

Security

QMC Utilities now uses Qlik Sense authentication to validate user access to the powertool. This will control the data that users see in each of the plugins. Future releases will have more robust control to show / hide plugins based on the user.

Usage

After installing QMC Utilities, open a web browser and navigate use the following URL format to access the interface:

"https://" + "<hostname>" + ":<port number used in installation>/" + "<virtual proxy name>/" + "qmcu/"

If using a default virtual proxy, the virtual proxy name can be excluded from the URL:

"https://" + "<hostname>" + ":<port number used in installation>/" +  "qmcu/"

Example 1 (default virtual proxy):

If the Qlik Sense hostname is sense3.112adams.local and the virtual proxy is default, in the browser address bar enter https://sense3.112adams.local:9945/qmcu/.

Example 2 (non-default virtual proxy):

If the Qlik Sense hostname is sense3.112adams.local and the virtual proxy is called "test", in the browser address bar enter https://sense3.112adams.local:9945/test/qmcu/.

Please note the trailing forward slash - it is very important so make sure to include it!

Plugins

QMC Utilities uses a plugin architecture to instantiate the tools in the menu framework.

Version 3.0 and above includes the following tools:

____________________________________________________________________________________________________________

App Meta Fetcher

App Meta Fetcher is used in conjunction with the Governed Metrics Application (included in the Governed Metrics Service installation). This plugin outputs Site-level application metadata into a collection of csv files which can be used to identify application, master and non-master item, visualization, and sheet metadata.

Documentation Link

____________________________________________________________________________________________________________

App Mover

App Mover is a tool to help administer application movement from site to site. It allows exporting from one Qlik Sense environment and importing into 1 or many Qlik Sense environments.

Please note that owner information will not traverse between sites.

Documentation Link

____________________________________________________________________________________________________________

App Object Approver

The App Object Approver enables approval of published sheets, stories, bookmarks, dimensions, measures, and Master Items in an app, thus, making them base objects of the Qlik Sense application. In addition, it's possible to un-approve objects as well and push them back to the community.

To approve or un-approve objects, qualifying items will have a clear checkbox. Click the checkbox to activate and then select the appropriate approve or un-approve button that is relevant to the selections made.

Documentation Link

___________________________________________________________________________________________________________

Custom Property Bulk Loader

The Custom Property Bulk Loader enables administrators to upload a list of values for managing custom properties without having to enter values manually.The bulk loader is able to update existing custom properties, or create new custom properties for a Qlik Sense deployment.

Select a custom property or provide a name, select the resources the custom property will apply to, and upload a csv file with a single column list of values. Once that's done click the Create or Update button and to add or modify the custom property.

Documentation Link

____________________________________________________________________________________________________________

Real QMC

The Real QMC is exactly that - the QMC embedded into the QMC Utilities. Enjoy all the security and functionality of the real QMC directly from within the QMC Utilities.

Documentation Link

____________________________________________________________________________________________________________

Security Rule Manager

The Security Rule Manager allows a Qlik Sense administrator to export and import security rules from the Qlik Sense repository. This is helpful if you have developed a security model in one environment and would like to bring the whole model (or even specific security rules) over to a different environment.

Documentation Link

____________________________________________________________________________________________________________

Source Control Assistant

The Source Control Assistant is an application backup and restore solution for Qlik Sense.  Apps are serialized to json files, which can be easily stored and versioned in popular source control systems like Subversion, TFS, and Github.

Documentation Link

____________________________________________________________________________________________________________

License

EA Power Tools are a collection of software programs and methodologies for Qlik products. EA Power Tools and QMC Utilities are provided free of charge and are not supported by Qlik. EA Power Tools and QMC Utilities use Qlik APIs, but are open source solutions provided without warranty. Use of EA Power Tools and QMC Utilities is at your own risk.

Issues

If you experience an issue, open an issue! We want your feedback! Open an issue here: Issues

[diogoguilhen]

i come to see EAPowerTools  log, and show this:

Date Log Level Service Message

2017-05-09T21:36:20.140Z INFO EAPowerToolsService Starting up the EAPowerTools Service Manager.

2017-05-09T21:36:20.156Z INFO EAPowerToolsService Using default value of 'Info' for log level

2017-05-09T21:36:20.156Z INFO EAPowerToolsService Could not parse service 'The file path 'C:\Program Files\Qlik\Sense\EAPowerTools\iportal\server.js' for service 'iPortal' is not valid (likely does not exist).' because: 'The file path 'C:\Program Files\Qlik\Sense\EAPowerTools\iportal\server.js' for service 'iPortal' is not valid (likely does not exist).'

2017-05-09T21:36:20.156Z INFO EAPowerToolsService Found service 'QMCUtilities' in config file.

2017-05-09T21:36:20.156Z INFO EAPowerToolsService Starting service: QMCUtilities

[#3]

Hi Diogo,

you are experiencing two issues.

The first is that when you go to qmc utilities you need to make sure there is a trailing slash "/" after qmcu. If you don't have one you will get this error.

Second problem.  Because winhttp failed, the qmculogin.html stub page did not get loaded into the content library of the repository.  Go to QMC and upload the qmculogin.html page to the default content library.  The qmculogin.html file is located in the EAPowertools\QMCUtilities directory.

Hope this helps.

If you experience further issues, please open them on github here: Issues · eapowertools/QlikSenseQMCUtility · GitHub

[diogoguilhen]

thx, is ruinning, ITS ALIVE! lol!

but i need a help with certificate error.... mismatched Address... THx !

[boryspower]

Hi jog‌,

About the App Mover - I cannot test it right now, but reading the readme file it looks that it exports/uploads/imports apps. The standard "issue" for me is that apps exported from QMC does not have connections included and after importing them to the second server the connections has to be added manually... Does your tool has some workaround for this?

Regards,

Przemyslaw

[#6]

Data Connections is a tricky thing.  There is not really a good way to automate this right now.  Through AppMover it's not likely to work.  SC Lite might be a better solution because I think it moves connections as well.

[ralph_graham]

jog‌ Is there anyway to change the default location of where the installer looks for the ServiceDispatcher\services.conf file? In one of my installations it is in the E drive, rather than C...

Thanks,

Ralph

[reshma_km]

jog ralph_graham‌ I also have this problem. My installation is in G drive. When I gave G drive folder for installation path, I am not able to launch QMC utilities. Otherwise, its not getting installed.

[reshma_km]

When I change the default installation path to G drive folder, I am not able to launch QMC Utilities. Otherwise, I am not able to install it.

[korsikov]

Hi there,

How change SSL cert for QMCUtilities? I had ssl certificate for my domain? I'm already change a var friendlyHostname = "amur.work.com";

I was found in C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities

Server.js

--

var httpsOptions = {}

if (config.thisServer.hasOwnProperty("certificates")) {
if (config.thisServer.certificates.server !== undefined) {
//pem files in use
httpsOptions.cert = fs.readFileSync(config.thisServer.certificates.server);
httpsOptions.key = fs.readFileSync(config.thisServer.certificates.server_key);
}

if (config.thisServer.certificates.pfx !== undefined) {
httpsOptions.pfx = fs.readFileSync(config.thisServer.certificates.pfx);
httpsOptions.passphrase = config.thisServer.certificates.passphrase;
}
} else {
httpsOptions.cert = fs.readFileSync(config.certificates.server),
httpsOptions.key = fs.readFileSync(config.certificates.server_key)
}

--

and in C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\config\config.js

--

thisServer: {
devMode: false,
port: 9945,
hostname: friendlyHostname !== undefined ? friendlyHostname : globalHostname,
routePath: path.join(__dirname, '/../routes/'),
publicPath: path.join(__dirname, '/../public/'),
bowerPath: path.join(__dirname, '/../bower_components/'),
nodeModulesPath: path.join(__dirname, '/../node_modules/'),
dataPath: path.join(__dirname, '/../data/'),
appPath: path.join(__dirname, '/../app/'),
pluginPath: path.join(__dirname, '/../plugins/')

--

What I need to change?

[dayashankar]

Hi Team,

Facing below error message once i open QMCU link.

https://localhost:9945/qmcu

Application:- QlikSense June 2018

Error:-

TypeError: Cannot read property 'sessionCookieHeaderName' of undefined
at C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\middleware\auth.js:38:50
at Layer.handle [as handle_request] (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\layer.js:95:5)
at trim_prefix (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:317:13)
at C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:284:7
at Function.process_params (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:335:12)
at next (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:275:10)
at C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\middleware\rewrite.js:36:9
at Layer.handle [as handle_request] (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\layer.js:95:5)
at trim_prefix (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:317:13)
at C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:284:7
at Function.process_params (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:335:12)
at next (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\express\lib\router\index.js:275:10)
at C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\middleware\vpList.js:38:17
at tryCatcher (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\util.js:16:23)
at Promise._settlePromiseFromHandler (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\promise.js:512:31)
at Promise._settlePromise (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\promise.js:569:18)
at Promise._settlePromise0 (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\promise.js:614:10)
at Promise._settlePromises (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\promise.js:693:18)
at Async._drainQueue (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\async.js:133:16)
at Async._drainQueues (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\async.js:143:10)
at Immediate.Async.drainQueues (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\async.js:17:14)
at runCallback (timers.js:672:20)
at tryOnImmediate (timers.js:645:5)
at processImmediate [as _immediateCallback] (timers.js:617:5)

Regards,

Daya Jha