Документация решения Спутник.Фермер

Сведения о версиях, порядок установки, руководство пользователя, обновление и восстановление.

ВЕРСИЯ РЕШЕНИЯ 1.0.0 · ПЛАТФОРМА Р13.ОРБИТА 1.3.0 И НОВЕЕ · АО «РИВЦ»

1. Версии

1.1. Порядок нумерации. Номер версии состоит из трёх чисел: основная версия (существенные изменения, возможно требующие работ при переходе), дополнительная версия (новые возможности с сохранением совместимости), исправление (устранение неисправностей). Решение имеет собственный номер версии и обновляется отдельно от платформы Р13.Орбита.

1.2. Текущая версия.

Версия решения
1.0.0
Требуемая версия платформы
Р13.Орбита 1.3.0 и новее
Правообладатель
АО «РИВЦ», г. Казань, ул. Федосеевская, дом 36, офис 323

1.3. Состав версии 1.0.0.

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

1.4. Сроки поддержки версий. Поддерживается текущая версия и предыдущая дополнительная. Сроки окончания поддержки конкретных версий сообщаются заказчикам при выпуске новой версии. При несовпадении версии решения с установленной версией платформы приложение управления выводит предупреждение. Работа решения на версии платформы ниже требуемой не поддерживается.

2. Установка

2.1. Условия установки. Решение устанавливается поверх развёрнутой и работающей платформы Р13.Орбита. Собственного оборудования и отдельных серверов оно не требует: работает на мощностях, выделенных платформе. Требования к оборудованию и программному окружению определяются платформой и приведены в её документации, установка решения их не изменяет.

Платформа
Р13.Орбита 1.3.0 и новее, в рабочем состоянии
Аналитическое хранилище
Заполнено данными организации по разделу 2.2
Пакет решения
Распакован на машине администратора рядом с приложением управления
Права
Учётная запись администратора системы

2.2. Требования к исходным данным.

Отчётность по животноводству: поголовье, надои, воспроизводство
Обязательно для животноводческих задач
Отчётность по растениеводству: посев, полевые работы, уборка
Обязательно для растениеводческих задач
Складской учёт: зерно, корма, семена, удобрения
Обязательно для задач по запасам
Учёт техники
Обязательно для задач по парку техники
Финансовые и экономические показатели
Обязательно для задач по экономике
Реестр грантов и субсидий
Желательно
Справочник хозяйств и подразделений
Обязательно

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

2.3. Порядок установки.

01Убедитесь, что платформа развёрнута и отвечает на проверку состояния.
02Проверьте соответствие данных организации отраслевой модели решения, при необходимости выполните сопоставление полей. Работа выполняется в рамках проекта внедрения.
03Задайте настройки решения на это окружение в приложении управления, в разделе настроек Спутников. Секретные значения хранятся в защищённом виде и в открытом виде не отображаются. Незаданные настройки принимают значения по умолчанию из пакета решения.
04Укажите устанавливаемый набор решений и выполните установку.
export ORBITA_SATELLITES="farmer@1.0.0"
./bin/orbita-ctl --env production --action install-satellites

Приложение подключает описания данных и отчёты решения, применяет настройки, при необходимости настраивает единый вход и перезапускает сервер платформы. Базовая установка при этом не переразворачивается.

05Настройте политики доступа под роли пользователей организации.
06Проверьте результат на известных цифрах и проведите обучение пользователей.

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

2.4. Проверка результата установки.

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

2.5. Удаление. Решение удаляется отдельно от платформы. Снимаются его описания данных и отчёты, платформа продолжает работать.

export ORBITA_SATELLITE_TARGET=farmer
./bin/orbita-ctl --env production --action remove-satellite

Удаление не затрагивает загруженные данные: витрины и данные в аналитическом хранилище остаются на месте. Созданное вручную в веб-интерфейсе администратора также не затрагивается. Если на сервере оставались другие решения, укажите их в списке желаемого набора, а удаляемое отдельным параметром.

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

3.1. Что нужно до начала.

Платформа развёрнута, решение установлено администратором, и вы знаете адрес системы
У вас есть учётная запись. Если в организации настроен единый вход, используется учётная запись отраслевой информационной системы
На рабочем месте установлен плагин Орбиты для табличного редактора

3.2. Вход и первый вопрос.

01Откройте табличный редактор и в меню плагинов выберите панель Орбиты. Панель откроется сбоку от листа.
02Нажмите «Войти» и укажите свои учётные данные. После входа панель запомнит вас, вводить пароль каждый день не требуется.
03Введите вопрос в поле внизу панели и подтвердите ввод.

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

3.3. О чём можно спрашивать.

