Professional Documents
Culture Documents
QlikSense
1.1
Copyright1993-2015QlikTechInternationalAB.Allrightsreserved.
Contents
1 Introduction
1.1Supportservices
1.2QlikDeploymentConsoleconventions
Stylecoding
Environmentvariables
1.3Additionaldocumentation
6
6
7
2.1QlikDeploymentConsole
2.2Localusergroup
Groupmembership
CreatingthelocalusergroupbeforeinstallingtheQDC
2.3QlikSenseinstances
8
9
9
2.4Ports
11
12
4.1QlikDeploymentConsolestartpage
12
5 Sites
14
5.1Sitesview
14
5.2Creatingsites
19
Siteconfiguration
5.3Incorporatingsites
20
20
Siteconnection
5.4Deletingsites
21
22
5.5Creatinginstancetemplates
22
Templateconfiguration
5.6Deletinginstancetemplates
23
23
5.7Creatinginstances
23
5.8Deletinginstances
24
5.9StartingQlikManagementConsoleonthecentralnode
24
5.10Connectingtoaremotedesktop
24
5.11Displayingstatusinformation
24
6 Plug-ins
26
6.1Plug-insview
26
6.2Registeringplug-ins
26
6.3Deletingplug-ins
27
7 Tasks
28
7.1Tasksview
28
7.2Creatingtasks
29
7.3Deletingtasks
29
7.4Transferringapps
29
Transferrules
8 Qlik Sense setup files
30
31
Contents
8.1QlikSensesetupfilesview
31
8.2UploadingQlikSensesetupfiles
32
8.3DeletingQlikSensesetupfiles
32
9 Objects
33
9.1Objectsview
33
9.2Creatingobjects
33
Licenseobject
9.3Deletingobjects
34
34
35
10.1Storage
35
10.2Naming
35
11 Troubleshooting
36
11.1CannotstarttheQlikDeploymentConsole
36
11.2RepairingtheQlikDeploymentConsole
37
38
1 Introduction
Introduction
ThisguidedescribestheQlikDeploymentConsole(QDC),whichisusedtocreateandmanageQlikSense
sitesthataredeployedincloudcomputingenvironments.
ThisdocumentisderivedfromtheonlinehelpforQlikSense.Itisintendedforthosewhowanttoreadparts
ofthehelpofflineorprintpageseasily,anddoesnotincludeanyadditionalinformationcomparedwiththe
onlinehelp.
UsingtheQDC,youcan:
l CreateandmanageQlikSensesitesthataredeployedincloudcomputingenvironments
l IncorporateexistingsitesforuseintheQDC
l Createandmanageinstancetemplatesthatsimplifytheadditionofnewinstances(thatis,nodes)to
sitesthataredeployedincloudcomputingenvironments
l Monitorthestatusofsitesthataredeployedincloudcomputingenvironments
l Managetheplug-insthatareusedtoprovidedifferentcloudcomputingenvironmentsforyourQlik
Sensesites
l Createtasksthatareusedtotransferappsbetweensitesthataredeployedincloudcomputing
environments
l ManagedifferentversionsoftheQlikSensesetupfiles,whichallowsdifferentsitestousedifferent
versionsofQlikSense
l Createandmanageobjectsthatcontaindifferentsettingsfortheplug-insandcloudcomputing
environments
TheexamplebelowshowshowtheQDCcanbeusedtomanagemultiplesitesthataredeployedindifferent
cloudcomputingenvironments.Thesitesarelogicallyseparatedfromeachother.
1 Introduction
Short form
Description
QRS
QlikSenseRepositoryService
QPS
QlikSenseProxyService
QSS
QlikSenseSchedulerService
QES
QlikSenseEngineService
QMC
QlikManagementConsole
SeetheServerDeploymentandConfigurationfordetailedinformationontheQlikSensearchitecture.
1.1 Supportservices
ContactQlikifproductsupport,additionaltraining,orconsultationconcerningapplicationdevelopmentis
needed.ConsulttheQlikhomepageforcurrentinformationonhowtogetintouchwiththesupportservices:
www.qlik.com
Global headquarters
Qlik
150N.RadnorChesterRoad
SuiteE220
Radnor,PA19087
USA
Phone
+1(888)828-9768
Fax
+1(610)975-5987
Forotherlocations,visittheQlikhomepage(seeabove).
1.2 QlikDeploymentConsoleconventions
ThefollowingconventionsareusedinthedescriptionoftheQlikDeploymentConsole(QDC).
Stylecoding
l Menucommandsanddialogoptionsarewritteninbold.
l Filenamesandpathsarewritteninitalic.
l SamplecodeiswritteninLucida Console.
Environmentvariables
ThepathsusedinthedescriptionoftheQDCmayuseenvironmentvariables.Thevariablesandthe
equivalentpathsintheMicrosoftWindowsoperatingsystemarelistedbelow.
1 Introduction
Environment variable
Microsoft Windows
%LocalAppData%
C:\Users\<username>\AppData\Local
%ProgramData%
C:\ProgramData
%ProgramFiles%
C:\Program Files
%UserProfile%
C:\Users\<username>
1.3 Additionaldocumentation
Besidesthisdocument,thefollowingdocumentationisavailablefortheQlikDeploymentConsole(QDC):
l AWSPlug-inGuide:DescribestheAmazonWebServices(AWS)plug-in,includingthepartsinthe
QDCthatarespecifictotheAWSplug-in.
l ServerDeploymentandConfiguration:DescribesQlikSenseandprovidesreferenceinformationon
thearchitecture,security,logging,andlicensing.
QlikDeploymentConsolesystem
requirements
ThissectionliststhesystemrequirementsfortheQlikDeploymentConsole(QDC)andtheQlikSense
instances,respectively.
2.1 QlikDeploymentConsole
Thissectionliststherequirementsthatmustbefulfilledbythetargetsysteminordertosuccessfullyinstall
andruntheQDC.
MicrosoftWindows7(64-bitversiononly)
MicrosoftWindows8.1(64-bitversiononly)
Platforms
MicrosoftWindowsServer2008R2
MicrosoftWindowsServer2012
Processors (CPUs)
IntelCore2Duoorhigher
Memory
4GBminimum
Disk space
500MBtotalrequiredtoinstall
.NET framework
4.5
2.2 Localusergroup
TheQlikDeploymentConsole(QDC)clientandserverarebydefaultinstalledonthesamemachineand
communicateusingthehttpprotocol.
AllQDCusersmustbemembersofalocalusergroup,QlikDeploymentAdministrators,inMicrosoft
WindowsonthemachinewheretheQDCserverisdeployed.
Groupmembership
ThefollowingtabledescribeshowtheQlikDeploymentAdministratorsgroupishandledbytheQDC.
Group
status
Group membership
Thegroup ThegroupiscreatedwhentheQDCclientcallstheQDCserverforthefirsttime.Theuser
doesnot
thatrunstheclientautomaticallybecomesamemberofthegroup.Additionalmembersare
exist
addedusingtheLocal Users and Groupssnap-inintheMicrosoftManagementConsole
(MMC).
CreatingthelocalusergroupbeforeinstallingtheQDC
TheQlikDeploymentAdministratorsgroupcanbecreatedandpopulatedbeforetheQDCisinstalled.
Proceedasfollows:
1. StarttheMicrosoftManagementConsole(MMC).
2. SelectFile> Add/Remove Snap-in.
3. SelectLocal Users and GroupsintheAvailable snap-inslist.
4. SelectAdd >.
5. SelectLocal computerandthenclickFinish.
TheLocal users and groupssnap-inisdisplayedintheSelected snap-inslist.
6. ClickOK.
7. ExpandLocal Users and Groups (Local).
8. Right-clickGroupsandselectNew Group.
9. CreateanewusergroupcalledQlik Deployment AdministratorsandaddallQDCuserstothenew
group.
10. ClickCreateandthenClose.
11. Checkthatthenewgroupisdisplayedinthelistofgroups.
12. AllusersintheQlikDeploymentAdministratorsgroupneedtologoffandthenlogonagainforthe
groupmembershiptotakeeffect.
2.3 QlikSenseinstances
TherequirementsforinstancesmightdifferbetweendifferentversionsofQlikSense.
SeetheInstallationGuideforQlikSenseforinformationontherequirementsthatmustbefulfilledbyan
instance(thatis,anodeinaQlikSensesite).
2.4 Ports
MakesurethattheportslistedbelowareavailablefortheQDCtouse.
ThefollowingportsareusedforcommunicationbytheQDC:
10
InstallingtheQlikDeploymentConsole
ProceedasfollowstoinstalltheQlikDeploymentConsole(QDC):
1. Double-clicktheQDCinstallationfile.
TheQlikDeploymentConsolesetupwizardstarts.
2. ClickNext.
TheEnd-userlicenseagreementisdisplayed.
3. ChecktheI accept the terms in the License Agreementbox.
4. ClickNext.
5. ClickInstall.
TheQDCisinstalled.
6. ClickFinish.
See also:
p Starting the Qlik Deployment Console (page 12)
11
StartingtheQlikDeploymentConsole
Deployment Console.
The user that runs the QDC must be a member of the Qlik Deployment Administrators group.
See Local user group (page 8).
See also:
p Cannot start the Qlik Deployment Console (page 36)
4.1 QlikDeploymentConsolestartpage
TheQlikDeploymentConsole(QDC)startpageprovidesanoverviewoftheQlikSensecloudenvironment.
Thetopbarisalwaysdisplayed.
ClickqQlik Deployment Consoletorefreshthestartpageorgotoit,ifitisnotcurrently
displayed.
ClickDHelptoopentheQDChelp.
12
Theleftpanelisalwaysdisplayedandcontainsshortcutstotheresourcesthatcanbemanagedinthe
QDC.Selectaresourcetodisplaydetailedinformationonit.
TheworkareaprovidesinformationontheQlikSensecloudcomputingenvironment.
Sites
AQlikSensesiteisacollectionofoneormoreinstances(thatis,nodes)connectedtoa
commonlogicalrepositoryorcentralnode.
TheSitesviewprovidesanoverviewoftheQlikSensesitesthataremaintainedbythe
QlikDeploymentConsole(QDC).(x)indicatesthecurrentnumberofsites.
Plugins
Plug-insareusedintheQlikDeploymentConsole(QDC)todeployQlikSensesitesin
differentcloudcomputingenvironments.Aplug-inconsistsofoneormoremodules,
eachofwhichincludescertainfunctionality(forexample,credentials)relatedtothe
cloudcomputingenvironment.
ThePlug-insviewprovidesanoverviewoftheplug-insthatareregisteredintheQlik
DeploymentConsole(QDC).(x)indicatesthecurrentnumberofplug-ins.
Tasks
TasksareusedtotransferappsfromonesiteandstreamtoanothersiteintheQlik
DeploymentConsole(QDC).
Qlik
TheQlikDeploymentConsole(QDC)supportstheuseofmultipleversionsofQlik
Sense,whichmeansthatdifferentsitescanusedifferentversionsofQlikSense.Thisis
accomplishedbyuploadingdifferentversionsoftheQlikSensesetupfiletotheQDC.
Sense
setup
files
Objects
Anobjectisusedtoholdacertaintypeofinformationrelatedtoaspecificplug-inor
cloudcomputingenvironment.
TheObjectsviewprovidesanoverviewoftheobjectsthatareavailableintheQlik
DeploymentConsole(QDC).(x)indicatesthecurrentnumberofobjects.
Selectaresourcetodisplaydetailedinformationonit.
See also:
p Sites (page 14)
p Plug-ins (page 26)
p Tasks (page 28)
p Qlik Sense setup files (page 31)
p Objects (page 33)
13
5 Sites
Sites
AQlikSensesiteisacollectionofoneormoreinstances(thatis,nodes)connectedtoacommonlogical
repositoryorcentralnode.Appdataandallnecessarymeta-dataaresynchronizedbetweenthecentralnode
andtheinstancesusingasynchronouscommunication.
SeetheServerDeploymentandConfigurationfordetailedinformationontheQlikSensearchitecture.
5.1 Sitesview
TheSitesviewprovidesanoverviewoftheQlikSensesitesthataremaintainedbytheQlikDeployment
Console(QDC).
14
5 Sites
A
AlistofthesitesthataremaintainedbytheQDC.
Theiconindicatesthestatusofthesite.
l
(running):Allpartsofthesite(centralnode,instances,andtemplates)areupand
running.
l
l
(notrunning):Oneormorepartsofthesitearenotupandrunning.
(error):Anerrorhasoccurredsomewhereinthesite.
Selectasitetodisplaydetailedinformationonit.
Clicktodeleteasite.
Thisareaprovidesdetailsontheselectedsite.
Site name
Thenameofthesite.
Qlik Sense
ThefileversionoftheQlikSensesetupfilethatisusedforthesite.SeeQlik
version
No. of
Thenumberofinstancesinthesite(includingthecentralnode).
instances
ClickOpen QMCtostarttheQlikManagementConsole(QMC)onthecentralnodeinthe
selectedsite.
15
5 Sites
C
Thisareaprovidesdetailsonthecentralnodeintheselectedsite.
UseUandStoshowandhideinformation.
Theiconindicatesthestatusofthecentralnode.
l
l
l
(running):Thecentralnodeisupandrunning.
(notrunning):Thecentralnodeisnotupandrunning.
(error):Anerrorhasoccurredonthecentralnode.ClickError informationtodisplay
anyerrormessages.
ClickRemote desktoptoopenaremotedesktoptothemachineonwhichtheinstance(thatis,
node)isdeployed.SeeConnecting to a remote desktop (page 24).
Configuration summary
Thefirstfieldsarecommonforallsites.
Created
Thedateandtimewhentheinstance(thatis,node)wascreated.
Environment
Thenameoftheplug-inthatwasusedtodeploythesite.
name
Public IP
TheIPnumberofthemachineonwhichtheinstance(thatis,node)is
deployed.
Public DNS
TheDNSofthemachineonwhichtheinstance(thatis,node)is
deployed.
ThefollowingfieldsareonlydisplayedforsitesthathavebeencreatedusingtheQDC.These
fieldsarenotdisplayedforsitesthathavebeenincorporatedintotheQDCusingIncorporating
Thenameofthesite.
License
ThenameoftheQlikSenselicenseobjectused.
ThefileversionoftheQlikSensesetupfilethatisusedforthesite.
Therestofthefieldsarespecificforthecloudcomputingenvironmentanddependonthepluginused.Forinformationspecifictoyourplug-in,seethedocumentationfortheplug-in.
16
5 Sites
Service status - Central node
Proxy
ThestatusoftheQlikSenseProxyService(QPS)asreportedbytheQRSon
thecentralnode.
Repository
ThestatusoftheQlikSenseRepositoryService(QRS)onthecentralnode.
Thestatusmayindicateproblemsif:
l
l
l
l
l
Therepositorydatabaseisunavailableorincorrect
Arefreshisneeded
TheIPnumberisincorrect
Theportisincorrectorclosed
Thecertificateisincorrectormissing
Engine
ThestatusoftheQlikSenseEngineService(QES)asreportedbytheQRSon
thecentralnode.
Scheduler
ThestatusoftheQlikSenseSchedulerService(QSS)asreportedbytheQRS
onthecentralnode.
TheiconsindicatethestatusoftheQlikSenseservicesrunningontheinstance(thatis,node):
(running):Theserviceisupandrunning.
(notrunning):Theserviceisnotupandrunning.
(error):Anerroroccurredwhendeployingtheserviceonthemachine.
ClickPCreate new instance templatetocreateatemplatethatsimplifiestheadditionof
l
l
l
newinstances(thatis,nodes)totheselectedsite.
17
5 Sites
E
Thisareaprovidesdetailsontheexistinginstancetemplatesfortheselectedsite.
Instances
Thenumberofinstances(thatis,nodes),basedonthetemplate,thatare
deployedintheselectedsite.
UseUandStoshowandhideinformation.
Clicktodeleteatemplate.
Thedateandtimewhenthetemplatewascreated.
Environment
Thenameoftheplug-inthatwasusedtocreatethetemplate.
name
Services
TheQlikSenseservicesthatareincludedininstances(thatis,nodes)based
onthetemplate:
l
l
l
l
Template
Repository(mandatory)
Engine(mandatory)
Proxy(optional)
Scheduler(optional)
Thenameofthetemplate.
name
Repository
WhetherornottheQlikSenseRepositoryService(QRS)hasbeenselected
forinclusioninthetemplate.
Engine
WhetherornottheQlikSenseEngineService(QES)hasbeenselectedfor
inclusioninthetemplate.
Proxy
WhetherornottheQlikSenseProxyService(QPS)hasbeenselectedfor
inclusioninthetemplate.
Scheduler
WhetherornottheQlikSenseSchedulerService(QSS)hasbeenselected
forinclusioninthetemplate.
Therestofthefieldsarespecificforthecloudcomputingenvironmentanddependonthepluginused.Forinformationspecifictoyourplug-in,seethedocumentationfortheplug-in.
18
5 Sites
G
Thisareaprovidesdetailsontheinstances(thatis,nodes)thatarebasedontheinstance
template.
UseUandStoshowandhideinformation.
Machine
TheDNSofthemachineonwhichtheinstance(thatis,node)isdeployed.
name
Service
status
TheiconsindicatethestatusoftheQlikSenseservicesrunningontheinstance
(thatis,node):
l
l
l
(running):Theserviceisupandrunning.
(notrunning):Theserviceisnotupandrunning.
(error):Anerroroccurredwhendeployingtheserviceonthemachine.
The status of the services reflect the status reported by the Qlik
Sense Repository Service (QRS) on the central node in the site.
Theiconindicatesthestatusoftheinstance(thatis,node).
l
l
l
(running):Theinstanceisupandrunning.
(notrunning):Theinstanceisnotupandrunning.
(error):Anerrorhasoccurred.
ClickError informationtodisplayanyerrormessages.
ClickRemote desktoptoopenaremotedesktoptothemachineonwhichtheinstance(thatis,
node)isdeployed.SeeConnecting to a remote desktop (page 24).
Clicktodeleteaninstance(thatis,node).
5.2 Creatingsites
ProceedasfollowstocreateaQlikSensesitethatisdeployedinacloudcomputingenvironment:
This procedure is used to create a central node. See Creating instances (page 23) for
information on how to add a node to an already existing site.
1. SelectSitesintheleftpanel.
2. ClickPCreate site.
3. Selecttheplug-intousewhencreatingthesite.
Dependingontheplug-inselected,theCreatenewwizardstartsimmediatelyoryoumaybe
requestedtoconfiguresomeoftheplug-infunctionalitybeforethewizardstarts.Forinformation
specifictoyourplug-in,seethedocumentationfortheplug-in.
4. Fillinthefieldsinthefirststep,Site configuration,ofthewizard.
19
5 Sites
ClickNexttoproceedtothenextstep.ClickCanceltoexitthewizard.
5. TheremainingstepsoftheCreatenewsitewizarddependontheplug-inselected.Forinformation
specifictoyourplug-in,seethedocumentationfortheplug-in.
6. ReviewtheSite summaryandthenclickCreatetocreatethesite.
ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthewizard.
Siteconfiguration
Proceedasfollowstofillinthefieldsinthefirststep,Site configuration,oftheCreatenewsitewizard.
Site name
EnteranamefortheQlikSensesite.
License
SelectaQlikSenselicenseobjectinthedrop-downlist.
Ifthelistisemptyorifyouwanttoaddanewlicenseobject,click.
ProceedasfollowstofillinthefieldsforaQlikSenselicenseobject.
Name
Enterthenameforthelicenseobject.
Owner name
EntertheusernameoftheQlikSenseproductowner.
Owner
organization
EnterthenameoftheorganizationofwhichtheQlikSense
productownerisamember.
Serial number
EntertheserialnumberassignedtotheQlikSensesoftware.
Control
EnterthecontrolnumberassignedtotheQlikSensesoftware.
number
ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.
Qlik Sense
ThefileversionoftheQlikSensesetupfilethatisusedforthesite.SeeQlik Sense
version
5.3 Incorporatingsites
ExistingQlikSensesitesthathavebeeninstalledanddeployedoutsideoftheQlikDeploymentConsole
(QDC)canbeincorporatedforuseintheQDC.Thissimplifiesthescalingofexistingsites.
This procedure is used to create a central node. See Creating instances (page 23) for
information on how to add a node to an already existing site.
To incorporate a site in the QDC, the certificates for the site are needed. Use the Qlik
Management Console (QMC) for the site to export the certificates.
20
5 Sites
ProceedasfollowstoincorporateanexistingsiteintheQDC:
1. SelectSitesintheleftpanel.
2. ClickPCreate site.
3. SelectthePhysical Environmentplug-in.
TheIncorporateexistingsitewizardstarts.
4. Fillinthefieldsinthefirststep,Site connection,ofthewizard.
ClickNexttoproceedtothenextstep.ClickCanceltoexitthewizard.
5. ReviewtheSite summaryandthenclickIncorporate sitetoincorporatethesiteintheQDC.
ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthewizard.
Siteconnection
Proceedasfollowstofillinthefieldsinthefirststep,Site connection,oftheIncorporateexistingsite
wizard.
Site name
EnterthenametouseforthesiteintheQlikDeploymentConsole(QDC).
Host name
Enterthehostname(forexample,host.domain.com)ofthecentralQlik
SenseRepositoryService(QRS)forthesite.
Certificate location
Browsetoa.zipfilethatcontainsthecertificatesforthesite.
Certificate password
EnterthepasswordfortheQlikSensecertificate.
EntertheQlikSenseuserdirectoryandrootadminusernamein
<domain>\<user>format.
SelectaQlikSenselicenseobjectinthedrop-downlist.
Ifthelistisemptyorifyouwanttoaddanewlicenseobject,click.
ProceedasfollowstofillinthefieldsforaQlikSenselicenseobject.
Name
Enterthenameforthelicenseobject.
Owner name
EntertheusernameoftheQlikSenseproductowner.
Owner
EnterthenameoftheorganizationofwhichtheQlik
Senseproductownerisamember.
organization
Serial
number
Control
number
EntertheserialnumberassignedtotheQlikSense
software.
EnterthecontrolnumberassignedtotheQlikSense
software.
ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.
21
5 Sites
Qlik Sense version
ThefileversionoftheQlikSensesetupfilethatisusedforthesite.See
Qlik Sense setup files view (page 31).
SelectaQlikSenseversioninthedrop-downlist.
IfthelistisemptyorifyouwanttoaddanewQlikSensesetupfile,click
.
ProceedasfollowstoaddanewQlikSensesetupfile:
1. Clickandbrowsetothefiletoupload.
5.4 Deletingsites
ProceedasfollowstodeleteaQlikSensesitefromacloudcomputingenvironment:
1. SelectSitesintheleftpanel.
2. Clicktodeleteasite.
3. ClickYestoconfirmthedeletion.
5.5 Creatinginstancetemplates
Aninstancetemplateholdstheconfigurationforaninstance(thatis,anode)inaQlikSensesiteand
simplifiestheadditionofnewinstancestositesthataredeployedincloudcomputingenvironments.
22
5 Sites
5. Fillinthefieldsinthefirststep,Template configuration,ofthewizard.
ClickNexttoproceedtothenextstep.ClickCanceltoexitthewizard.
6. Theremainingstepsofthetemplatesetupwizarddependontheplug-inselected.Forinformation
specifictoyourplug-in,seethedocumentationfortheplug-in.
7. ReviewtheTemplate summaryandthenclickCreatetocreatetheinstancetemplate.
ClickPrevioustoreturntothepreviousstep.ClickCanceltoexitthewizard.
Templateconfiguration
Proceedasfollowstofillinthefieldsinthefirststep,Template configuration,ofthetemplatesetup
wizard.
Template
Enteranamefortheinstancetemplate.
name
Repository
Thisboxisdimmed,sinceeveryinstance(thatis,node)mustincludeaQlikSense
RepositoryService(QRS).
Engine
Thisboxisdimmed,sinceeveryinstance(thatis,node)mustincludeaQlikSenseEngine
Service(QES).
Proxy
CheckthisboxtoincludeaQlikSenseProxyService(QPS)inthetemplate.
Scheduler
CheckthisboxtoincludeaQlikSenseSchedulerService(QSS)inthetemplate.
5.6 Deletinginstancetemplates
Proceedasfollowstodeleteaninstancetemplate:
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
3. Clicktodeleteatemplate.
4. ClickYestoconfirmthedeletion.
All instances (that is, nodes) based on the template are also deleted.
5.7 Creatinginstances
AninstanceisanodeinaQlikSensesitethatisnotacentralnode.
This procedure is used to add a node to an already existing site. See Creating sites (page 19)
for information on how to create a central node.
Proceedasfollowstocreateaninstance(thatis,node):
23
5 Sites
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
3. Expandanexistinginstancetemplate.Alternatively,createanewinstancetemplateasdescribedin
Creating instance templates (page 22).
4. ClickPCreate new instance.
Anewinstanceiscreated.
5.8 Deletinginstances
Proceedasfollowstodeleteaninstance(thatis,node):
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
3. Expandanexistinginstancetemplate.
4. Clicktodeleteaninstance.
5. ClickYestoconfirmthedeletion.
5.9 StartingQlikManagementConsoleonthecentral
node
ProceedasfollowstostarttheQlikManagementConsole(QMC)onthecentralnodeinaQlikSensesite:
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
3. ClickOpen QMCtostarttheQlikManagementConsole(QMC)onthecentralnodeintheselected
site.
5.10 Connectingtoaremotedesktop
Proceedasfollowstoconnecttoaremotedesktoponacentralnodeoraninstance(thatis,anodethatisnot
acentralnode):
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
3. Onacentralnode:ClickRemote desktoptoopenaremotedesktoptothemachineonwhichthe
instance(thatis,node)isdeployed.
Onaninstance:Expandanexistinginstancetemplate.ClickRemote desktoptoopenaremote
desktoptothemachineonwhichtheinstance(thatis,node)isdeployed.
5.11 Displayingstatusinformation
ProceedasfollowstodisplaystatusinformationforaQlikSensesite:
24
5 Sites
1. SelectSitesintheleftpanel.
2. SelectaQlikSensesiteinthelistofavailablesites.
Theiconindicatesthestatusofthesite.
l
l
l
(running):Allpartsofthesite(centralnode,instances,andtemplates)areupandrunning.
(notrunning):Oneormorepartsofthesitearenotupandrunning.
(error):Anerrorhasoccurredsomewhereinthesite.
25
6 Plug-ins
Plug-ins
Plug-insareusedintheQlikDeploymentConsole(QDC)todeployQlikSensesitesindifferentcloud
computingenvironments.Aplug-inconsistsofoneormoremodules,eachofwhichincludescertain
functionality(forexample,credentials)relatedtothecloudcomputingenvironment.
6.1 Plug-insview
ThePlug-insviewprovidesanoverviewoftheplug-insthatareregisteredintheQlikDeploymentConsole
(QDC).
Alistoftheplug-insthatareregisteredintheQDC.
Selectaplug-intodisplaydetailedinformationonit.
Clicktodeleteaplug-in.
Thisareaprovidesdetailsontheselectedplug-in.
Plug-in name
Thenameoftheplug-in.
Plug-in version
Theversionnumberoftheplug-in.
Alistofthemodulesthatareincludedintheselectedplug-in.
UseUandStoshowandhideinformation.
6.2 Registeringplug-ins
Proceedasfollowstoregisteraplug-inforuseintheQlikDeploymentConsole(QDC):
1. SelectPlug-insintheleftpanel.
2. ClickRegister plug-in.
26
6 Plug-ins
3. ClickintheBrowse for a plug-infieldandbrowsetothe.zipfilethatcontainstheplug-in.
4. ClickRegistertoregistertheplug-inorCanceltoexitwithoutregistering.
6.3 Deletingplug-ins
Proceedasfollowstodeleteaplug-infromtheQlikDeploymentConsole(QDC):
1. SelectPlug-insintheleftpanel.
2. Clicktodeleteaplug-in.
3. ClickYestoconfirmthedeletion.
27
7 Tasks
Tasks
TasksareusedtotransferappsfromonesiteandstreamtoanothersiteintheQlikDeploymentConsole
(QDC).
7.1 Tasksview
TheTasksviewprovidesanoverviewofthetasksthathavebeencreatedintheQDC.
AlistofthetasksthathavebeencreatedintheQDC.
Theiconindicatesthestatusofthetask.
l
l
l
m(successfulexecution):Thelastexecutionofthetaskwassuccessful.
(neverexecuted):Thetaskhasneverbeenexecuted.
(unsuccessfulexecution):Thelastexecutionofthetaskwasunsuccessful.
Selectatasktodisplaydetailedinformationonit.
Clicktodeleteatask.
Thenameofthetask.
28
7 Tasks
C
Thelocationfromwhichtotransferapps.
Site
Thesitefromwhichtotransferapps.
Stream
Thestreamfromwhichtotransferapps.
Thelocationtowhichtotransfertheapps.
Site
E
Thesitetowhichtotransfertheapps.
Theresultofthelatestexecutionofthetask.
7.2 Creatingtasks
Proceedasfollowstocreateanewtask:
1. SelectTasksintheleftpanel.
2. ClickPCreate new task.
3. EnteranameforthetaskintheNamefield.
4. SelectthesitetotransferappsfromintheSitedrop-downlistunderSource.
5. SelectthestreamtotransferappsfromintheStreamdrop-downlistunderSource.
6. SelectthesitetotransfertheappstointheSitedrop-downlistunderDestination.
7. ClickSavetosavethetaskorCanceltoexitwithoutsaving.
7.3 Deletingtasks
Proceedasfollowstodeleteatask:
1. SelectTasksintheleftpanel.
2. Clicktodeleteatask.
3. ClickYestoconfirmthedeletion.
7.4 Transferringapps
ProceedasfollowstotransferappsfromoneQlikSensesiteandstreamtoanothersite:
1. SelectTasksintheleftpanel.
2. Selectataskinthelistofavailabletasks.
3. ClickStarttostartthetransferoperation.
4. SeeLatest executionfortheresultofthelatestexecutionofthetask.
The apps are still available in the site and stream listed under Source after the transfer
operation.
29
7 Tasks
See also:
p Creating tasks (page 29)
Transferrules
ThefollowingtableprovidesanoverviewoftherulesthatareappliedbytheQlikDeploymentConsole(QDC)
whentransferringappsfromonesiteandstream(Site1)toanothersite(Site2).
App
App
available
available
on Site 1?
on Site 2?
the app?
Yes
No
Notapplicable
TransfertheapptoSite2.
Yes
Yes
Site1
TransfertheapptoSite2.
Resulting action
Yes
Site2
Donottransfertheapp.Instead,postanerror
message.
Yes
Yes
Sameversiononboth
sites
Donottransfertheapp.
30
QlikSensesetupfiles
TheQlikDeploymentConsole(QDC)supportstheuseofmultipleversionsofQlikSense,whichmeansthat
differentsitescanusedifferentversionsofQlikSense.
ThisisaccomplishedbyuploadingdifferentversionsoftheQlikSensesetupfiletotheQDC.
8.1 QlikSensesetupfilesview
TheQlik Sense setup filesviewprovidesanoverviewofthesetupfilesthathavebeenuploadedtotheQlik
DeploymentConsole(QDC).
AlistoftheQlikSensesetupfilesthathavebeenuploadedtotheQDC.
Selectasetupfiletodisplaydetailedinformationonit.
ClicktodeleteaQlikSensesetupfile.
ThisareaprovidesdetailsontheselectedQlikSensesetupfile.
Installation file name
ThenamegiventothesetupfilebytheQDC.Thetooltipforthis
fieldprovidesthepathtothefile.
Thefileversionofthesetupfile.
Qlik Sense
communication version
TheQlikSenseversionlayertousewhencommunicatingwith
thesetupfile.
Date uploaded
ThedatewhenthesetupfilewasuploadedtotheQDC.
Alistofthesitesthatusethesetupfile.
31
8.2 UploadingQlikSensesetupfiles
ProceedasfollowstouploadaQlikSensesetupfileforuseintheQlikDeploymentConsole(QDC):
1. SelectQlik Sense setup filesintheleftpanel.
2. ClickUpload setup file.
3. ClickintheBrowse for a Qlik Sense setup filefieldandbrowsetothefiletoupload.
The selected file must be a setup file for Qlik Sense (typically named Qlik_Sense_
setup.exe).
4. SelecttheQlikSenseversionlayertousewhencommunicatingwiththesetupfileintheQlik Sense
communication versiondrop-downlist.
5. ClickUploadtouploadthesetupfileorCanceltoexitwithoutuploadinganyfile.
8.3 DeletingQlikSensesetupfiles
ProceedasfollowstodeleteaQlikSensesetupfilefromtheQlikDeploymentConsole(QDC):
1. SelectQlik Sense setup filesintheleftpanel.
2. ClicktodeleteaQlikSensesetupfile.
You cannot delete a setup file that is used by one or more sites.
3. ClickYestoconfirmthedeletion.
32
9 Objects
Objects
Anobjectisusedtoholdacertaintypeofinformationrelatedtoaspecificplug-inorcloudcomputing
environment.QlikDeploymentConsole(QDC)providesnativesupportforsomeobjecttypes.Othertypes,
referredtoasthird-partyobjecttypesbelow,areaddedintheQDCaspartofplug-ins.
9.1 Objectsview
TheObjectsviewprovidesanoverviewoftheobjectsthatareavailableintheQlikDeploymentConsole
(QDC).
AlistoftheobjecttypesthatareavailableintheQDC.
Selectanobjecttypetodisplaydetailedinformationonit.
ClickPCreatetocreateanobjectoftheselectedobjecttype.
Thisareaprovidesdetailsontheexistingobjectsoftheselectedobjecttype.
UseUandStoshowandhideinformation.
Thefieldsfortheobjectdependontheselectedobjecttype:
l Licenseobjecttype(includedintheQDCdelivery):SeeLicense object (page 34).
l Third-partyobjecttypes:Seethedocumentationfortheplug-inandobjecttype.
Thefieldscanbeedited.ClickSavetosaveanychangesorResettorevertanychanges.
Clicktodeleteanobject.
9.2 Creatingobjects
Proceedasfollowstocreateanobject:
1. SelectObjectsintheleftpanel.
2. Selectanobjecttype.
3. ClickPCreatetocreateanobjectoftheselectedobjecttype.
33
9 Objects
4. Fillinthefields.Thefieldsdifferdependingontheobjecttypeselected:
l Licenseobjecttype(includedintheQDCdelivery):SeeLicense object (page 34).
l Third-partyobjecttypes:Seethedocumentationfortheplug-inandobjecttype.
5. ClickSavetosavetheobject.ClickCanceltoexitwithoutsaving.
Licenseobject
ProceedasfollowstofillinthefieldsforaQlikSenselicenseobject.
Name
Enterthenameforthelicenseobject.
Owner name
EntertheusernameoftheQlikSenseproductowner.
Owner
organization
EnterthenameoftheorganizationofwhichtheQlikSenseproductownerisa
member.
Serial number
EntertheserialnumberassignedtotheQlikSensesoftware.
Control number
EnterthecontrolnumberassignedtotheQlikSensesoftware.
9.3 Deletingobjects
Proceedasfollowstodeleteanobject:
1. SelectObjectsintheleftpanel.
2. Selectanobjecttype.
3. Clicktodeleteanobject.
4. ClickYestoconfirmthedeletion.
34
10 QlikDeploymentConsolelogging
ThelogmessagesproducedbytheQlikDeploymentConsole(QDC)provideimportantinformationthatcan
beusedtodetectsecurityincidents,operationalproblems,andpolicyviolations.
TheQDCusesthesameloggingframeworkasQlikSense.SeetheServerDeploymentandConfiguration
formoreinformation.
10.1 Storage
TheQDCserverlogfilesarebydefaultstoredinthefollowinglocation:
%ProgramData%\Qlik\Sense\Log\Server
10.2 Naming
TheQlikDeploymentConsole(QDC)logfilesarenamedinaccordancetothefollowingfilerollover
procedure:
1. Thelogisstoredinafilenamed<Machine>_<Facility>_<Server or Client>.txt.
2. Whenthefileisfullorapre-definedamountoftimehaspassed,thefileextensionisautomatically
changedto.logandatimestampisappendedtothefilenameforuniquenessandarchiving.This
meansthatthenewfilenamebecomes<Machine>_<Facility>_<Server or Client>_<YYYY-MM-
DDTHH.mm.ssZ>.log.
3. Anewlogfile,named<Machine>_<Facility>_<Server or Client>.txt,iscreated.
Theformatofthefilenameisasfollows:
l <Machine>=Nameofthemachinewherethelogwascreated.
l <Facility>=Oneofthefollowing:
l Application:Logeventsthatarerelatedtoanapplication.
l Audit:Logeventsthatprovideanaudittrailofausersactivitiesandadministration.
l Performance:Logeventsthatarerelatedtotheperformance.
l <Server or Client>=IndicatesifthelogwascreatedbytheserverorclientsideoftheQDC.
l <YYYY-MM-DDTHH.mm.ssZ>=Timestampforwhenthelogfilewasclosedfornewentries,
where:
l YYYY:Year
l MM:Month
l DD:Dayinmonth
l T:Delimiter,timedesignator
l HH:Hour
l mm:Minutes
l ss:Seconds
l Z:UTCdesignator,indicatesthatthetimestampisinUTCformat
35
11 Troubleshooting
11 Troubleshooting
ThissectionprovidestroubleshootinginformationfortheQlikDeploymentConsole(QDC).
11.1 CannotstarttheQlikDeploymentConsole
IfyoucannotstarttheQDCafterinstallationoriftheQDChangswhenstartingit,proceedasfollows:
1. Deleteallsub-foldersinC:\QDC.
This step is only needed if the QDC has previously been installed on the machine.
2. Deleteallfilesandfoldersin%ProgramData%\Qlik\Deployment Console.
This step is only needed if the QDC has previously been installed on the machine.
3. Checkforanyportconflicts.
ThefollowingportsareusedforcommunicationbytheQDC:
l 23580:httpprotocol
l 23581:httpsprotocol
l 23582:SignalRPort
ProceedasfollowstomaketheQDCuseanotherport:
a. StarttheWindowsTaskManager.
b. StoptheQlikDeploymentServicef romrunning.
c. OpentheQDCserverconfigurationfile,
%ProgramFiles%\Qlik\DeploymentConsole\Server\QlikDeploymentServer.exe.config.
d. Changetheportnumbers(value)fortheaffectedkeys:
<add key="HttpServicePort" value="23580" />
<add key="HttpsServicePort" value="23581" />
<add key="SignalRPort" value="23582" />
e. Savethechanges.
f. OpentheQDCclientconfigurationfile,
%ProgramFiles%\Qlik\DeploymentConsole\Client\QlikDeploymentConsole.exe.config.
g. Changetheportnumbers(value)fortheaffectedkeystothesamevaluesasfortheserver:
<add key="HttpServicePort" value="23580" />
<add key="HttpsServicePort" value="23581" />
<add key="SignalRPort" value="23582" />
36
11 Troubleshooting
h. Savethechanges.
i. StarttheQlikDeploymentServiceagain.
11.2 RepairingtheQlikDeploymentConsole
IftheQlikDeploymentConsole(QDC)installationbecomescorrupt,therepairoptionintheQDCinstaller
canbeusedtorestoreallmissingfiles,shortcuts,registryvalues,andservices.
ProceedasfollowstorepairtheQlikDeploymentConsole(QDC)installation:
1. Double-clicktheQDCinstallationfile.
TheQlikDeploymentConsolesetupwizardstarts.
2. ClickNext.
3. ClickRepair.
4. ClickRepair.
TheQDCinstallationisrepaired.
5. ClickOK,ifyouarepromptedthatarebootisrequiredtocompletethesetup.
6. ClickFinish.
7. Rebootthesystem(ifpromptedtodosoinstep5).
37
12 UninstallingtheQlikDeploymentConsole
ProceedasfollowstouninstalltheQlikDeploymentConsole(QDC):
1. Double-clicktheQDCinstallationfile.
TheQlikDeploymentConsolesetupwizardstarts.
2. ClickNext.
3. ClickRemove.
4. ClickRemove.
TheQDCisuninstalled.
5. ClickFinish.
38