Skip to main content
Announcements
Live today at 11 AM ET. Get your questions about Qlik Connect answered, or just listen in. SIGN UP NOW
cancel
Showing results for 
Search instead for 
Did you mean: 
vidyarani
Contributor III
Contributor III

How to use QMS API

Hi All,

Can someone help me to understand how to use QMS API?

Please do share if you any document along with steps please.

I would like to use this API to extract the data instead of using UI of Qlik. Using UI is using dashboard ( export to excel or pdf option )

Any leads will be greatly appreciated.

Thanks and Regards,

Vidyarani

Labels (1)
2 Solutions

Accepted Solutions
Marc
Employee
Employee

The QMS API is the QlikView Management Service API and is for managing the platform rather than accessing the QlikView Apps Data.

https://help.qlik.com/en-US/qlikview-developer/April2020/APIs/QMS+API/html/7b30b3a1-77da-4bbe-bdc2-1... 

 

You can access the QMS APIs using PowerShell via the QlikView-CLI module.

https://github.com/QlikProfessionalServices/QlikView-CLI 

The Wiki has a couple of examples of how to use it.

https://github.com/QlikProfessionalServices/QlikView-CLI/wiki#getting-started 

 

If you are trying to get data out of a QlikView ETL process, it may be easier to add a Store command to the Script to add a Export to CSV?

 

View solution in original post

MichaelRobertshaw
Former Employee
Former Employee

It would be interesting to know what your ultimate objective is. The QMS API is not relevant to your apparent goal. It is for managing documents and platform, not the data in those documents. You'd need to use QVPX interface to interact with the front end, and that is not well documented! 

If you want to extract all data from the QVW, then modify the script to store each table as CSV, or binary load the document and extract all tables to CSV.  If you binary load the QVW document into Qlik Sense then you'll have access to Qlik Sense APIs which do provide a programmatic interface to the data in the document. You could also consider a 3rd party interface to Sense such as https://www.ipc-global.com/amp/inprocess-odbc

View solution in original post

6 Replies
Marc
Employee
Employee

The QMS API is the QlikView Management Service API and is for managing the platform rather than accessing the QlikView Apps Data.

https://help.qlik.com/en-US/qlikview-developer/April2020/APIs/QMS+API/html/7b30b3a1-77da-4bbe-bdc2-1... 

 

You can access the QMS APIs using PowerShell via the QlikView-CLI module.

https://github.com/QlikProfessionalServices/QlikView-CLI 

The Wiki has a couple of examples of how to use it.

https://github.com/QlikProfessionalServices/QlikView-CLI/wiki#getting-started 

 

If you are trying to get data out of a QlikView ETL process, it may be easier to add a Store command to the Script to add a Export to CSV?

 

vidyarani
Contributor III
Contributor III
Author

Hi Marc,

Thanks for the response.Much appreciated.

I am trying to get data out Qlikview.I cant use Store command as data is stored in multiple tables.

Can I use QMS API to do that? If so what are the steps?

Thanks and Regards,

Vidyarani

MichaelRobertshaw
Former Employee
Former Employee

It would be interesting to know what your ultimate objective is. The QMS API is not relevant to your apparent goal. It is for managing documents and platform, not the data in those documents. You'd need to use QVPX interface to interact with the front end, and that is not well documented! 

If you want to extract all data from the QVW, then modify the script to store each table as CSV, or binary load the document and extract all tables to CSV.  If you binary load the QVW document into Qlik Sense then you'll have access to Qlik Sense APIs which do provide a programmatic interface to the data in the document. You could also consider a 3rd party interface to Sense such as https://www.ipc-global.com/amp/inprocess-odbc

vidyarani
Contributor III
Contributor III
Author

Hi Michael,

Thanks a lot for the response.

We have a dashboard developed on QV and other team would like to access the dashboard  or fetch the data out of it  but we can't provide them access to the Dashboard which means they can't access through the  Qlikview access point.

My Question is Can we use an QMS API in order for  them to get the access to the Dashboard?.

Ultimate goal is to provide them the data using any method.

 

 

Thanks and Regards,

Vidyarani

 

MichaelRobertshaw
Former Employee
Former Employee

Programmatic interaction with the document using OCX/OLE Automation methods is possible with a qvp connection (4747/tcp) directly to the QlikView Server or proxied via the Web Tier, but if you trust someone enough to provide them with programmatic access then why don't you trust them to access the Portal? 

https://help.qlik.com/en-US/qlikview-developer/latest/Subsystems/Automation/Content/QV_Automation/au... 

What are those 'foreign' users going to do with the data that they extract? How are they going to visualize it?  Why not use QlikView Publisher to upload the reloaded document to Qlik SaaS and provide the authenticated users with consumer-access to it there? 

https://help.qlik.com/en-US/cloud-services/Subsystems/Hub/Content/Sense_Hub/QlikViewInCloud/using-QV...