Животноводство
Поголовье и его движение, валовые надои, продуктивность, воспроизводство стада, приплод, реализация молока и цены по каналам сбыта, качественные показатели. Отдельно мясное направление, свиноводство, птицеводство, пчеловодство и аквакультура
Растениеводство
Посевные площади и структура культур, ход полевых работ и ухода за посевами, уборка по дням и культурам, урожайность, влажность зерна, задействованная техника
Хранение и запасы
Остатки зерна на хранении, движение по складам, запасы кормов и обеспеченность ими, семена и удобрения
Техника
Состав парка сельхозтехники, возраст и состояние, загрузка в период работ, потребность в обновлении, уровень механизации
Экономика хозяйства
Финансово-экономические показатели, объёмы продаж, цены реализации, энергопотребление, гранты и субсидии и сроки исполнения обязательств
Сводные показатели
Сравнение подразделений, хозяйств и районов между собой, рейтинги по продуктивности, динамика к прошлому периоду и к прошлому году

3.4. Примеры вопросов.

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

3.5. Что вы получаете в ответ.

Короткое число или текстовый вывод
Итог по данным
Таблица
Результат расчёта, его можно перенести на лист
График
Диаграмма по результату, если вы её попросили
Уточняющий вопрос с вариантами
Формулировка допускает разные толкования. Ответьте следующим сообщением, выбрав вариант
Сообщение об ошибке
Что именно не получилось и что попробовать

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

3.6. Как формулировать вопрос.

Называйте показатель и период: за какие даты, месяц, квартал или год нужны данные
Указывайте разрез, если он нужен: по хозяйствам, по районам, по культурам, по каналам сбыта
Для сравнения прямо просите сравнить с прошлым периодом или прошлым годом
Если ответ оказался не тем, уточните формулировку следующим сообщением, а не начинайте беседу заново

3.7. Сохранённые результаты, графики и отчёты. Полученный результат сохраняется как набор данных: к нему можно вернуться, построить по нему график или использовать его в следующем вопросе. Для регулярных форм используются преднастроенные отраслевые отчёты. Отчёт запускается с указанием периода и хозяйства и всегда считает по одной и той же методике, независимо от формулировки вопроса.

3.8. Проверка полученного значения. Любое значение раскрывается до исходных данных: показываются источник, формула расчёта и условия отбора строк. Проверка выполняется самим пользователем, обращение к администратору для этого не требуется.

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

3.10. Ограничения.

Ответ строится только по данным, загруженным в аналитическое хранилище. Сведения, которых там нет, решение не восполняет
Актуальность ответа определяется периодичностью загрузки данных: суточной, недельной или месячной
Отсутствие данных за дату означает, что хозяйство не подавало сведения, а не нулевое производство. Такие значения помечаются как неполные
Моментальные показатели вроде поголовья или остатков на хранении не суммируются по датам: они берутся на дату или усредняются за период

4. Обновление и восстановление

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

4.1. Перед обновлением.

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

4.2. Порядок обновления.

01Сделайте резервную копию и убедитесь, что она читается.
02Предупредите пользователей о недоступности системы.
03Укажите новую версию решения в наборе и повторите установку.
export ORBITA_SATELLITES="farmer@1.1.0"
./bin/orbita-ctl --env production --action install-satellites
04Проверьте состояние системы.
./bin/orbita-ctl --env production --action health

Если новая версия решения требует более новой версии платформы, платформа обновляется первой, порядок её обновления приведён в её документации.

4.3. Проверка после обновления.

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

4.4. Если обновление прошло неудачно.

01Зафиксируйте признаки неисправности и сохраните журналы: они понадобятся технической поддержке.
02Верните в наборе прежнюю версию решения и повторите установку.
03Если структура базы метаданных уже изменилась, восстановите базу из копии, сделанной перед обновлением.
04Проверьте работу системы по списку из раздела 4.3.
05Обратитесь в техническую поддержку, приложив журналы и описание выполненных шагов.

4.5. Резервное копирование. Выполняется средствами платформы и охватывает решение целиком.

ЧТО КОПИРУЕТСЯ
ПОЧЕМУ ВАЖНО
ПЕРИОДИЧНОСТЬ
База метаданных
Беседы, наборы данных, политики доступа, журнал действий
Ежедневно
Описания данных и шаблоны отчётов
Результат работ по внедрению, восстанавливается долго
При изменении
Конфигурация и настройки решения
Без них система не поднимется в прежнем виде
При изменении
База сервиса аутентификации
Учётные записи и настройки входа
Ежедневно
Аналитическое хранилище
Данные организации
По регламенту владельца данных

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

4.6. Восстановление. Порядок восстановления после потери сервера.

01Развернуть платформу заново по инструкции её установки, не выполняя настройку.
02Восстановить файл конфигурации и переменные окружения из копии.
03Восстановить базу метаданных.
04Восстановить базу сервиса аутентификации.
05Вернуть на место отраслевые описания данных и шаблоны отчётов.
06Установить решение той же версии, что была на момент снятия копии.
07Запустить систему и выполнить проверку состояния.
08Проверить вход пользователя, выполнение запроса и открытие сохранённого набора данных.

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

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

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