Подключение плагина аналитической панели в веб-приложении

Для регистрации плагина через сервисы:

1. Зарегистрируйте плагин в общих ресурсах. Регистрация плагина производится в среде разработки Fore:

• идентификатор плагина задается в верхнем регистре с помощью свойства Id, например:

plugin.Id := "SOURCELABEL";

Примечание. Идентификатор плагина должен совпадать с идентификатором в структуре js-скрипта плагина.

• ссылка на *.js файл задается с помощью свойства WebUrl, например:

plugin.WebUrl := "../plugins/SourceLabel.js";

2. Настройте аналитическую панель в веб-приложении. Для отображения плагина, зарегистрированного в сервисах, задайте свойство ServicesPlugins одним из способов:

• для всего веб-приложения в файле «PP.xml». Внутри тега <pp> добавьте тег <modules>, в котором задается свойство:

<?xml version="1.0" encoding="utf-8" ?>
<pp>
  <service url=" http://localhost:9090/axis2/services/PP.SOM.Som" />
  <metabase id="REPOSITORY" ping="120000" />
  <cultures>
    <culture cultureName="en" />
    <culture cultureName="ru" />
  </cultures>
  <modules>
   <dashboard>
    <reportBox ServicesPlugins="true"/>
   </dashboard>
  </modules>
</pp>

• при создании экземпляра компонента KapBox, например:

kapBox = new Kap.KapBox({
    Metabase: metabase,
    ParentNode: "DashboardBox",
    Key: ppKey,
    Mode: ppMode,
    ServicesPlugins: true
});

3. Перезапустите веб-сервер, используемый веб-приложением.

После выполнения действий плагин будет зарегистрирован через сервисы, с помощью которых подключится в веб-приложении.

Для регистрации через явное задание плагина:

1. Добавьте описание плагина в файле «PP.xml». Внутри тега <pp> добавьте тег <plugins> с описанием, например:

<?xml version="1.0" encoding="utf-8" ?>
<pp>
  <service url=" http://localhost:9090/axis2/services/PP.SOM.Som" />
  <metabase id="REPOSITORY" ping="120000" />
  <cultures>
    <culture cultureName="en" />
    <culture cultureName="ru" />
  </cultures>
  <plugins>
    <plugin type="PP.Ui.MyLabel" path="../plugins/SourceLabel.js" loaded="true" name="SourceLabel"/>
  </plugins>
</pp>

2. Перезапустите веб-сервер, используемый веб-приложением.

После выполнения действий плагин будет зарегистрирован через явное задание плагина в файле «PP.xml».

Для регистрации плагина вручную:

1. Убедитесь, что *.js файл плагина не содержит блок регистрации.

2. Откройте аналитическую панель в веб-приложении.

3. Выполните метод regPluginBlock в консоли браузера:

Kap.regPluginBlock({
    Id:  "SOURCELABEL",   //id, по которому происходит связка плагин-блока с его реализацией
    Name:  "Sourcelabel",   //наименование типа блока
    View:  "PP.Ui.MyLabel",    //класс визуализатора или имя класса визуализатора
    Master:  "PP.Ui.MyMaster",    //класс мастера или имя класса мастера
    Icon:  "../build/img/app/MainIcon.png",    //путь к пиктограмме (16*16) для плагина, необязательный параметр
    SourceClass:  2561,    //код класса источника данных, если не задан то КАП не предоставляет плагину источник
    Js: "http://test/FP_App_v9.0/plugins/SourceLabel.js "   //для динамической загрузки скрипта с реализацией плагина, обязательный параметр
});

После выполнения действий плагин будет зарегистрирован и подключен вручную.

Важно. При регистрации плагина вручную все изменения настроек аналитической панели действительны до обновления страницы браузера.

(function ()
{
  if (window.Kap)
  {
    Kap.regPluginBlock({
      Id: "GROUPEDBARCHART",
      Name: "Grouped Bar Chart",
      View: "PP.Ui.Dashboard.StackedGroupedBarChart",
      Icon: "../build/img/app/MainIcon.png",
      SourceClass: PP.Mb.MetabaseObjectClass.KE_CLASS_EXPRESSREPORT,
      Js: "../plugins/StackedGroupedBarChart.js",
      Master: "PP.Ui.Dashboard.StackedGroupedBarChartMaster",
      Props: {
        pluginProps: {}
      }
    });
  }
})();

Props: { // для установки значений по умолчанию для некоторых свойств блока-плагина, необязательный параметр
    "name": "default name",
    "decor": {
    "useBorder": "false"
    },
   "pluginProps": "{ <свойства плагина>}"
}