Различия

Показаны различия между двумя версиями страницы.

--- product:api:integration_examples:navigator [11.04.2025 10:02] – создано ekaterina.menkhuzina
+++ product:api:integration_examples:navigator [11.04.2025 17:38] (текущий) – [Создание отчета типа «Электронная таблица» в ADVANTA] ekaterina.menkhuzina
@@ Строка 1: / Строка 1: @@
-====== Взаимодействие ADVANTA с BI-системой «Навигатор» ======
+====== Взаимодействие ADVANTA с BI-системой "Навигатор" ======
 [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] - российская платформа визуализации данных (BI) от компании «Сбер». Она заменяет такие системы, как «Power BI», «Qlik» или «Tableu».
@@ Строка 7: / Строка 7: @@
   - Сконструировать дашборд средствами системы [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]].
+<image shape="thumbnail">{{ :product:api:integration_examples:nav.png?800&direct |}}</image>
+===== Способы выгрузки из ADVANTA данных для "Навигатор" =====
+Если выгружать данные для дашбордов требуется редко, можно выполнять эту задачу вручную, путём экспорта отчёта ADVANTA в файл формата Excel.
+Если передавать данные надо регулярно, процесс можно автоматизировать, написав специальную программу. Организовать автоматическую выгрузку данных по расписанию можно двумя путями:
+  - Автоматизировать процесс экспорта заранее настроенного отчёта типа [[product:reports:excel_table_report|«электронная таблица»]] в файл формата Excel, аналогично выгрузке вручную.
+  - Получать данные об объектах ADVANTA в табличной форме через API-функции, без использования отчётов. Данные нужно записать либо в файлы, либо во внешнюю базу данных, откуда [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] сможет их загрузить.
+==== Выгрузка отчетов из ADVANTA в XLSX вручную ====
+Чтобы вручную выгрузить данные из ADVANTA, надо создать отчет, настроить в нем состав полей, после чего выгрузить его в XLSX-файл.
+Подробно процесс выгрузки описан на страницах о соответствующих типах отчетов:
+  * [[product:reports:excel_table_report:export|выгрузка в ''XLSX'' отчета типа «Электронная таблица»]];
+  * [[product:reports:interface#выгрузка_в_другие_форматы|выгрузка в ''XLSX'' отчета типа «Проекты и работы»]].
+==== Автоматизация экспорта отчетов ADVANTA в XLSX ====
+Отчеты типа [[product:reports:excel_table_report|«электронная таблица»]] можно выгружать из ADVANTA автоматически. Для этого требуется написать приложение, которое будет по расписанию получать файл отчета через метод API [[product:api:list:downloadspreadsheetreportfile|DownloadSpreadsheetReportFile]] и сохранять его на диске.
+При вызове этого метода в параметре ''reportId'' указывается идентификатор отчета ADVANTA, который можно найти в адресной строке браузера (''UID'').
+{{ :product:api:integration_examples:nav1.png |}}
+==== Автоматизация выгрузки данных об объектах в форматах XML или JSON ====
+API-функции ADVANTA позволяют выгружать данные об объектах в стандартных форматах обмена без использования отчетов. Для этого требуется написать приложение, которое будет вызывать API-функции и записывать полученные данные в файлы или во внешнюю СУБД.
+Есть два способа получения данных через API:
+  - [[product:api:list|API-функции SOAP]] позволяют получать данные из ADVANTA в формате ''XML''. Например, для получения таблицы проектов можно использовать API [[product:api:list:getproject|GetProject]], а для получения данных из прикреплённых к проектам таблиц – API [[product:api:list:getrecords|GetRecords]].
+  - [[product:linq:new#webapi|WebApi]] позволяет выполнять из внешнего приложения LINQ-запросы. Так можно получать данные об объектах ADVANTA в формате ''JSON''. При этом структуру таблиц можно гибко настраивать, используя возможности языка C#. Принципы работы с LINQ-запросами представлены на странице [[product:linq:start|"Модуль LINQ"]].
+===== Пример создания дашборда в BI "Навигатор" по данным из ADVANTA =====
+В примере будет создан дашборд, который покажет задачи проектов, завершённые с отклонением по времени. Для этого:
+  - На демостенде ADVANTA будет создан отчет с перечнем просроченных задач.
+  - Отчет будет выгружен в файл формата ''XLSX'' вручную и загружен в [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] в виде «источника».
+  - Будет настроен дашборд.
+==== Создание отчета типа «Электронная таблица» в ADVANTA ====
+На странице демостенда https://pmo.a2nta.ru нужно вызвать в Левом меню "Мои отчёты" → "Добавить отчёт". Запустится мастер создания отчёта. Выберем тип отчёта «Проекты и работы».
+На шаге «Какие данные нужно показать в отчете?» выберем {{:product:api:integration_examples:nav2.png|}} «Задача».
+Ниже, в области «Используйте дополнительные фильтры», укажем, что нужны только проекты одного направления. В строке «Фильтр по родительскому проекту» нажмём кнопку «Включить».
+{{ :product:api:integration_examples:nav3.png?500 |}}
+Появится страница выбора узла в [[product:objects:object_tree|Дереве проектов]] - нажмём кнопку «Выбрать» в строке «Портфель проектов цифровизации». Выбранное направление будет добавлено в область «Проекты в профиле».
+<image shape="thumbnail">{{ :product:api:integration_examples:nav4.png?600&direct |}}</image>
+Завершим настройку фильтра по [[product:objects:object_tree|Дереву проектов]] кнопкой «Выбрать». Для завершения формирования отчета нужно нажать кнопку "Показать отчет" - появится страница отчета со стандартным набором полей:
+  * Название;
+  * Статус;
+  * Исполнитель;
+  * Планируемая дата завершения.
+{{ :product:api:integration_examples:nav5.png |}}
+Добавим в отчет дополнительные поля, которые потребуются в дашборде. Для этого зайдем меню "три точки" → "Изменить" - появится редактор настроек отчета. В редакторе настроек нужно найти раздел «Даты объектов» и включть чекбоксы в полях «Утверждённая дата завершения» и «Фактическая дата завершения», в разделе «Системные показатели» включить чек-бокс у поля «Отклонение окончания».
+{{ :product:api:integration_examples:nav6.png |}}
+Добавим поле с названием проекта, в который входит задача. Для этого в разделе «Источник» нажмем кнопку «Добавить» - появятся поля для выбора вышестоящего объекта. В списке типов объектов выберем «Проект цифровизации», а правее, в поле «Название колонки» напишем «Проект».
+{{ :product:api:integration_examples:nav7.png |}}
+Завершим настройку кнопкой «Показать отчет» в верхней части окна настроек. Выбранные столбцы появятся в отчете.
+{{ :product:api:integration_examples:nav8.png |}}
+Далее нужно настроить фильтры данных так, чтобы в отчет попадали только задачи, завершённые не вовремя. Для этого в области фильтров записей отчёта установим для параметра «Отобрать по» значение «Утверждённые даты» и включим чек-бокс «Только просроченные».
+{{ :product:api:integration_examples:nav9.png |}}
+В табличной части отчёта, в поле «Статус» установим фильтр по значению «Завершен».
+{{ :product:api:integration_examples:nav10.png |}}
+В верхней части страницы отчета, в поле «Название» введём «Задачи с отклонением по дате завершения» и сохраним отчёт кнопкой «Сохранить». Теперь отчет станет доступен в Левом меню ADVANTA, в разделе «Мои отчеты».
+==== Выгрузка отчета ADVANTA в файл формата XLSX ====
+На странице отчета нужно вызвать меню "три точки" → "Экспорт в" → "Экспорт в XLSX". Проявится диалог сохранения Excel-файла на диск. Выберем каталог и сохраним файл.
+{{ :product:api:integration_examples:nav11.png?500 |}}
+В указанном каталоге появится XLSX-файл, можно просмотреть его в Excel.
+==== Создание источника данных в BI «Навигатор» ====
+В системе [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] нужно перейти в панель управления (АРМ: Администрирование).
+{{ :product:api:integration_examples:nav12.png |}}
+Откроем страницу создания источника данных.
+{{ :product:api:integration_examples:nav13.png |}}
+Добавим новый источник данных «Из файла».
+{{ :product:api:integration_examples:nav14.png |}}
+В окне «Новый источник» введём название, аналогичное нашему отчёту («Задачи с отклонением по дате завершения»). Выберем предметную область и нажмём «Загрузить».
+Далее найдем и откроем XLSX-файл, выгруженный ранее из ADVANTA. Появится страница загрузки данных из файла.
+{{ :product:api:integration_examples:nav15.png |}}
+<callout type="warning" icon="true">Поля отчета ADVANTA, на которые были наложены фильтры, загружаются с символом «*» в названии (в нашем случае, поле «Статус»). Чтобы в работе с таким полем далее не возникло проблем, [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] автоматически заменяет спецсимвол на знак подчёркивания.
+{{ :product:api:integration_examples:nav16.png |}}
+Чтобы символ подчёркивания не усложнял работу можно удалить его, переименовав поле.
+</callout>
+Для сохранения источника, нажимаем кнопку «Загрузить», справа внизу. Созданный источник проявится в списке.
+{{ :product:api:integration_examples:nav17.png |}}
+==== Создание дашборда на основе источника данных из ADVANTA ====
+Перейдём в раздел «Визуализация → Дэшборды» и создадим новый кнопкой «Новый дэшборд». Назовём его «Задачи проектов, завершённые не в срок».
+На странице редактирования дашборда добавим новый «Экран» типа «Лента».
+{{ :product:api:integration_examples:nav18.png |}}
+Лишний экран типа «Сетка», созданный по умолчанию, нужно удалить.
+Переименуем экран в «Просроченные задачи проектов» и добавим новый глобальный набор данных. Он появится слева, в меню структуры экрана. Переименуем его в «Таблица задач».
+{{ :product:api:integration_examples:nav19.png |}}
+Далее перейдем на страницу редактирования набора данных «Таблица задач» двойным кликом по его названию в левом меню.
+{{ :product:api:integration_examples:nav20.png |}}
+В поле «Источник данных» выберем источник «Задачи с отклонением по дате завершения», настроим набор полей.
+{{ :product:api:integration_examples:nav21.png |}}
+Переименуем поля для отображения на экране:
+  * nazvanie -> Название задачи;
+  * ispolnitel -> Исполнитель;
+  * proekt -> Проект;
+  * otklonenie_okonchaniya -> Отклонение.
+{{ :product:api:integration_examples:nav22.png |}}
+Далее нужно вернуться на страницу дашборда по кнопке «Дэшборд». В окне структуры дашборда слева выберем каталог «Новая группа» и вызовем пункт меню «Добавить виджет». В списке возможных виджетов выберем диаграмму «Круговая».
+{{ :product:api:integration_examples:nav23.png |}}
+Виджет диаграммы появится в каталоге группы виджетов в окне структуры. Переименуем его в «Наибольшее отклонение» с помощью поля свойств виджета справа.
+Перейдём на страницу настройки виджета двойным кликом по нему в левом меню.На странице настроек виджета, в поле «Набор данных» выберем созданный нами набор «Таблица задач».
+{{ :product:api:integration_examples:nav24.png |}}
+В поле «Название» выберем «Название задачи».
+{{ :product:api:integration_examples:nav25.png |}}
+В поле «Значения» выберем «Отклонение».
+{{ :product:api:integration_examples:nav26.png |}}
+В правой части окна мы увидим превью созданного виджета.
+{{ :product:api:integration_examples:nav27.png |}}
+Далее вернемся на страницу дашборда. В правой части окна настроек дашборда установим параметры:
+  * Генерировать из = Таблица задач;
+  * Поле для сегментации = Проект.
+{{ :product:api:integration_examples:nav28.png |}}
+Построим созданный дашборд кнопкой «Показать в Навигаторе».
+{{ :product:api:integration_examples:nav29.png?400 |}}
+Откроется новая вкладка браузера с созданным дашбордом. Для каждого из проектов, попавших в выборку дашборд отобразит круговые диаграммы с перечнем не вовремя завершённых задач и указанием количества дней срыва сроков.
+{{ :product:api:integration_examples:nav30.png |}}
+Таков общий принцип ручной передачи данных из ADVANTA в BI-систему [[https://platformv.sbertech.ru/products/analitika-dannyh/navigator|Навигатор]] для построения в ней дашбордов.
+<callout type="info" icon="true">Если возникнет потребность в автоматизации процесса выгрузки, рекомендуем обратиться к специалистам по внедрению ADVANTA для проработки вариантов с учётом специфики вашего решения.</callout>