Skip to content

Руководство пользователя

webzavod edited this page Apr 7, 2020 · 11 revisions

Запуск ДашбордКоннектор

Запуск клиента ДашбордКоннектора производится путем перехода к сайту с параметрами, использовавшимися при установке. По умолчанию переход должен осуществляться по адресу http://localhost:8080. Перед запуском нужно установить ДашбордКоннектор в соответствии с документацией.

Создание соединения

Соединение создается в Яндекс DataLens. Для этого надо приобрести соединение в магазине, затем нажать на кнопку Создать соединение, выбрать ДашбордКоннектор ввести название соединения. После этого откроется страница с параметрами соединения. После запроса OAuth-токена заполнится соответсвующее поле.

Далее создается соединение в клиенте ДашбордКоннектор, для этого надо нажать на плюс

image-20191223094621753

В открывшемся окне необходимо ввести имя соединения (обязательно) и описание соединения: image-20191223094832751

После этого создается соединение с пустыми настройками

image-20191223095425899

Установка параметров соединения

Установка параметров соединения состоит из четырех частей, в которых устанавливаются следующие параметры:

  • соединения к сервису OData 1С;
  • соединению Яндекс DataLens;
  • выбираются загружаемые сущности, функции и их атрибуты;
  • выбирается расписание для периодического обновления данных в Яндекс DataLens.

Установка параметров соединения к сервису OData 1C

image-20191223095234910

Установка параметров соединения к Яндекс DataLens

image-20191223095333093

Выбор сущностей и полей сущностей 1С для загрузки

Выбор сущностей осуществляется на закладки Данные соединения. При этом будут загружаться метаданные 1С, но первый раз, после существенного простоя 1С, этот процесс может занять несколько минут. После загрузки метаданных на закладке отображается дерево сущностей 1С:

image-20200124150954672

Выбор сущностей самостоятельно

В зависимости от типа сущности, в дереве могут отображаться функции, кроме полей.

image-20200124152323140

У каждой функции так же есть свой набор полей. Кроме этого, в поле Дополнительные параметры можно вписать, например, выражение фильтра, описанное в документации 1С.

Выбор Свойств (полей) возможен либо в самой сущности, либо в функции. Одновременное выделение - недопустимо. Выделение отдельных полей осуществляется кликом на чекбокс рядом с названием, при этом сущность выделяется цветом

image-20200124153021425

и становится возможным осуществить просмотр данных. Для этого можно нажать на иконку рядом с названием сущности и перейти на страницу предпросмотра данных, где показываются сами данные и текст OData-запроса к сервису 1С

image-20200124153401334

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

Выбор сущностей с помощью шаблона отчета

Для выбора сущностей и их свойств из шаблона необходимо выбрать необходимый шаблон из списка, который находится над деревом сущностей 1С: image-20200124153946662

При этом выделятся все найденные сущности и свойства.

Настройка параметров расписания

Для удобства можно настроить расписание выполнения синхронизации данных между 1С и DataLens. Внимание! Синхронизация будет выполнятся только на включенном компьютере. В расписании можно выбрать произвольную периодичность выполнения синхронизации для каждого соединения.

Синхронизация не является инкрементой, поэтому рекомендуется, в зависимости от объема данных и мощности сервера с 1С, выполнять синхронизацию в нерабочее время. Частое выполнение синхронизации может повлечь за собой дополнительные расходы по оплате услуг Яндекс DataLens.

Просмотр результатов работы коннектора

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

Работа с шаблонами

Шаблон отчета - это набор данных, достаточный для того, что бы построить отчет, того или иного вида. Шаблоны работают с данными стандартных конфигураций 1С. В каждом шаблоне есть описание того, что отчет обозначает и с какой конфигурацией он работает. Шаблоны распространяются в виде JSON файлов, которые можно получить с GitHub.

Добавление шаблона из файла

Предварительно шаблон необходимо загрузить в локальную папку на компьютере пользователя. Затем выбрать слева "Шаблоны" и нажать на кнопку загрузки шаблона:

image-20191205163530441

Далее необходимо выбрать файл и нажать кнопку Открыть или Open (в зависимости от языковых настроек компьютера): image-20191205163841100

После этого шаблон появится в списке доступных шаблонов:

image-20191205164317579

Обновление шаблона из файла

Обновление шаблона происходит аналогично тому, как происходит добавление шаблона. При этом новая версия шаблона заменяет старую в локальном хранилище ДашбордКоннектор.

Удаление шаблона

Удаление шаблона происходит при нажатии на символ корзины image-20191205164608207рядом с выбранным шаблоном. При этом шаблон удаляется из локального хранилища ДашбордКоннектор.

Добавление и обновление шаблона онлайн

Для добавления и, в случае необходимости, обновления шаблона необхожимо нажать кнопку Онлайн, при этом загрузится список доступных шаблонов и откроется окно выбора добавляемых или обновляемых шаблонов:

после выбора шаблона и нажатия кнопки OK происходит добавление и/или обновление выбранных шаблонов

Создание датасета в Яндекс DataLens

После первой успешной синхронизации можно создавать Датасет. Для этого в настройках соединения в DataLens нужно нажать кнопку Создать датасет, после этого откроется страница настроек датасета. Настройки должны производиться в соответствии с разделом Работа с Датасетами документации DataLens В дальнейшем, после синхронизаций, создавать датасет не нужно. Данные будут обновляться автоматически.