Skip to main content

File formats

When you save a mashup project from the Mashup editor, the following file types are saved to the project folder:

  • HTML
  • JavaScript
  • QEXT
  • WBL

HTML files

All mashups must contain at least one HTML file and one JavaScript file.

The HTML file is one of the core building blocks when creating a mashup. The Qlik Sense objects that have been defined in the JavaScript file are placed inside div tags inside the body of the HTML file.

Relationships between the current document and the linked Qlik Sense defined style sheets are specified in link rel tags inside the head of the HTML file.

Note: Add host to the link rel tags if the web server hosting the mashup is different from the web server hosting the static Qlik Sense content.

JavaScript (js) files

All mashups must contain at least one JavaScript file and one HTML file.

The core of all mashups is consists of the JavaScript file. The JavaScript file is loaded in the browser when your mashup is used. RequireJS is used as a module loader.

QEXT files

When you save a mashup project from the Mashup editor, a QEXT file is automatically included in the project. A QEXT file is a JSON file, and contains all metadata required by the Mashup editor to recognize the mashup project. It is also required if you want to launch your mashup from Qlik Sense Desktop.

Note: The QEXT file is automatically created by the Mashup editor. You need to manually add a QEXT file if you have created a mashup project not using the Mashup editor, and you want it to be accessible from the Mashup editor.
Note: The QEXT file extension must be in lower case letters, for example MyMashup.qext.

Example: QEXT file content

{
	"type": "mashup",
	"name": "MyMashup",
	"version": 1.0.0,
	"allowPosition": true
}

WBL files

The Workbench load file (WBL) is used by the Mashup editor, and lists the names of all files included in the mashup project. When you save a mashup project from the Mashup editor, a WBL file is automatically included in the project.

Example: WBL file content

MyMashup.qext; MyMashup.html; MyMashup.js