Руководство по администрированию

Платформа обработки документов

BIOM ANALYTICS

Руководство по администрированию

Версия 1.0

1. КАЛЕНДАРЬ

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

Например, вы можете отслеживать свое рабочее время с 10 утра до 6 вечера с понедельника по пятницу и исключить выходные дни. В данном случае, если заказ получен в полдень в пятницу и обработан в полдень в понедельник, это означает, что время обработки составляет 8 часов, а не 36 часов.

Эта функция обеспечивает лучшую визуализацию ваших бизнес-процессов, скрывая нерабочие интервалы от графиков.

В BIOM можно использовать эту функцию в трех случаях:

для расчета рабочих дней в определенном временном интервале
для показа только рабочих дней (или часов) на графиках с разбивкой по времени
для создания отчетов и запусков планов выполнения в течение заданного интервала времени

Календарь определяет рабочие часы для каждого конкретного дня.

Основное расписание – время начала и окончания каждого дня недели

Пример:

Вс: 10:00 – 14:00,
Пн: 9:00 – 17:00,
Вт: 9:00 – 17:00,
Ср: 9:00 – 17:00,
Чт: 9:00 – 17:00,
Пт: 9:00 – 17:00,
Сб: 9:00 – 17:00

Исключения – время, которое не включено в расписание

Пример:

1/1/2016 – Не включено
27/5/2016 – Не включено
3/7/2016 – 9:00 – 00:00
4/7/2016 – Не включено
25/12/2016 – Не включено

1.1. Добавление календаря

В Консоли администратора в Дереве документов нажмите правой кнопкой мыши по Календари и выберите Создать календарь.
Дайте название календарю и нажмите Создать.
Появится окно редактора календаря.
Определите основное расписание для календаря и сохраните изменения, нажав на панели инструментов Действия кнопку Сохранить.

1.2. Определение исключений для календаря

Вы можете определить исключения для календаря, чтобы исключить расчет времени, например, праздничные или выходные дни.

В Консоли администратора перейдите в Календари.
Выберите календарь для определения исключений.
Под строчкой Исключения нажмите на значок плюса * . Появится окно Исключение.
Введите Дата и время для исключения и нажмите OK. Исключение появляется в списке исключений
Чтобы удалить выделенное исключение нажмите на значок крестика
Чтобы внести изменения в выделенное исключение нажмите на значок .
Сохраните изменения.

1.3. Редактирование календаря

В Консоли администратора перейдите в Календари и нажмите на название календаря чтобы его отредактировать.
Внести изменения в календарь и нажмите Сохранить.

2. АВТОРИЗАЦИЯ

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

Роль администратора — эта роль включает все права для всех документов (объектов) проекта BIOM, а также для недавно созданных проектов и документов
Роль пользователя — администратор конкретные права для этой роли. Это выполняется на этапе создания нового проекта.

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

3. РОЛИ

Роль администратора — эта роль включает все права для всех документов (объектов) проекта BIOM, а также для недавно созданных проектов и документов
Роль пользователя — администратор конкретные права для этой роли. Это выполняется на этапе создания нового проекта.

Пользователям нельзя назначать эту роль. Если BIOM настроен на доступ без какой- либо аутентификации, пользователи в этой роли получают доступ к дашборду по умолчанию и маркерам, когда запускают Viewer. Права пользователя определяются ролью или ролями, к которым он принадлежит. Каждый пользователь должен принадлежать к определенной роли, чтобы получить доступ к Viewer или другим приложениям BIOM. Единственное исключение может быть сделано, когда для всех приложений BIOM не установлена аутентификация.

3.1. Роль администратора

Когда вы создаете базу данных Administrative, пользователь Administrator и роль администратора создаются автоматически. Роль администратора по умолчанию автоматически назначается пользователю Administrator.

По умолчанию роль администратора дает права доступа ко всем приложениям BIOM (Studio, Дизайнер), а также к проектам, источникам данных и документам проекта (показателей, моделей, справочников, дашбордов и других), а также специальные права.

Чтобы открыть роль администратора в Консоли администратора перейдите в Авторизация далее в раздел Пользователи затем нажмите на пользователя Administrator. Это роль является ролью администратора по умолчанию.

3.2 Роль администратора

Вы можете создать несколько ролей администратора.

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

3.3. Роль пользователя

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

В Дереве документов нажмите правой кнопкой мыши по Авторизация и выберите Создать пользовательскую роль.
Введите имя для новой роли.
В подразделе Права на документы выберите к каким компонентам BIOM получит доступ эта роль.
В подразделе Права на чтение выберите, какой проект и какая часть каждого проекта будет доступна для просмотра этой роли.
В подразделе Права на редактирование выберите параметры редактирования. Если для документов (моделей, показателей, дашбордов, задач или других) выбрана только опция Права на чтение, то пользователю будет разрешено только просматривать документ. Если вы выбрали Права на редактирование, то пользователь может просматривать и изменять документ.
В подразделе Специальные права выбрать какие действия роль может выполнять с файлами. Пользователю теперь доступно:

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

3.4 Назначение роли пользователю

После создания группы администраторов или пользовательской роли вы можете назначить ее пользователю.
Если одному пользователю назначены две роли и например, одна роль предоставляет доступ к некоторому дашборду, а другая запрещает его просмотр, то обе эти роли объединяются. В этом случае пользователь имеет необходимые права для данного дашборда.
В случае, когда пользователю назначены две роли и эти роли имеют разные дашборды по умолчанию, то дашборд по умолчанию для этого пользователя берется из роли, которая расположена выше в списке ролей в дереве документов.
1. В Консоли администратора перейдите в Пользователи.
2. Выберите пользователя, которому будет назначена роль.
3. Выберите роли, которые нужно назначить пользователю и сохраните изменения.

3.5. Управление списком ролей

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

В Консоли администратора перейдите в Авторизация.
Нажмите правой кнопкой мыши и выберите необходимое действие.

3.6. Копирование и вставка роли

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

В Консоли администратора перейдите в Авторизация, выберите необходимую роль и нажмите правой кнопкой мыши.
Выберите из списка функцию Копировать.
Нажмите правой кнопкой мыши по Авторизация и выберите Вставить.

Появляется редактор скопированной роли вместе со всеми используемыми настройками.

Присвойте уникальное имя и обновите настройки для скопированной роли.
Нажмите Сохранить.

4. НАСТРОЙКА ПАРАМЕТРОВ ЭЛЕКТРОННЫЙ ПОЧТЫ

Используйте Настройки электронной почты для установки конфигурации сервера, необходимой для отправки уведомлений по электронной почте.

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

Вы также можете настраивать протокол передачи данных SMTP-сервер для отправки по электронной почте, поскольку BIOM не имеет заранее назначенного сервера для нее.

В Консоль администратора перейдите в Настройки системы.

Откроется редактор параметров настроек системы.

В подразделе Электронная почта выберите такие опции как Включить SSL, Использовать аутентификацию. Выберите Использовать аутентификацию, если ваш сервер электронной почты требует аутентификацию для подключения и отправки электронной почты.
Заполните поля информацией о сервере электронной почты, которые вам нужны, чтобы BIOM использовал их для отправки сообщений электронной почты.
Заполните поля Пользователь и Пароль, используемые для аутентификации.
Введите адрес электронной почты для электронной почты администратора.

В инструменте дашборда BIOM оповещения могут быть отправлены различным адресатам по электронной почте. Оповещения будут отправляться с назначенной электронной почты администратора.

В подразделе Прочие настройки введите URL-адрес приложения Viewer.

В подразделе Электронная почта нажмите Отправить тест чтобы убедиться в правильности настроек перед сохранением настроек электронной почты.

5. АУТЕНТИФИКАЦИЯ

5.1. Пользовательская аутентификация

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

5.1.1 Настройка аутентификации пользователей

Для аутентификации можете назначить идентификатор пользователю или задать параметры, связанные с именем пользователя или настройками электронной почты.

В Консоли администратора на дереве документов нажмите на Аутентификация пользователей и выберите проект из списка. Панель Аутентификация пользователей отображается с выбранной вкладкой Идентификатор пользователя.
Укажите способ получения идентификатора пользователя. Этот идентификатор должен быть постоянным для конкретного входа пользователя. Обычно этот идентификатор является параметром запроса, таким как Identity, которое обращается к домену активной директории/user.name.

Поля Имя пользователя и Email не являются обязательными.

На вкладке Имя пользователя задайте отображаемое имя для учетной записи пользователя. Отображаемое имя обычно является одним из свойств активной директории.
На вкладке Электронная почта задайте адрес электронной почты для учетной записи пользователя. Адрес электронной почты обычно является одним из свойств активной директории, таких как EmailAddress.

