The purpose of the Extension object wizard is to simplify:
- Creation of custom property pages for extension objects
- Creation of Graphical User Interface (GUI) for extension objects
- Deployment of extension objects
In QlikView, there are two kinds of extensions:
- Extension objects
- Document extensions
To create a new project with the extension already placed on the Default.aspx page, using the QlikView Workbench template, proceed as follows:
- As a Windows system administrator, open Visual Studio.
Select File > New > Project...
The New Project dialog is displayed. In the Installed Templates list, select the Language (Visual Basic or Visual C#) and the Location (Workbench) for the project.
Select QlikView Extension and click OK.
The extension object has now been created.
To start using the extension, enter Design mode.
Follow the steps in the left pane.
The Extension frame in the QvExtension Tasks panel is used to provide the name of the extension and a description that appears next to the name when a user adds a new extension to a QlikView document.
The frame also contains links to the Edit properties and Edit references to scripts dialogs. The Edit references to scrips dialog is used to edit references to scripts other than Script.js, which is the principal script file for the extension. The dialogs provide a simple way to generate properties and script references without the need to write any code.
Pack & Publish
The Pack & Publish frame in the QvExtension Tasks pane does not contain actions to modify an extension, but is used for testing an extension, either in QlikView Desktop or in QlikView Server.
Deselect the Generate files box to stop changes in the extension from being reflected in the packed extension.
Click the Pack Extension link to create a QAR file, which is recognized and used by QlikView.
Pack & Publish Extension locally
Click the Pack & Publish Extension locally link to run the QAR file (that is, QlikView Desktop is started and the extension is installed).
To run the extension on QlikView Server, make sure that the account running Visual Studio is member of the QlikView Administrator group and the QlikView Management API group on the server.