Платформа 3V/Инструкция по работе с платформой: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
Строка 2: Строка 2:
 
Здесь вы найдете описание основных блоков по работе с платформой 3V, ссылки на инструкции и регламенты, а также информационные ресурсы по работе с платформой
 
Здесь вы найдете описание основных блоков по работе с платформой 3V, ссылки на инструкции и регламенты, а также информационные ресурсы по работе с платформой
  
== Как начать использовать платформу 3V? ==
+
= Как начать использовать платформу 3V? =
 
Существует два способа начать работать с платформой:
 
Существует два способа начать работать с платформой:
  
=== 1. Развернуть собственный стенд ===
+
=== Развернуть новый стенд ===
 
В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/demo-3v в папке '''«Manuals»''' вы найдете:
 
В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/demo-3v в папке '''«Manuals»''' вы найдете:
 
#Файл '''«Manual.txt»''' - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
 
#Файл '''«Manual.txt»''' - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
Строка 13: Строка 13:
 
При возникновении проблем обращайтесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
 
При возникновении проблем обращайтесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
  
=== 2. Создать собственное облачное приложение ===
+
Для смены версий на стенде необходимо:
 +
# При необходимости, проверить, что в вашем репозитории есть все актуальные конфигурационные файлы
 +
# Скачать недостающие конфиги и поправить в конфигурационных файлах информацию о текущем стенде или скачать полностью новый репозиторий и в нем поправить по всем конфигурационным файлам информацию о стенде
 +
# Изменить версии в конфигурационном файле «.env» и выполнить команду для запуска (docker-compose up).
 +
 
 +
'''Важно!''' Версия бэка (BACK) или вэба (NAVI) должна совпадать в первых двух значениях (например, 0.35), но может не совпадать в номере "патча" (например, версия бэка (BACK) = 0.35.1 или вэба (NAVI)= 0.35.4)
 +
 
 +
