Документация / Организация

Администратору

Кабинет администратора - пункт «Администрирование» в панели слева (адрес /admin). Виден только пользователям с ролью администратора. Из кабинета обратно - «К чатам».

Разделы кабинета - в верхнем меню, пункты выбранного раздела - в панели слева. Страницу можно открыть по прямой ссылке или перезагрузить: кабинет сам найдёт её раздел, подсветит его сверху и покажет пункты слева.

Пользователи

Список пользователей, роли, блокировка. Гостей и приглашённых видно здесь же.

Сущности

Меню «Сущности» - универсальные списки записей, которые плагины хранят в базе. Доступно по праву entityAdmin. Пункты в двух блоках: «Справочники плагинов» (формулировки, шаблоны, договоры, плагины) и «Право и договоры» (нормы, ставка ЦБ, календарь, периоды без начисления, правила проверки, протоколы разногласий, свои шаблоны, папки дела).

ПунктЧто там
Формулировкився библиотека: поставка, свои и общие всех пользователей; чистка дублей, правка поставки, добавление
Шаблоны договоровкаталог видов конструктора: название, категория, статус «собираем / скоро»
Договорысобранные пользователями договоры и черновики
Плагины документовреестр сценариев: класс, типы документов, ключевые слова, кнопка под документом
Нормы: кодексы и законытексты ГК, АПК, ГПК, НК, ТК, КоАП, законов о защите прав потребителей и о банкротстве с официального портала pravo.gov.ru: дата редакции, когда загружено, сколько статей, состояние. Сервер загружает их сам после старта и обновляет раз в 30 дней; «состояние» с текстом ошибки - нет выхода в интернет (на таком стенде загрузку выключает docscan.law.load=false, ссылки остаются непроверенными)
Нормы: статьистатьи загруженных актов; прежний текст изменившейся статьи хранится с датой замены
Ключевая ставка ЦБставка для процентов по ст. 395 ГК и неустойки в долях ставки (претензия): история до 20.10.2026 встроена, новые изменения раз в сутки загружаются с cbr.ru (источник «cbr.ru»), при недоступном сайте - вносятся вручную
Производственный календарь: поправкидни, которые отличаются от встроенного календаря 2013-2027 (перенос выходных, новый праздник): сроки в рабочих и банковских днях и перенос с выходного в расчёте претензии
Периоды без начисления неустойкипериоды, когда неустойка и проценты не начисляются; мораторий 01.04.2022-01.10.2022 уже встроен
Правила проверки договоровправила компании для проверки на риски: текст, как проверять, сторона, важность, автор и организация
Протоколы разногласийсохранённые протоколы для «В прошлый раз»: ИНН контрагента, договор, сторона, строки
Свои шаблоны договоровшаблоны, которые пользователи сделали из своих договоров: название, автор, общий ли для организации
Папки делапапки пользователей: название, вид, автор, участники, общая ли для организации

Запись открывается формой. Как искать и сортировать - в разделе «Списки». Удаление необратимо: перед чисткой формулировок проверьте, что запись не «своя» у кого-то из пользователей (колонки «Автор» и «Организация»).

Списки

«Сущности», «Сообщения об ошибках», «Падения» и «Промпты» открываются одинаковой таблицей.

  • Поиск. Под заголовком каждой колонки - свой фильтр. В текстовой колонке наберите часть слова: останутся строки, где она встречается. Регистр букв не важен: «сборка» найдёт и «Сборка договора». В колонке со статусом или другим значением из набора - выберите значение из списка. В колонке «№» - номер записи целиком. Фильтры складываются: статус «Новая» и слово «баланс» в описании дадут новые ошибки про баланс. Дата пока не фильтруется - сортируйте по ней.
  • Сортировка. Нажмите на заголовок колонки, второе нажатие меняет направление - стрелка у заголовка показывает его. Сначала показаны новые записи.
  • Запись. Нажмите на строку - откроется карточка. Номер в первой колонке - ссылка: её можно открыть в новой вкладке. Длинный текст в таблице обрезан до трёх строк, целиком он в подсказке при наведении и в карточке.
  • Страницы. Внизу - сколько записей показано и сколько всего, переход по страницам и число строк на странице. Над таблицей - «Всего» с учётом фильтров и кнопка «Сбросить фильтры».
  • «Добавить» над таблицей есть у списков, куда записи заводят вручную (формулировки, шаблоны, плагины). Крестик в конце строки удаляет запись - после подтверждения.

Список помнит фильтры, сортировку и страницу, пока открыта вкладка: из карточки вы вернётесь туда же.

Карточка записи

  • Шапка. Сверху ссылка назад в список, название и номер записи, рядом статус цветной меткой. Справа кнопка «Изменить» - она есть у записей, которые можно править.
  • Сводка. Короткие поля собраны сеткой в несколько колонок: дата со временем, «да» и «нет» словами, значение из набора - подписью. Пустое поле показано прочерком. Значение-ссылка (например, пользователь) ведёт на связанный экран - в его активность.
  • Длинные поля идут ниже во всю ширину: описание, сообщение, история. Стектрейс и данные в JSON показаны кодом: строки не переносятся, блок прокручивается, у стектрейса выделены само исключение и его причины. Высокий блок свёрнут - «Развернуть» показывает его целиком, «Скопировать» кладёт текст в буфер.

