Qlik Community

Qlik Sense Enterprise Documents

Documents for Qlik Sense related information.

Qlik Sense QMC Utilities

Not applicable

Qlik Sense QMC Utilities

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

Comments
trappersw
Contributor

Hi Jeffrey, looks great!

I would like to implement it at a client of ours, but I'm wondering if Qlik supports this? Will the utilities be kept up to date with changes to the API in future versions? Thanks

Not applicable

Wouter,

my team supports the tools.  The Qlik APIs used to build the tools are supported by Qlik.  We update the tools regularly based on issues users open on Github and changes to the APIs.

Regards,

Jeff G

greatsouls
New Contributor

Not sure why my comment that the link in the article pointing to the installation document is broken has been rejected by a moderator.

Can somebody fix that link or provide a link to the installation document?

Thank you,

Not applicable

Emil, the link is there, but unfortunately I haven't completed the install doc.  The installer is really straight forward and easy to use.  Hope to have the install doc sometime the week after next.

jg

greatsouls
New Contributor

Thank you, Jeff.

Emil

emilrnge2
New Contributor II

I had some problem launch QMC Utilities.

I believe the reason was because I had enter invalid Service Account Id and/or Service Account Password when setting up EA Powertools Service Dispatcher but got the feedback "Started the Service Dispatcher" and could continue finish the installer without realize I had enter invalid credentials.

I guess this is a bug. I just wanted to inform you this.

plexpro52
Contributor

The link at:

For a walkthrough of the installation process, please have a look at the install documentation here: **[Install Document](https://linktoInstallDocument)**

...doesn't work; it appears to contain a stub that never got filled in...

I just finished reading the other comments and I see that it is awaiting attention.

Thanks.

ahmedadmin
New Contributor III

This Tool Looks very Promising. Thansk you Jeff.

It will be great if you can add the login / secure page.

fmarvnnt
Contributor

Tested with QS 3.1.5 and 3.2.1 by exporting / importing duplicating / republish for objects of type: sheet, story and bookmark and it works (both with generic users and rootAdmin). I did not do an exhaustive test by accessing the console from a different machines and for the other functionalities.. A nice job.

diogoguilhen
New Contributor III

I do the step by step into this link: https://github.com/eapowertools/QlikSenseQMCUtility/wiki/Installing-QMC-Utilities
but, i cant access because this 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 [as _onImmediate] (C:\Program Files\Qlik\Sense\EAPowerTools\QMCUtilities\node_modules\bluebird\js\release\async.js:17:14) at processImmediate [as _immediateCallback] (timers.js:383:17)

when i finish the installation shows this error :
'WinHttp.WinHttpRequest: The server name or address could not be resolved The authentication stub page qmculogin.html needs to be added to QMC content library manually.'

plz can help me?

Version history
Revision #:
1 of 1
Last update:
‎10-06-2016 02:24 PM
Updated by: