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

• Навигация
• Раздел «Пользователи»
• Вкладка «Данные»
• Вкладка «Потоки»
• Вкладка «Группы»
• Вкладка «Черновики»
• Вкладка «Подключения»
• Раздел «Группы»
• Вкладка «Пользователи»
• Вкладка «Потоки»
• Вкладка «Подключения»
• Раздел «Потоки»
• Вкладка «Доступы»
• Вкладка «Проекты»
• Раздел «Лицензии»
• Раздел «Задания»
• Активные директории
• Справочные материалы
• Роли пользователей в системе
• О правах доступа
• Синтаксис заданий для CRON
• Рефреш токены аутентификации

Навигация

Зайти в панель администратора можно с главной страницы приложения (Менеджер проектов).

В верхней части страниц расположена навигация по всем разделам (1). Большая часть разделов панели администратора собрана типовым шаблоном, где слева изображен список сущностей (3) выбранного раздела. А при выделении одного из них, в центральной части (4) отображаются параметры, соответствующие текущей вкладке этого раздела. Выход из панели администратора через кнопку «стрелка назад» (2).

Работа с элементами списка раздела (3), также построена идентичным образом:

• При наведении на элемент списка, появляется кнопка «Корзинка». Это значит что элемент можно удалить по нажатию на эту иконку
  
  
  
  
• Также в некоторых разделах есть возможность изменить название выбранного элемента списка. Для этого необходимо навести на название в заголовке раздела. Доступные действия появятся с соответсвующими иконками. В данно мслучае это «Редактировать» и «Удалить»
  
  
  
  
• В нижней части списка расположена кнопка «Создать ... » зависит от раздела. Будет создан пользователь, группа, поток и т.д.
  
  

  

  
  

Работа с вкладками (4) выделенного элемента списка. На большинстве вкладок разделов находится таблица, в которой собран список тех или иных сущностей связаных с разделом. Основная задача этой таблицы (как и вкладки) управлять этим списком (также идентична во всех разделах такого рода):

• Строка поиска. Отфильтрует таблицу по названию элемента
  

  
  

  
  
• Кнопка «Добавить». У каждого подобного раздела можно пополнить или изменить количество элементов таблицы. 
  

  
  

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

  

  
  

Раздел «Пользователи»

Вкладка «Данные»

Позволяет совершить следующие действия:

• Создать пользователя
• Изменить пароль или роль пользователя
• Выдать или забрать лицензию. 
• Удалить пользователя

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

Редактировать данные

На вкладке «Данные» администратор может изменить данные пользователя:

Удалить пользователя

После этого пользователь будет удален из системы. Его лицензия будет освобождена для другого пользователя

Выдача лицензии

Данное действие дублирует то же самое в разделе «Лицензии». При создании пользователя, либо при сохранении изменений система проверит есть ли в лицензионном ключе свободная лицензия с данной ролью, и если да, то добавит пользвателя в список. 

Вкладка «Потоки»

На этой странице администратор управляет доступами пользователя к потокам системы. Таблица содержит все доступы текущего пользователя к потокам. На этой странице администратору доступны следующие действия:: 

• Просмотреть все потоки пользователя с правами доступа.
• Добавить новые доступы к потокам данному пользователю. Через кнопку «Добавить» и выбор одного или нескольких потоков в открывшемся модальном окне.
• Изменить права доступа к имеющимся потокам. Через кнопку «Карандаш» в строке конкретного потока
• Удалить доступ данного пользователя к потокам. Через кнопку «Корзинка» в строке конкретного потока
  
• Если пользователь имеет доступ к потококу в составе группы, то поскольку права и сам доступ определен на уровне этой группы на странице пользователя мы можем только увидеть их наличие. А отредактировать только на странице самой группы.

Вкладка «Группы»

На этой странице администратор управляет доступами пользователя к группам системы. Таблица содержит все группы в которые добавлен текущей пользователь. На этой странице администратору доступны следующие действия: 

• Просмотреть все группы пользователя.
• Добавить пользователя в другие группы. Через кнопку «Добавить» и выбор одной или нескольких групп  в открывшемся модальном окне.
• Удалить пользователя из групп. Через кнопку «Корзинка» в строке конкретной группы

Ожидается в релизе 1.1.0

Вкладка «Черновики»

На этой вкладке администратор получает доступ к списку проектов выбранного пользователя. На данной вкладке доступны все те же действия с проектом что и на одноименной вкладке в разделе «Менеджер проектов»:

• Открыть проект
• Скопировать в этот же или другой поток
• Переместить в другой поток
• Откатить
• Защитить
• Переименовать
• Инфо
• Удалить

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

 

Ожидается в релизе 1.1.0

Вкладка «Подключения»

На этой странице администратор управляет доступами пользователя к источникам системы. Таблица содержит все доступы текущего пользователя к источникам и права. На этой странице администратору доступны следующие действия:: 

• Просмотреть список подключений к которым данный пользователь имеет доступ и права.
• Добавить новые доступы к подключениям. Через кнопку «Добавить» и выбор одного или нескольких потоков в открывшемся модальном окне.
• Изменить права доступа к имеющимся подключениям. Через кнопку «Карандаш» в строке конкретного подключения
• Удалить доступ данного пользователя к подключениям. Через кнопку «Корзинка» в строке конкретного потока
  
• Если пользователь имеет доступ к подключению в составе группы, то поскольку права и сам доступ определен на уровне этой группы на странице пользователя мы можем только увидеть их наличие. А отредактировать только на странице этой группы

Раздел «Группы»

Вкладка «Пользователи»

Вкладка содержит таблицу пользователей группы. 

Действия доступные на вкладке:

• Поиск пользователя по логину. 
• Добавить пользователя в группу. Кликом по кнопке «Добавить» вызвать модальное окно, в котором выбрать одного или нескольких пользователей
  
  

  
  
  

• Удалить пользвателя из группы. В таблицце пользователей при нведении на строку появится иконка «Корзинка». Клик по ней удалит пользователя из группы.
  
  

  

   

Вкладка «Потоки»

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

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

Добавить поток группе

1. Кликом по кнопке «Добавить» вызвать модальное окно выбора потока
   
2. Выбрать права группы. И выбрать один или несколько потоков
   

   

   
   
3. Подтвердить действие кликом по кнопке «Добавить»

Удалить поток у группы

1. Навести на строку с нужным потоком
2. Кликнуть на иконку «Корзинка»
   

   
   

   
   
3. Подтвердить удаление

Изменить права доступа к потоку

1. Навести на строку с нужным потоком
2. Кликнуть на иконку «Карандаш»
   

   
   

   
   
3. В открывшемся модальном окне выбрать права
4. Подтвердить изменение кликом на «Изменить»

Вкладка «Подключения»

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

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

Добавить доступ на подключение группе

1. Кликом по кнопке «Добавить» вызвать модальное окно выбора потока
   
2. Выбрать права группы.
3. И выбрать одно или несколько поподключений
   

   

   
   
4. Подтвердить действие кликом по кнопке «Добавить»

Удалить у подключению у группы

1. Навести на строку с нужным потоком
2. Кликнуть на иконку «Корзинка»
   

   

   
   
3. Подтвердить удаление

Изменить права доступа к подключению

1. Навести на строку с нужным потоком
2. Кликнуть на иконку «Карандаш»
   

   

   
   
3. В открывшемся модальном окне выбрать права
4. Подтвердить изменение кликом на «Изменить»

Раздел «Потоки»

Вкладка «Доступы»

На этой вкладке администратор управляет списком пользователей и групп пользователей, имеющих доступ к выбранному потоку. Этот список вывведен в таблицу. На данной вкладке доступны все те же действия что и на одноименной вкладке в разделе «Менеджер проектов»:

• Просмотреть или отфильтровать пользователей и группы спомощью поискового запроса
• Отсортировать по возрастанию или убыванию кликом по заголовку колонки «Пользователь/Группа» или «права»
• Добавить доступ к текущему потоку пользователю, пользователям, группе или группам с заданными правами. Кликом по кнопке «Добавить». И выбрав необходимое в появившемся модальном окне
• Изменить права доступа к текущему потоку пользователю или группе. Кликом на кнопке «Карандаш» в строке пользователя или группы
• Удалить доступ пользователя или группы к текущему потоку 

Ожидается в релизе 1.1.0

Вкладка «Проекты»

На этой вкладке администратор получает доступ к списку проектов выбранного потока. На данной вкладке доступны все те же действия с проектом что и на одноименной вкладке в разделе «Менеджер проектов»:

• Открыть проект
• Скопировать в этот же или другой поток
• Переместить в другой поток
• Откатить
• Защитить
• Переименовать
• Инфо
• Удалить

Одно исключение: администратор не имеет возможности скопировать или переместить проект в свои личные черновики, только в другой поток.

Ожидается в релизе 1.1.0

Раздел «Лицензии»

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

Блок информации (1)

Основная задача этого блока показывать сколько дней осталось до истечения срока действия и активация лицензионного ключа. Активировать ключ можно следующим образом:

1. Клик по кнопке «Активировать ключ»
   
2. В открывшемся попапе выбрать файл ключа
   
3. Подтвердить кликом по кнопке «Активировать»

Результат

• Появиться сообщение «Лицензионный ключ успешно активрован»
  
• На странице «Лицензии» в блоке информации (слева) появятся данные активированной лицензии
  
• Если до этого был применен другой ключ, то к пользователям имевшим активный статус лицензии слоты ролей применятся автоматически.
  
• Если количество лицензий или ролей в новом ключе стало меньше чем было в предыдущем, то по недостающему числу лицензий или ролей потеряют доступ пользователи, которые находятся в конце списка, отсортированного по возрастанию количества дней с даты последнего входа.

Фильтр по лицензиям (2)

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

Типы лицензий в Fastboard являются взаимозаменяемыми:

1. Админ./Разраб. выдается пользователям с ролями «Администратор» или «Разработчик» в равной степени. 
2. Зритель/Аналитик. выдается пользователям с ролям пользователям с ролями «Зритель» или «Аналитик» также в равной степени

Например, 10 лицензий зритель/аналитик, все они могут быть выданы 10 пользователям с ролью «Аналитик», либо 1 аналитик и 9 зрителей, 2 аналитика и 8 зрителей и т.д. В отношении лицензий Админ./Разраб. работает та же логика.Но есть единственное требование: чтобы в системе всегда был хотя бы 1 администратор, иначе доступ к административной панели станет невозможным.

Таблица пользователей (3)

В таблице пользователей происходят все основные действия

• Выдать/забрать лицензию пользователя
• Изменить пользователя в лицензии
• Изменить роль пользователя в лицензии
• Отсортировать пользователей
  • По роли
  • По дате последнего посещения
• Отфильтровать по логину

Поиск. Фильтрация. Сортировка

Строка поиска отфильтрует список пользователей с лицензиями по логину. Клик по заголовку столбца отсортирует строки таблицы по выранному столбцу: Логин, роль или дата последнего посещения

Выдать лицензию пользователю

Справа сверху от таблицы нажать кнопку «выдать лицензию»

В появившемся модальном окне выбрать пользователя и подтвердить операцию кликом по кнопке «Выдать»

Результат:

• Появилось подтверждение «Лицензия успешно активирована»
  
• В выбранной ячейке появился логин пользователя, которому была выдана лицензия
  
• На странице пользователя активировался чекбокс «Лицензия выдана»
  
• Пользователь получил доступ в приложение с правами соответствующими своей роли

Действия с пользователями

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

Изменить пользователя лицензии. Например, чтобы передать лицензию другому пользователю. 

1. В таблице лицензий в столбце пользователя кликнуть на иконку «Карандаш» (редактирование)
   
2. В открывшемся модальном окне выбрать другого пользователя из списка
3. Подтвердить кликом по кнопке «Изменить»

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

Вариант 1. Сделать это на странице лицензий

1. В таблице лицензий в столбце «Роли» в строке нужного пользователя кликнуть на иконку «Карандаш» 
   
2. В открывшемся модальном окне выбрать другую пользователя из списка
3. Подтвердить кликом по кнопке «Изменить»

Вариант 2. Сделать это на странице пользователя. (Перекрестный функционал)

1. На странице пользователя изменить роль
   
2. Нажать кнопку «Сохранить»

Лишить пользователя лицензии. На странице лицензий нельзя удалить пользвателя из системы. Только из лицензионного ключа, то есть отобрать лицензию (освободить)

Вариант 1. Сделать это на странице лицензий

1. В таблице лицензий в столбце «пользователи» в строке нужного пользователя кликнуть на иконку «Корзинка» 
   
2. В открывшемся модальном окне подтвердить действие кликом по кнопке «Удалить»

Вариант 2. Сделать это на странице пользователя. (Перекрестный функционал)

1. На странице пользователя деактивировать чекбокс «Лицензия выдана»
   
2. Нажать кнопку «Сохранить»

Раздел «Задания»

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

Со временем эта информация будет расширятся как и функционал самого раздела

Поиск осуществляется по названию проекта

Сортировка по возрастанию/убыванию кликом на заголовок столбца по которому неоходимо ее применить

Создать задание

1. Чтобы создать новое задание откройте модальное окно кликом по кнопке «Создать» в правом верхнем углу страницы.
2. Выберите поток и затем проект для которого неоходимо создать задание
3. Чтобы задание выполнялось необходимо включить флаг «Активно». Этот флаг можно использовать чтобы временно отключить выполенение задания.
4. Опишите расписание запуска строкой в формате CRON
5. Подтвердите кликом на кнопку «Создать»

Активные директории

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

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

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

Страница АД очень похожа на страницу «Задания». Все действия те же, но в отношении подключения а домену.

Поиск осуществляется по названию проекта

Сортировка по возрастанию/убыванию кликом на заголовок столбца по которому неоходимо ее применить

Детали

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

Создать подключение

Чтобы создать новое подключение к АД откройте модальное окно кликом по кнопке «Создать» в правом верхнем углу страницы. Все поля обязательны для заполнения.

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

1. Название для подключения как оно будет отображаться в таблице подключений
2. URL это подключения откуда будут импортированы пользователи.
3. Авторизация. Это учетные данные для поключения к домену
4. Фильтры импорта (для опытных пользователей АД)
   • Домен или домены через запятую 
   • Выражение для фильтрации пользователей
   • Выражение для фильтрации групп
5. Регулярная синхронизация. Активируйте этот флаг, если необходимо переиодически синхронизировать полученый список пользователей с источником. График синхронизации описывается строкой задания в синтаксисе CRON
6. Добавлять новых пользователей. Если оставить флаг неактивным, то количество пользователей при каждой последующей синхронизации изменяться не будет. Произойдет разовый импорт пользователей и далее эти пользователи будут только обновляться. Например, их параметры неактивности или черный список

Подтверждаем кликом по кнопке «Создать». Подключение появляется в таблице и сразу запускается. Поскольку это может быть не быстрая операция для обновления стстуса предусмотрена кнопка «Обновить» (рядом с «Создать»).

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

После успешного завершения импорта на вкладке «Пользователи» появится список всех полученных пользователей и групп поступивших из этого подключения. Также эти пользователи и группы появятся в системе и после выдачи им ролей и доступов смогут полноценно пользваоться системой. 

 

Удаление подключения

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

Справочные материалы

Роли пользователей в системе

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

Возможности каждой роли описаны в этой таблице:

	Администратор	Разработчик	Аналитик	Зритель
Видит все потоки	✅
Видит потоки к которым есть доступ	✅	✅	✅	✅
Создание, изменение, удаление потока (при наличии соответствующих прав доступа)	✅	✅	✅
Создание, изменение, удаление проекта	✅	✅	✅
Редактирование доступных проектов	✅	✅	✅
Создание копии проекта в потоке	✅	✅	✅
Перезапись проекта в потоке	✅	✅	✅
Изменение проекта в потоке	✅	✅	✅
Удаление проекта из потока	✅	✅	✅
Создание источника данных	✅	✅
Редактирование скрипта загрузки	✅	✅
Удаление любого источника данных	✅
Удаление доступного источника данных (при наличии соответствующих прав доступа)	✅	✅
Доступ к панели администратора	✅
Управление лицензиями	✅

О правах доступа

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

• Подключения к источникам
• Потоки

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

1. Управление. Пользователь имеет полный доступ к управлению сущностью. Может изменять название или настройки (например подключения), выдавать и забирать доступы, удалять. Управление содержимым сущности, например, работа с проектами в потоке уже будет зависеть от его роли рамках системы.
2. Использование. Пользователь имеет ограниченый доступ к сущности. Не может ни изменять название или настройки, ни выдавать или забирать доступы, ни удалять. Но может полноценно пользоваться содежимым сущности, например, работать с проектами в потоке, или получать данные из источника. Все что позволяет его роль в рамках системы.

Например. Создавая поток или подключение к источнику пользователь автоматически получает права на управление. И, соответственно, может распоряжаться доступом без ограничений. Выдавая такой же неограниченый доступ другим пользвателям он передает такое же право распоряжаться этой сущностью. Может изменять настройки подключения или удалить его. А пользователи с правами на использования смогут только подключиться к источнку и извлечь данные. Все изменения свойств сущности (настройки, доступы) им не доступны.

Синтаксис заданий для CRON

Синтакис представляет собой последовательность 5 символов разделенных пробелами:

1 2 3 4 5

Где цифры обозначают:

• 1: Минуты (0-59)
• 2: Часы (0-23)
• 3: День (0-31)
• 4: Месяц (0-12 [12 == Декабрь])
• 5: День недели (0-7 [7 или 0 == sunday])

Примеры задания в крон:

# выполнение задания каждые 5 минут #
*/5 * * * *

# выполнение задания каждый день в час ночи #
0 1 * * *

# выполнение задания каждый месяц первого числа в три часа ночи пятнадцать минут #
15 3 1 * *

Как использовать операторы

Оператор позволяет указать несколько значений в поле. Существуют четыре оператора:

1. Звездочка (*): этот оператор задает все возможные значения для поля. Например, звездочка в поле «Часы» будет эквивалентна каждому часу, а звездочка в поле месяца будет эквивалентна каждому месяцу и т.д.
2. Запятая (,): Этот оператор задает список значений, например: «1,5,10,15,20,25».
3. Тире (-): Этот оператор задает диапазон значений, например: «5-15» дней, что эквивалентно набору «5,6,7,8,9 … …, 13,14,15», при использования оператора «Запятая».
4. Слеш (/): этот оператор задает значение шага, например: «0-23 /» можно использовать в поле часов, чтобы указывать выполнение команды каждый час. Шаги также разрешены после звездочки, поэтому, если Вы хотите выполнять что-то каждые два часа, просто используйте «*/2».

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

Рефреш токены аутентификации

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