Форма записи

Новая запись открывается кнопкой «Добавить» над списком, правка - кнопкой «Изменить» в карточке.

  • Поля. Короткие поля стоят в несколько колонок, длинные тексты - во всю ширину и растут вместе с текстом. Под полем написано, что в него вводить. Обязательные поля отмечены звёздочкой.
  • Чем вводить. Значение из набора выбирается из списка, «да/нет» ставится галочкой. Поле с данными в JSON проверяется перед сохранением: с ошибкой в скобках или кавычках запись не сохранится.
  • Служебные поля - время создания и автора - форма заполняет сама, вводить их не нужно.
  • Ошибки. Незаполненное или неверное поле подсвечено, под ним написано, что исправить; форма сама прокручивается к первой ошибке. Отказ сервера показан строкой рядом с кнопками.
  • Кнопки «Сохранить» и «Отмена» закреплены внизу экрана. После сохранения правки вы вернётесь в карточку записи - изменения видны сразу; новая запись после сохранения появится в списке. По «Отмене» - туда, откуда пришли: из правки в карточку, из новой записи в список.

Удаление записи - крестик в конце строки списка. Окно подтверждения называет запись, которую вы удаляете; восстановить её нельзя.

Биллинг

Меню «Биллинг» - кредиты пользователей. Кому виден: администратору (право billingAdmin). Что видит пользователь - в разделе «Кредиты и баланс».

Режим задаёт настройка сервера BILLING_MODE и меняется перезапуском:

РежимЧто происходит
off - выключендействия не считаются, кредитов в интерфейсе нет
observe - наблюдениецена каждого действия пишется в журнал, баланс не меняется, пользователи кредитов не видят
enforce - включёнкредиты списываются за результат, без кредитов действие не выполняется

Порядок включения: сначала наблюдение, по отчёту поправить прейскурант и размер начисления при регистрации (BILLING_WELCOME_CREDITS, срок - BILLING_WELCOME_DAYS), затем включить списание.

Кредиты, которые пользователь получает сам, когда они кончились, тоже задаются настройками сервера: по запросу с целью и компанией - BILLING_REQUEST_CREDITS (сколько раз - BILLING_REQUEST_LIMIT, сколько слов в цели - BILLING_REQUEST_WORDS), за приглашённого - BILLING_INVITE_CREDITS (за скольких - BILLING_INVITE_LIMIT).

«Кредиты пользователей» - главный экран раздела.

  • Режим - что сейчас включено на сервере.
  • «Пользователи» - все учётные записи с балансом; сверху те, чей баланс менялся последним. Поиск - по логину. У того, кто ещё не входил после включения биллинга, баланс 0.
  • «Расход за период» - за 7, 30 или 90 дней: действие, сценарий, сколько раз и сколько кредитов. В режиме наблюдения таблица называется «Посчитано наблюдением»: это то, что было бы списано.

Как пополнить баланс. В строке пользователя нажмите «Начислить». В окне укажите, сколько кредитов, срок действия и причину, затем нажмите «Начислить». Причина обязательна: она пишется в журнал вместе с тем, кто выполнил операцию. Чтобы забрать кредиты, в том же окне выберите «Забрать».

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

Остальные пункты - списки:

  • «Операции» - журнал всех кошельков, только просмотр. В колонке «Логин» - чья операция, по ней есть фильтр. У начислений в колонке «Действие» написано, за что они: «Стартовые кредиты», «Выдал администратор», «Запрос кредитов» (в «Сценарий» - компания, в «Причина» - цель запроса), «За приглашённого» (в «Сценарий» - его почта). Чтобы увидеть, кто и зачем запрашивал кредиты, выберите в фильтре «Действие» значение «Запрос кредитов».
  • «Кошельки» - балансы с логином владельца, только просмотр. Баланс меняется только начислением и списанием.
  • «Прейскурант» - цены действий, правятся здесь: действие, сценарий, название и число кредитов. Цена без галочки «Действует» не применяется - действие становится бесплатным. Новая цена начинает работать в течение минуты.

Сайт

Меню «Сайт» → «Открытые страницы» - ссылки на то, что видно без входа. Кому видно: администратору. Оба пункта открываются в новой вкладке - это страницы сервера, а не экраны кабинета.

  • «Контент сайта (CMS)» - админка открытых страниц: тексты страниц профилей (/buhgalteru, /yuristu и другие), меню шапки и подвала, счётчики посещаемости. Вход отдельный: логин и пароль администратора CMS на странице «Вход · CMS». Пускает только участника группы администраторов Flux. Пароль меняется там же, в разделе смены пароля. Правка текста или счётчика видна на сайте сразу, без перезапуска.
  • «Документация» - эта инструкция на сайте (/docs), такая, какой её видят без входа.

Частые вопросы

Что видитеЧто делать
Пункта «Администрирование» нету вашей учётной записи нет роли администратора
«Контент сайта (CMS)» открывает «Что-то пошло не так» с кодом 403вход в CMS не выполнен или у учётной записи нет роли администратора - войдите на странице «Вход · CMS»
«Сущности» не открываютсянет права entityAdmin - его выдаёт администратор системы
Пользователь жалуется, что своя формулировка пропалапроверьте «Формулировки» в «Сущностях»: запись могли удалить при чистке дублей