Доступ к системным данным и переменным в Extension Qlik Sense

Введение

Иногда при создании расширения Qlik Sense вам необходимо получить доступ к системным данным. Это особенно актуально, если вы пытаетесь создать что-то более общее. Возможно, вам нужен список полей, измерений или показателей. Или вам нужно работать с переменными. Если вы новичок в разработке Qlik Sense, вы можете посмотреть в документации по API способы получения необходимых данных. Не делай этого !!! 😕  Модель расширения Qlik Sense основана на идее использования одного универсального объекта, описанного в расширениях initialProperties и измененного пользователем на панели свойств и, возможно, программно (но это действительно продвинуто). Таким образом, хотя использование методов API для получения дополнительных данных является одним из описанных подходов в Qlik Help, которые используются в гибридных приложениях или веб-приложения и обращаются к данным Qlik, вам следует избегать их использования в mashups.

Почему не нужно использовать вызовы API

Если вы используете эти вызовы API в своем расширении, у вас возникнут проблемы:

• вы можете легко получить утечку памяти или «утечку общих объектов», когда вы создаете множество общих объектов.
• вы можете легко потерять контроль над всеми работающими функциями обратного вызова при повторной проверке общих объектов.
• если пользователь делает снимок, вызовы API будут обращаться к последней версии данных, а не к той, что в снимке, и, возможно, дадут неправильные данные.
• если пользователь попытается экспортировать ваше расширение в PDF или Excel, оно может сломаться, поскольку служба, отвечающая за этот экспорт, не имеет доступа к оперативным данным, а только к моментальному снимку.

Если вам абсолютно необходимо использовать эти вызовы, вы должны по крайней мере включить экспорт в PDF и Excel и не разрешать моментальные снимки вашего расширения.

Что нужно делать вместо этого

К счастью, есть альтернативы. Все эти вызовы API создают общие объекты, но, поскольку общий объект является очень гибкой структурой, вы можете фактически настроить общий объект за своим расширением для предоставления необходимых вам данных. Вот небольшая таблица того, что вы можете использовать:

Что нужно	Не использовать вызов API	Вместо этого добавьте в initialProperties
List of fields	app.getList(“FieldList”)	qFieldListDef
List of measures	app.getList(“MeasureList”)	qMeasureListDef
List of dimensions	app.getList(“DimensionList”)	qDimensionListDef
List of variables	app.getList(“VariableList”)	qVariableListDef
Variable value	app.variable.getContent(..)	qStringExpression or qValueExpression

Вы найдете рабочий пример этого в репозитории  расширении системного списка,  просто не используйте его, он предназначен как пример того, как получить данные и на самом деле не делает ничего полезного. Но возьмите ту часть initialProperties, которая вам нужна для расширения. Это выглядит так:

initialProperties: {
                moneyFormat: {
                    qStringExpression: '=MoneyFormat'
                },
                qMeasureListDef: {
                    qType: "measure",
                    qData: {
                        qMeasure: "/qMeasure"
                    }
                },
                qDimensionListDef: {
                    qType: "dimension",
                    qData: {
                        qDim: "/qDim",
                        qDimInfos: "/qDimInfos"
                    }
                },
                qVariableListDef: {
                    qType: "variable",
                    qShowReserved: true,
                    qShowConfig: true
                },
                qFieldListDef: {
                    qShowSystem: true,
                    qShowHidden: true,
                    qShowSemantic: true,
                    qShowSrcTables: true,
                    qShowDerivedFields: true,
                    qShowImplicit: true
                }
            }

Когда следует использовать эти вызовы API

Ну нет правил без исключений. Хотя вам следует избегать использования этих вызовов в API для части рендеринга вашего расширения, вы должны использовать их на своей панели свойств, если вам, например, нужно предоставить список полей пользователю. А в мэшапе они определенно очень полезны. И у API есть другие вызовы, которые вы, возможно, захотите использовать, но в основном это когда пользователь что-то делает, например, нажимает кнопку и т.д.

Источник

https://extendingqlik.upper88.com/accessing-system-data-and-variables-in-a-qlik-sense-extension/