'''Важно!''' При переходе на новую версию необходимо обязательно проверить наличие '''Критических изменений''' (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!
 +
 
 +
Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/demo-3v в папке «Release», а также в описании соответствующих релизов [[Описание_релизов|на их страницах]]
 +
 
 +
=== Создать собственное облачное приложение ===
 
При необходимости создания нового приложения ("тенанта") в облаке обратитесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
 
При необходимости создания нового приложения ("тенанта") в облаке обратитесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
 
В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com"  
 
В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com"  
  
 +
Облачные приложения всегда поддерживаются в актуальном состоянии и на них вы найдете самый новый функционал
  
== Обновление версии ==
+
= Какой новый функционал появляется и наши планы развития? =
При условии развернутой в docker-compose платформы для обновления на новую версию платформы необходимо:
 
# При необходимости, проверить, что в вашем репозитории есть все актуальные конфигурационные файлы
 
# Скачать недостающие конфиги и поправить в конфигурационных файлах информацию о текущем стенде или скачать полностью новый репозиторий и в нем поправить по всем конфигурационным файлам информацию о стенде
 
# Изменить версии в конфигурационном файле «.env» и выполнить команду для запуска (docker-compose up).
 
  
Для того, чтобы узнать ''текущую версию платформы'' (способ 1: [[Платформа_3V/Версия_платформы |описан в статье "Версия_платформы"]], способ 2: посмотреть имя/тег любого используемого докер-образа)
+
Для того, чтобы узнать ''актуальную версию'' для вашего стенда с интересующим вас функционалом, вы можете:
  
Для того, чтобы узнать ''актуальную версию'', на которую требуется перейти:
+
#Просмотреть, какой функционал появляется в новых версиях между вашей текущей и актуальной в описании соответствующих релизов [[Описание_релизов|на их страницах]]
#Проанализировать исправленные ошибки и выполненные требования в рамках, которые были направлены от заинтересованных лиц в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку''']. Версия, в которой внесено исправление, будет указана в комментарии от администратора службы поддержки с примечанием является ли версия бэком (BACK) или вэбом (NAVI)
+
#Проанализировать исправленные ошибки и выполненные требования, которые были направлены от заинтересованных лиц в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку''']. Версия, в которой внесено исправление, будет указана в комментарии от администратора службы поддержки с примечанием является ли версия бэком (BACK) или вэбом (NAVI)
 
#Зайти в https://gitlab.3v-group.org/open/demo-3v в папке '''«Release»''' и посмотреть последнюю выпущенную версию ядра (BACK) и навигатора (NAVI)
 
#Зайти в https://gitlab.3v-group.org/open/demo-3v в папке '''«Release»''' и посмотреть последнюю выпущенную версию ядра (BACK) и навигатора (NAVI)
#Просмотреть, какой интересующий вас функционал появился в версиях между вашей текущей и актуальной в описании соответствующих релизов [[Описание_релизов|на их страницах]]
 
  
'''Важно!''' При переходе на новую версию необходимо обязательно проверить наличие '''Критических изменений''' (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!
+
Для того, чтобы узнать ''текущую версию'' вашего стенда есть два способа:
 +
#Посмотреть по ссылке. Способ описан в [Платформа_3V/Версия_платформы |статье "Версия_платформы"]],
 +
#Посмотреть имя/тег любого используемого докер-образа
 +
 
 +
= Возможности коммуникации с платформой 3V =
 +
 
 +
===Заявка на демонстрацию===
 +
 
 +
Запросите демонстрацию написав нам письмо на электронную почту: info@trivium.group или обратившись по телефону: +7(495) 369-55-10
 +
 
 +
===Техническая поддержка===
 +
Служба для обращений за оказанием помощи по решению возникшей проблемы, а также за получением дополнительной информации по интересующему вопросу.
 +
 
 +
====Доступ====
 +
Ссылка: https://trivium-group.atlassian.net/servicedesk/customer/portals
 +
 
 +
Авторизация: [[Платформа 3V/Инструкция по работе с платформой/Информационные ресурсы/Инструкция по работе с сервисом технической поддержки|Инструкция по работе с сервисом технической поддержки]]
 +
====Правила пользования====
 +
[[Платформа 3V/Инструкция по работе с платформой/Информационные ресурсы/Стандарт технической поддержки проектов на платформе 3V|Стандарт пользования технической поддержки 3V]]
 +
 
 +
===Askbot===
 +
Система ориентированная на формат вопрос-ответ, созданная решать локальные вопросы, возникающие при использовании платформы Тривиум.
 +
 
 +
====Доступ====
 +
Ссылка: https://ask.3v-group.net
 +
 
 +
Авторизация: Jira BS
 +
 
 +
====Правила пользования====
 +
Перед тем как задать вопрос, поищите уже аналогичный существующий вопрос в системе.
 +
 
 +
Если аналогичный вопрос не был найден, воспользуйтесь следующими рекомендациями:
 +
 
 +
# Кратко опишите проблему в заголовке вопроса, например - "Как через json задать настройки фильтрации по данным показателя в отчете";
 +
# Опишите ваш пример и проблему, сопровождая скриншотами, таблицами и прочими материалами, необходимыми для полного понимания вопроса. Избегайте указания ссылок на стенды;
 +
# Если были попытки решить проблему самостоятельно, укажите способы и возникшие ограничения;
 +
# Установите один или несколько тегов, которые характеризуют вашу проблему. Список рекомендуемых тегов по платформе 3v: Отчеты, Справочники, Показатели, Согласование, Методики, Импорт, Экспорт, Формы, Права, Навигатор, Шапка, Боковик, Формулы
 +
Примечание! Если на ваш вопрос был дан правильный ответ и он Вам помог, не забудьте отметить данный ответ «Галочкой» и закрыть вопрос
  
Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/demo-3v в папке «Release», а также в описании соответствующих релизов [[Описание_релизов|на их страницах]]
+
== Информационные ресурсы (техническая поддержка) ==
  
== Обучение работе с платформой 3V ==
 
 
На ресурсе Wiki вы найдете:  
 
На ресурсе Wiki вы найдете:  
 
#[[Платформа_3V/Вводный_порядок_обучения_по_работе_с_платформой|вводный порядок обучения по работе с платформой]] с ссылками на видеоролики с настройкой простых информационных объектов
 
#[[Платформа_3V/Вводный_порядок_обучения_по_работе_с_платформой|вводный порядок обучения по работе с платформой]] с ссылками на видеоролики с настройкой простых информационных объектов
Строка 44: Строка 87:
 
Ответы на основные вопросы по работе с Wiki вы найдете на [[Добро_пожаловать_в_Wiki_3V!  |'''Welcome странице''']]
 
Ответы на основные вопросы по работе с Wiki вы найдете на [[Добро_пожаловать_в_Wiki_3V!  |'''Welcome странице''']]
  
== Информационные ресурсы (техническая поддержка) ==
+
 
 
В статье [[Платформа 3V/Инструкция по работе с платформой/Информационные ресурсы|'''"Информационные ресурсы"''']] вы найдете всю подробную информацию о технической поддержке пользователей и порядке работы с ней, технической документации и прочих ресурсах, в которые возможно обратиться при возникновении тех или иных вопросов по работе с платформой 3V
 
В статье [[Платформа 3V/Инструкция по работе с платформой/Информационные ресурсы|'''"Информационные ресурсы"''']] вы найдете всю подробную информацию о технической поддержке пользователей и порядке работы с ней, технической документации и прочих ресурсах, в которые возможно обратиться при возникновении тех или иных вопросов по работе с платформой 3V

Версия 11:21, 12 августа 2021

Здесь вы найдете описание основных блоков по работе с платформой 3V, ссылки на инструкции и регламенты, а также информационные ресурсы по работе с платформой

Как начать использовать платформу 3V?

Существует два способа начать работать с платформой:

Развернуть новый стенд

В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/demo-3v в папке «Manuals» вы найдете:

  1. Файл «Manual.txt» - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
  2. Файл «Keycloak manual.pdf» - инструкция по разворачиванию и настройке системы авторизации Keycloak. При разворачивании образов с помощью Kubernetes и прочих средств запуска, см. страницу https://www.keycloak.org/getting-started.
  3. Прочие скрипты для подготовки сервера БД, требуемые по инструкции (папка «sql_scripts»)

Также в статье на Wiki вы найдете основные принципы работы с аутентификацией и авторизацией на платформе 3V. При возникновении проблем обращайтесь в техническую поддержку с типом обращения "Консультация".

Для смены версий на стенде необходимо:

  1. При необходимости, проверить, что в вашем репозитории есть все актуальные конфигурационные файлы
  2. Скачать недостающие конфиги и поправить в конфигурационных файлах информацию о текущем стенде или скачать полностью новый репозиторий и в нем поправить по всем конфигурационным файлам информацию о стенде
  3. Изменить версии в конфигурационном файле «.env» и выполнить команду для запуска (docker-compose up).

Важно! Версия бэка (BACK) или вэба (NAVI) должна совпадать в первых двух значениях (например, 0.35), но может не совпадать в номере "патча" (например, версия бэка (BACK) = 0.35.1 или вэба (NAVI)= 0.35.4)

Важно! При переходе на новую версию необходимо обязательно проверить наличие Критических изменений (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!

Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/demo-3v в папке «Release», а также в описании соответствующих релизов на их страницах

Создать собственное облачное приложение

При необходимости создания нового приложения ("тенанта") в облаке обратитесь в техническую поддержку с типом обращения "Консультация". В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com"

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

Какой новый функционал появляется и наши планы развития?

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

  1. Просмотреть, какой функционал появляется в новых версиях между вашей текущей и актуальной в описании соответствующих релизов на их страницах
  2. Проанализировать исправленные ошибки и выполненные требования, которые были направлены от заинтересованных лиц в техническую поддержку. Версия, в которой внесено исправление, будет указана в комментарии от администратора службы поддержки с примечанием является ли версия бэком (BACK) или вэбом (NAVI)
  3. Зайти в https://gitlab.3v-group.org/open/demo-3v в папке «Release» и посмотреть последнюю выпущенную версию ядра (BACK) и навигатора (NAVI)

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

  1. Посмотреть по ссылке. Способ описан в [Платформа_3V/Версия_платформы |статье "Версия_платформы"]],
  2. Посмотреть имя/тег любого используемого докер-образа

Возможности коммуникации с платформой 3V

Заявка на демонстрацию

Запросите демонстрацию написав нам письмо на электронную почту: info@trivium.group или обратившись по телефону: +7(495) 369-55-10

Техническая поддержка

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

Доступ

Ссылка: https://trivium-group.atlassian.net/servicedesk/customer/portals

Авторизация: Инструкция по работе с сервисом технической поддержки

Правила пользования

Стандарт пользования технической поддержки 3V

Askbot

Система ориентированная на формат вопрос-ответ, созданная решать локальные вопросы, возникающие при использовании платформы Тривиум.

Доступ

Ссылка: https://ask.3v-group.net

Авторизация: Jira BS

Правила пользования

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

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

  1. Кратко опишите проблему в заголовке вопроса, например - "Как через json задать настройки фильтрации по данным показателя в отчете";
  2. Опишите ваш пример и проблему, сопровождая скриншотами, таблицами и прочими материалами, необходимыми для полного понимания вопроса. Избегайте указания ссылок на стенды;
  3. Если были попытки решить проблему самостоятельно, укажите способы и возникшие ограничения;
  4. Установите один или несколько тегов, которые характеризуют вашу проблему. Список рекомендуемых тегов по платформе 3v: Отчеты, Справочники, Показатели, Согласование, Методики, Импорт, Экспорт, Формы, Права, Навигатор, Шапка, Боковик, Формулы

Примечание! Если на ваш вопрос был дан правильный ответ и он Вам помог, не забудьте отметить данный ответ «Галочкой» и закрыть вопрос

Информационные ресурсы (техническая поддержка)

На ресурсе Wiki вы найдете:

  1. вводный порядок обучения по работе с платформой с ссылками на видеоролики с настройкой простых информационных объектов
  2. статьи с описанием настройки различного функционала информационных объектов (см. внизу Главной страницы)
  3. различные рекомендации по использованию и оптимизации информационных объектов
  4. описание кейсов использования

Ответы на основные вопросы по работе с Wiki вы найдете на Welcome странице


В статье "Информационные ресурсы" вы найдете всю подробную информацию о технической поддержке пользователей и порядке работы с ней, технической документации и прочих ресурсах, в которые возможно обратиться при возникновении тех или иных вопросов по работе с платформой 3V