Getting started creating object extensions

This section will guide you through the process of creating your first object extension.

Tip: The easiest way to get started building your object extension is to use QlikView Desktop. This section assumes that QlikView Desktop is being used.

Creating the container

Create a folder that will contain your assets. The folder should be created in the following location: \Users\<user>\AppData\Local\QlikTech\QlikView\Extensions\Objects.

Example:  

\Users\<user>\AppData\Local\QlikTech\QlikView\Extensions\Objects\SimpleHelloWorld

Creating the Definition.xml

The next step is to create an XML file called Definition.xml. This is the main file QlikView uses to search for meta-information of the extension. In this example we only define the most basic information.

<?xml version="1.0" encoding="utf-8" ?>
<ExtensionObject  Path="SimpleHelloWorld" 
                  Label="Hello World" 
                  Description="Hello World Extension" 
                  Type="object">
</ExtensionObject>

The following information is set if QlikView loads this file:

  • The path (folder) of the extension is set to SimpleHelloWorld.
  • The label of the extension is set to Hello World and the description of the extension is set to Hello World Extension.
  • We have defined that it is an object extension by setting the Type attribute to "object".

Creating the main script file

Qv.AddExtension("SimpleHelloWorld",
        function () {

            // Set the extension object's inner Html
            this.Element.innerHTML = 'Hello World';

        });

Testing the extension

Now is a good time to test your object extension.

You have now created your first QlikView object extension.