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

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
 
(не показано 16 промежуточных версий 2 участников)
Строка 6: Строка 6:
  
 
=== Развернуть новый стенд ===
 
=== Развернуть новый стенд ===
−
В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/demo-3v в папке '''«Manuals»''' вы найдете:
+
В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/3v-platform в папке '''«Manuals»''' вы найдете:
 
#Файл '''«Manual.txt»''' - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
 
#Файл '''«Manual.txt»''' - инструкцию по разворачиванию платформы 3V с использованием существующего postgres-сервера БД и postgres-сервера БД в докер-образе
 
#Файл '''«Keycloak manual.pdf»''' - инструкция по разворачиванию и настройке системы авторизации Keycloak. При разворачивании образов с помощью Kubernetes и прочих средств запуска, см. страницу https://www.keycloak.org/getting-started.
 
#Файл '''«Keycloak manual.pdf»''' - инструкция по разворачиванию и настройке системы авторизации Keycloak. При разворачивании образов с помощью Kubernetes и прочих средств запуска, см. страницу https://www.keycloak.org/getting-started.
Строка 22: Строка 22:
 
'''Важно!''' При переходе на новую версию необходимо обязательно проверить наличие '''Критических изменений''' (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!
 
'''Важно!''' При переходе на новую версию необходимо обязательно проверить наличие '''Критических изменений''' (Breaking changes) во всех версиях между вашей текущей и той, на которую требуется перейти и, соответственно, при необходимости провести работы на стенде, которые требуются в рамках этих критических изменений!
  
−
Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/demo-3v в папке «Release», а также в описании соответствующих релизов [[Описание_релизов|на их страницах]]
+
Перечень критических изменений вы найдете в https://gitlab.3v-group.org/open/3v-platform в папке «Release notes», а также в описании соответствующих релизов [[Описание_релизов|на их страницах]]
  
 
=== Создать собственное облачное приложение ===
 
=== Создать собственное облачное приложение ===
 
При необходимости создания нового приложения ("тенанта") в облаке обратитесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
 
При необходимости создания нового приложения ("тенанта") в облаке обратитесь в [https://trivium-group.atlassian.net/servicedesk '''техническую поддержку'''] с типом обращения "Консультация".
−
В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com"  
+
 
 +
В обращении укажите краткое название латиницей, которое будет подставлено в url "***.3v-cloud.com" и причину создания нового облачного приложения
  
 
Облачные приложения всегда поддерживаются в актуальном состоянии и на них вы найдете самый новый функционал
 
Облачные приложения всегда поддерживаются в актуальном состоянии и на них вы найдете самый новый функционал
Строка 36: Строка 37:
 
#Просмотреть, какой функционал появляется в новых версиях между вашей текущей и актуальной в описании соответствующих релизов [[Описание_релизов|на их страницах]]
 
#Просмотреть, какой функционал появляется в новых версиях между вашей текущей и актуальной в описании соответствующих релизов [[Описание_релизов|на их страницах]]
 
#Проанализировать исправленные ошибки и выполненные требования, которые были направлены от заинтересованных лиц в [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 notes»''' и посмотреть последнюю выпущенную версию ядра (BACK) и навигатора (NAVI)
  
 
Для того, чтобы узнать ''текущую версию'' вашего стенда есть два способа:
 
Для того, чтобы узнать ''текущую версию'' вашего стенда есть два способа:
−
#Посмотреть по ссылке. Способ описан в [Платформа_3V/Версия_платформы |статье "Версия_платформы"]],  
+
#Посмотреть по ссылке. Способ описан в [[Платформа_3V/Версия_платформы| статье "Версия_платформы"]],  
 
#Посмотреть имя/тег любого используемого докер-образа
 
#Посмотреть имя/тег любого используемого докер-образа
  
−
= Возможности коммуникации с платформой 3V =
+
= Что почитать о платформе самостоятельно?=
 +
В рамках существующей платформы постоянно пополняется наша база знаний. В рамках нее вы найдете следующие информационные ресурсы, которые возможно использовать самостоятельно:
 +
 
 +
===Wiki===
 +
Wiki - это открытая энциклопедия, в ней вы найдете:
 +
#[[Платформа_3V/Вводный_порядок_обучения_по_работе_с_платформой|вводный порядок обучения по работе с платформой]] с  [https://trivium.group/video '''ссылками на видеоролики'''] с настройкой простых информационных объектов
 +
#статьи с описанием настройки различного функционала информационных объектов [[Заглавная_страница|(см. внизу Главной страницы)]]
 +
#[[Платформа 3V/Рекомендации по использованию инструментов платформы и решаемым задачам |рекомендации]] по использованию и оптимизации информационных объектов
 +
#описание [[Платформа_3V/Рекомендации_по_использованию_инструментов_платформы_и_решаемым_задачам/Кейсы_использования |кейсов использования]]
 +
 
 +
 
 +
===Техническая документация===
 +
В [https://doc.3v-group.net/api/index.html '''технической документации'''] вы найдете описание JSON свойств объектов. Данная документация собирается на основании последних версии платформы 3V, поэтому является наиболее полной и актуальной.
 +
 
 +
= Как с нами связаться? =
  
 
===Заявка на демонстрацию===
 
===Заявка на демонстрацию===
−
Запросить заявку на демонстрацию возможно через [https://trivium.group trivium.group], либо написать нам письмо на электронную почту: info@trivium.group, либо обратиться по телефону: +7(495) 369-55-10
+
Запросить заявку на демонстрацию возможно через [https://trivium.group trivium.group], либо написав нам письмо на электронную почту: info@trivium.group или обратившись по телефону: +7(495) 369-55-10
  
 
===Техническая поддержка===
 
===Техническая поддержка===
−
Служба для обращений за оказанием помощи по решению возникшей проблемы и получением дополнительной информации по интересующему вопросу.
+
Служба позволяет направить обращения при возникновении ошибок работы функционала, а также получить рекомендации по использованию Платформы 3V.
 
{| class="wikitable"  
 
{| class="wikitable"  
 
|-
 
|-
 
| '''Доступ''' ||  https://trivium-group.atlassian.net/servicedesk/customer/portals
 
| '''Доступ''' ||  https://trivium-group.atlassian.net/servicedesk/customer/portals
 
|-
 
|-
−
|'''Авторизация''' || [[Платформа 3V/Инструкция по работе с платформой/Инструкция по работе с сервисом технической поддержки|Инструкция по работе с сервисом технической поддержки]]
+
|'''Инструкция''' || [[Платформа_3V/Инструкция_по_работе_с_платформой/Инструкция_по_работе_с_сервисом_технической_поддержки_проектов_на_платформе_3V|Инструкция по работе с сервисом технической поддержки]]
−
|-
 
−
|'''Правила пользования''' || [[Платформа 3V/Инструкция по работе с платформой/Стандарт технической поддержки проектов на платформе 3V|Стандарт пользования технической поддержки 3V]]
 
−
|}
 
−
 
 
−
===Askbot===
 
−
Система ориентированная на формат вопрос-ответ, созданная решать локальные вопросы, возникающие при использовании платформы Тривиум.
 
−
{| class="wikitable"
 
−
|-
 
−
| '''Доступ''' ||  https://ask.3v-group.net
 
 
|-
 
|-
−
|'''Авторизация''' || Учётная запись Jira BS
 
−
|-
 
−
|'''Правила пользования'''
 
−
||
 
−
Перед тем как задать вопрос, поищите уже аналогичный существующий вопрос в системе.
 
−
Если аналогичный вопрос не был найден, воспользуйтесь следующими рекомендациями:
 
−
 
−
# Кратко опишите проблему в заголовке вопроса, например - "Как через json задать настройки фильтрации по данным показателя в отчете";
 
−
# Опишите ваш пример и проблему, сопровождая скриншотами, таблицами и прочими материалами, необходимыми для полного понимания вопроса. Избегайте указания ссылок на стенды;
 
−
# Если были попытки решить проблему самостоятельно, укажите способы и возникшие ограничения;
 
−
# Установите один или несколько тегов, которые характеризуют вашу проблему. Список рекомендуемых тегов по платформе 3v: Отчеты, Справочники, Показатели, Согласование, Методики, Импорт, Экспорт, Формы, Права, Навигатор, Шапка, Боковик, Формулы
 
−
Примечание! Если на ваш вопрос был дан правильный ответ и он Вам помог, не забудьте отметить данный ответ «Галочкой» и закрыть вопрос
 
 
|}
 
|}
−
 
−
== Информационные ресурсы ==
 
−
 
−
На ресурсе Wiki вы найдете:
 
−
#[[Платформа_3V/Вводный_порядок_обучения_по_работе_с_платформой|вводный порядок обучения по работе с платформой]] с ссылками на видеоролики с настройкой простых информационных объектов
 
−
#статьи с описанием настройки различного функционала информационных объектов [[Заглавная_страница|(см. внизу Главной страницы)]]
 
−
#различные [[Платформа 3V/Рекомендации по использованию инструментов платформы и решаемым задачам |рекомендации]] по использованию и оптимизации информационных объектов
 
−
#описание [[Платформа_3V/Рекомендации_по_использованию_инструментов_платформы_и_решаемым_задачам/Кейсы_использования |кейсов использования]]
 
−
#порядок [[Платформа 3V/Инструкция по работе с платформой/Инструкция по работе с сервисом технической поддержки |регистрации]] и [[Платформа 3V/Инструкция по работе с платформой/Стандарт технической поддержки проектов на платформе 3V|использования]] сервиса технической поддержки
 
−
 
−
Ответы на основные вопросы по работе с Wiki вы найдете на [[Добро_пожаловать_в_Wiki_3V!  |'''Welcome странице''']]
 
−
 
−
В [https://trivium.group/documentation '''руководстве пользователя'''] вы найдёте основную информацию по функциональным возможностям платформы от установки до составления сложных нагруженных отчетов. Описание JSON свойств объектов вы найдёте в [https://doc.3v-group.net/api/index.html '''технической документации''']. Данная документация собирается на основании последней версии кода, поэтому является наиболее полной и актуальной.
 

Текущая версия на 11:09, 9 августа 2022

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

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

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

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

В помощь DevOps специалисту для разворачивания платформы с помощью docker-compose по ссылке https://gitlab.3v-group.org/open/3v-platform в папке «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/3v-platform в папке «Release notes», а также в описании соответствующих релизов на их страницах

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

При необходимости создания нового приложения ("тенанта") в облаке обратитесь в техническую поддержку с типом обращения "Консультация".

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

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

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

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

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

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

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

Что почитать о платформе самостоятельно?

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

Wiki

Wiki - это открытая энциклопедия, в ней вы найдете:

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


Техническая документация

В технической документации вы найдете описание JSON свойств объектов. Данная документация собирается на основании последних версии платформы 3V, поэтому является наиболее полной и актуальной.

Как с нами связаться?

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

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

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

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

Доступ https://trivium-group.atlassian.net/servicedesk/customer/portals
Инструкция Инструкция по работе с сервисом технической поддержки
Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Инструкция_по_работе_с_платформой&oldid=6745