celindho-serializeapp

serializeapp

serializeapp is a node utility module to serialize a Qlik Sense app into a JSON object.
Pass it an enigma.js app object and it returns a promise containing the JSON representation of that app.

installing

npm install celindho_serializeapp

examples

Connect to Qlik Sense Desktop, open a app and pass that into serializeapp.

const serializeapp = require("serializeapp");
const enigma = require("enigma.js");
const WebSocket = require("ws");

enigma
  .getService("qix", {
    schema: require(`./node_modules/enigma.js/schemas/qix/3.2/schema.json`),
    session: {
      host: "localhost",
      port: 4848,
      secure: false,
    },
    createSocket: (url) => new WebSocket(url),
  })
  .then((qix) => qix.global.openDoc("Executive Dashboard.qvf"))
  .then((app) => serializeapp(app))
  .then((result) => console.log(result));

Returns

{
properties: {}, -> @Object AppEntry
loadscript: '', -> @String Loadscript
sheets: [], -> @Array - Array of GenericObjectEntry and its children
stories: [], -> @Array - Array of GenericObjectEntry and its children
masterobjects: [], -> @Array - Array of GenericObjectEntry
dataconnections: [], -> @Array - Array of Connection
dimensions: [], -> @Array - Array of GenericDimensionProperties
measures: [], -> @Array - Array of GenericMeasureProperties
bookmarks: [], -> @Array - Array ofGenericBookmarkLayout
embeddedmedia: [], -> @Array of MediaListItem
fields: [], -> @Array of NxFieldDescription
snapshots: [] -> @Array of Array of GenericBookmarkLayout
}