5.2. Доменная аутентификация (HTTP)

Когда пользователи получают доступ к панели инструментов БИОМ из другого приложения, им не требуется повторно входить в систему для доступа к ней. Чтобы не дублировать вход, вызывающее приложение может открыть панель инструментов через HTTP-запрос. В этом случае вызывающее приложение передает панели инструментов такой параметр, как sessionid.

6. ЗАВЕРШЕНИЕ НАЧАЛЬНЫХ НАСТРОЕК

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

В Консоли администратора на дереве документов нажмите правой кнопкой мыши на пункт Подключения и выберите Создать подключение.
Введите название нового подключения и нажмите ОК.
Введите информацию для подключения.
Перейдите в Консоль администратора и выберите Настройки приложений.
В окне Настроек приложений в разделе Тип аутентификации выберите Базовая (НТТР).
Ниже, в способах аутентификации пользователя, выберите вариант из раздела Идентификатор пользователя. Идентификатор пользователя должен быть уникальным и постоянным для каждого пользователя для разных сеансов. Этот идентификатор используется для определения прав собственности на представления, оповещения и так далее.

Используя HTTP-запросы вы всегда должны включается параметр Идентификатор пользователя. Дополнительные параметры являются необязательными.
Возможные варианты содержат:

Использование Имени пользователя для применения имени пользователя БИОМ в качестве идентификатора пользователя.
Использование Параметра запроса для передачи идентификатора в качестве параметра HTTP. В этом случае необходимо перечислить значения параметров.
Использование Запроса к внешнему источнику для получения идентификатора пользователя из базы данных. Вы можете передать параметр сессии как часть запроса.

Параметр запроса чувствителен к регистру. Убедитесь, что вы используете правильное наименование параметра в своем SQL команде. В SQL-запросах каждый параметр URL должен быть заключен в угловые скобки <> для числовых значений и в одинарные кавычки и угловые скобки (‘< и >’) для строк. Например, если параметр UserID является числовым, вы можете указать его как <UserID>,

если строковым, например, параметр Active Directory Identity, используйте одинарные кавычки: ‘<Identity>’.

Пример

Select Identifier from Users where <Staff_ID = UserID>

Где:

Staff_ID и Identifier это поля таблицы User.

UserID является URL параметром.

Зайдите на вкладку Имя пользователя. (Необязательно) Выберите из доступных вариантов.

Запретить аутентификацию для пользователей с пустым именем.
Электронная почта.
Параметр запроса. Пример: UserName (имя пользователя). Через параметр в HTTP-запросе (Свойство сеанса), где UserName – переменная, передаваемая в HTTP-заголовке.
Запрос к внешнему источнику. Введите Источник и запрос. Например, select FullName from Users where Staff_ID=.

Зайдите на вкладку Электронная почта. (Необязательно)

Параметр запроса. Используется URL параметр, например,
Запрос к внешнему источнику. Введите источник и запрос. Например, select Email from Users where Staff_ID=<UserID>.

На панели инструментов нажмите Сохранить.

7. НАСТРОЙКИ АВТОРИЗАЦИИ

Вы можете назначить пользователям с роли двумя способами.

С помощью пользовательского запроса к базе данных.
С помощью фиксированных значений.

7.1. Пользовательские запросы к базе данных

В Консоли администратора на дереве инструментов нажмите на пункт Настройки приложений.
Отметьте тип аутентификации Базовая (НТТР) для нужного приложения из перечисленных слева.
В Консоли администратора нажмите правой кнопкой мыши на пункт Авторизация и выберите Создать пользовательскую роль. Введите название для новой роли и нажмите ОК.
На вкладке Доступ в приложения отметьте флажки у тех приложений, которые должны быть доступны для созданной роли.
На вкладке Запрос для авторизации в поле Подключение введите строку подключения к базе данных. В области под полем Подключение введите SQL запрос.

В SQL-запросе каждое свойство URL должно располагаться в пределах символов < и > для числовых значений и в пределах ‘< и >’ для строк.

Любые параметры из строки НТТР-запроса могут использоваться в запросе к БД.

Пример

elect *from Roles_Mapping where Staff_ID=” and Group_ID = ‘Role’

Где:

Staff_ID и Group_ID являются полями таблицы Roles_Mapping.

User ID – это параметр из НТТР-запроса.

‘Role’ – это идентификатор/наименование конкретной роли.

Если запрос возвращает как минимум одно значение, пользователь получает права на выбранную роль.

7.2. Фиксированные значения

В Консоли администратора на дереве документов кликните на Настройки приложений.
Отметьте тип аутентификации Базовая (НТТР). >В этом случае параметры, отправленные с помощью НТТР-запроса, сравниваются с фиксированными значениями.
В Консоли администратора нажмите правой кнопкой мыши на пункт Авторизация, и левой кнопкой мыши на Создать пользовательскую роль. Задайте название новой роли и нажмите ОК.
На вкладке Доступ в приложения отметьте флажки у тех приложений, которые должны быть доступны для созданной роли.
На вкладке Условия для авторизации определите свойство, которое необходимо сравнить.

- Нажмите на Добавить условие
- Добавьте свойство, которое будет сравниваться, например, UserID. >Этот параметр передается в URL.
- Для параметра Оператор установите значение Включает(=) из выпадающего списка и заполните фиксированное значение.

8. ПАРАМЕТРЫ ПРИЛОЖЕНИЯ

Параметры приложения позволяют управлять свойствами приложения.

8.1. Свойства приложения

Следующие свойства приложения доступны в разделе Другое на Панели свойств.

Свойство	Описание
Интервал сеанса автоматической проверки	Позволяет установить интервал автоматической проверки сеанса в днях, часах, минутах и секундах.
Интервал автоматического выхода	Позволяет установить интервал автоматического выхода из системы в днях, часах, минутах и секундах.
Верхние колонтитулы	Используйте этот параметр для определения заголовка для приложения. Например, вы можете использовать заголовки X-Frame-Options HTTP Response, чтобы указать, должен ли браузер отображать страницу в i¬frame. В многопользовательской среде заголовок может быть разным для каждого пользователя (например, один пользователь разрешает использовать Insight в i-frame, а другой запрещает).
Повторный вход при обновлении	При бездействии после обновления или повторного открытия страницы используется текущая сессия. При активном использовании пользователю придется повторить процедуру аутентификации и авторизации.
Интервал автоматического	Доступно только для Приложения для просмотра. Позволяет установить интервал обновления в днях, обновления часах, минутах и секундах.
Кэшированная модель	Доступно только для Приложения для просмотра. Если опция включена, данные сохраняются в кэше локального клиента (браузера). Неизменяемые данные извлекаются из кэша, поэтому запросы данных выполняются быстрее.Если что-то меняется в проекте или в глобальных настройках в консоли администратора (например, тема), модель будет снова запрошена с сервера и обновлена в кэше.Если опция отключена, данные всегда запрашиваются с сервера.Рекомендуется включить этот параметр.
Язык по умолчанию	Доступно только для Приложения для просмотра.Позволяет выбрать язык по умолчанию. Этот язык будет использоваться в качестве предпочтительного, если пользователь не выбрал вручную какой-либо другой язык в дашборде.

9. ПОЛЬЗОВАТЕЛЬСКИЕ СТРАНИЦЫ

Раздел Пользовательские страницы на Панели свойств позволяет вам определить пользовательские страницы ошибок и выхода из системы для приложений БИОМ.

Пользовательские страницы должны быть HTML-страницами, загруженная страница сохраняется в БИОМ DataFolder/CustomPages и используется при открытии страницы. Страница может содержать пользовательские данные (изображения, скрипты, стили), которые могут быть скопированы в папку приложения БИОМ (<ХранилищеУстановки>/Htmlbiom/ПользовательскиеИсточники). HTML-страница должна содержать ссылку на эту папку.

В качестве шаблонов HTML-страницы можно использовать следующие элементы.

{{Locale}} – шаблон будет заменять текущую локаль пользователя, например en- US.
{{Model}} – объект JavaScript, который имеет следующие свойства.
ApplicationName – наименование приложения (Studio, Admin Console и другие).
Version – версия БИОМ.
Error – сообщение об ошибке (для страницы ошибки).

Модель может быть присвоена переменной и использоваться в сценарии на HTML-странице по мере необходимости.

Пример HTML-страницы ошибки

<html lang=”en”>

<meta name=”viewport”content=”width=device-width”>

<meta http-equiv=”content-type”content=”text/html; charset=utf-8″> <title>Пользовательская ошибка</title>

<head>

<style>label {display: block;}body {display: flex;align-items: center;justify- content: center;}.error {color: red;}</style>

<script>var biomModel = {{Model}};var locale = ‘{{Locale}}’;</script>

</head>

<body>

<script>if(biomModel.error) {const error = document.createElement(‘div’);error.textContent = biomModel.error;error.classList.add(‘error’);document.body.append(error);} </script>

</body>

</html>

Вы также можете создать пользовательские страницу входа для БИОМ и панель входа для аутентификации. Эта страница должна содержать форму с подтверждением действия в CustomLogin. К этой странице можно добавить шаблон модели со сценарием ошибки, как показано в примере страницы ошибки.

Пример HTML-страницы входа в систему

<html lang=”en”>

<meta name=”viewport” content=”width=device-width”>

<meta http-equiv=”content-type” content=”text/html; charset=utf-8″>

<title>Пользовательский вход</title>

<head>

<style>label {display: block;}

body {display: flex; align-items: center; justify-content: center;}.error {color: red;}</style>

<script>var biomModel = {{Model}};var locale = ‘{{Locale}}’;</script>

</head>

<body>

<form action=”CustomLogin” method=”post”>

<label>клиент <input name=”client”/></label>

<label id=”user”>пользователь <input name=”user”/></label>

<label>пароль <input name=”password”/></label>

<input type=”submit” value=”Login”/>

</form>

<script>

if(insightModel.error) {

const error = document.createElement(‘div’);

error.textContent = biomModel.error;

error.classList.add(‘error’);

document.getElementById(‘user’).after(error);}

</script></body>

</html>

10. ПЕРЕНАПРАВЛЕНИЕ ПОЛЬЗОВАТЕЛЕЙ НА ТРЕБУЕМЫЙ URL ПОСЛЕ ВЫХОДА ИЗ СИСТЕМЫ

Если вы хотите перенаправлять пользователей обратно в вашу систему вместо стандартной страницы выхода БИОМ после истечения срока действия сессии или после выхода пользователей из системы, создайте Фильтр данных с предопределенным именем “LogoutUrl” и определите требуемый абсолютный или относительный URL в запросе. После создания такого фильтра БИОМ перенаправляет пользователей на заданную страницу.

11. ПОДКЛЮЧЕНИЯ

Используйте этот раздел для выполнения следующих операций:

Для подключения к внешней базе данных.
Для настройки нескольких строк подключения

11.1. Подключения к внешней базе данных

Используйте окно Подключения, чтобы установить соединение между БИОМ и внешней базой данных.

В Консоли администратора на дереве документов нажмите правой кнопкой мыши на Подключения и выберите Создать подключение. Появится соответствующее окно.
Введите имя для новой общей базы данных и нажмите OK. Появится окно Подключение.
Введите информацию о базе данных, такую как Тип источника, Сервер, Тип подключения, Имя источника.
На Панели свойств выберите Дополнительные параметры, чтобы задать дополнительные настройки для строки подключения.
Введите Имя пользователя и Пароль или установите флажок Проверка подлинности Windows.
На Панели инструментов нажмите Сохранить.

11.2. Поддержка нескольких подключений

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

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

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

12. ПОЛЬЗОВАТЕЛИ

На панели Пользователи определите и настройте пользователей и их роли. Используйте этот раздел для выполнения следующих операций:

Создание пользователя.
Работа с пользователями.

12.1. Создание пользователя

В Консоли администратора на дереве документов правой кнопкой мыши нажмите на Пользователи и выберите Создать пользователя.
Введите имя нового пользователя и нажмите ОК.
Заполните данные о пользователе, такие как Имя учетной записи, Отображаемое имя пользователя, Пароль и политики паролей.
Выберите Требовать использование политики паролей, чтобы включить проверку надежности пароля. В этом случае пароль должен соответствовать следующим правилам:

- Содержать не менее 8 символов
- Содержать хотя бы один буквенный символ (a-z; A-Z)
- Содержать хотя бы одну цифру (0-9)
- Содержать хотя бы один специальный символ. Пример: @&%”

В разделе Роли отметьте флажки у тех ролей, которые доступны данному пользователю.

12.2. Работа с пользователем

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

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

Платформа обработки документов

BIOM ANALYTICS