Платформа 3V/Навигатор/Конфиг навигатора: различия между версиями

Материал из 3v-wiki
Перейти к навигации Перейти к поиску
м
Строка 19: Строка 19:
 
|    name || "docker" || имя конфига
 
|    name || "docker" || имя конфига
 
|-
 
|-
−
| rootName || "3V" || Имя рутовой папки
+
| rootName || "3V" || имя рутовой папки
 
|-
 
|-
−
| titleName || "Trivium Navigator" || Заголовок вкладки браузера
+
| titleName || "Trivium Navigator" || заголовок вкладки браузера
 
|-
 
|-
−
| navigatorSearchMinimumLetters || 2 || Минимальное количество символов для поиска в дереве навигатора
+
| navigatorSearchMinimumLetters || 2 || минимальное количество символов для поиска в дереве навигатора
 
|-
 
|-
−
| navigatorSearchTimeout || 300 || Таймаут для поиска в дереве навигатора
+
| navigatorSearchTimeout || 300 || таймаут для поиска в дереве навигатора
 
|-
 
|-
−
| homePageId ||  || (Устаревшее) Идентификатор объекта используемого в качестве стартовой страницы
+
| homePageId ||  || (устаревшее) идентификатор объекта используемого в качестве стартовой страницы
 
|-
 
|-
−
| homePageCode ||  || Код объекта используемого в качестве стартовой страницы
+
| homePageCode ||  || код объекта используемого в качестве стартовой страницы
 
|-
 
|-
−
| configObjectCode ||  || Код объекта с настройками кастомизации (используется для настройки разных стартовых страниц и оформления для разных ролей пользователей)
+
| configObjectCode ||  || код объекта с настройками кастомизации (используется для настройки разных стартовых страниц и оформления для разных ролей пользователей)
 
|-
 
|-
−
| newObjectFolderCode ||  || Код объекта для расположения новых объектов
+
| newObjectFolderCode ||  || код объекта для расположения новых объектов
 
|-
 
|-
−
| defaultGridComponent || "DataTables" || Грид используемый по умолчанию(доступные варианты: DataTables, AgGridViewport, AgGrid)
+
| defaultGridComponent || "DataTables" || грид используемый по умолчанию(доступные варианты: DataTables, AgGridViewport, AgGrid)
 
|-
 
|-
−
| agGridLicence ||  || Лицензия для AgGrid
+
| agGridLicence ||  || лицензия для AgGrid
 
|-
 
|-
−
| gridResetEmbeddedFlag || false || Сброс флага areDataEmbedded в пивотах полученных из карточек, для работы с гридом через окна
+
| gridResetEmbeddedFlag || false || сброс флага areDataEmbedded в пивотах полученных из карточек, для работы с гридом через окна
 
|-
 
|-
−
| languageSwitcher || false || Отображение переключения языков на стартовой странице
+
| languageSwitcher || false || отображение переключения языков на стартовой странице
 
|-
 
|-
−
| instantAutoFilterButton || false || Отображать кнопку автофильтра постоянно в шапке грида для всех столбцов
+
| instantAutoFilterButton || false || отображать кнопку автофильтра постоянно в шапке грида для всех столбцов
 
|-
 
|-
−
| limitDictionaryElementsCount || 1000 || Ограничение на количество загружаемых элементов справочника
+
| limitDictionaryElementsCount || 1000 || ограничение на количество загружаемых элементов справочника
 
|-
 
|-
−
| gzip || false || Нужно ли дополнительно упаковывать содержимое запросов к бакенду с помощью gzip
+
| gzip || false || нужно ли дополнительно упаковывать содержимое запросов к бакенду с помощью gzip
 
|-
 
|-
−
| trimValues || false || Обрезать пробелы и переводы строки редактируемых значений
+
| trimValues || false || обрезать пробелы и переводы строки редактируемых значений
 
|-
 
|-
−
| serverWait || 500 || Задержка для скрола DataTables прежде чем будут запрашиваться данные ([https://datatables.net/reference/option/scroller.serverWait Datatables API])
+
| serverWait || 500 || задержка для скрола DataTables прежде чем будут запрашиваться данные ([https://datatables.net/reference/option/scroller.serverWait Datatables API])
 
|-
 
|-
−
| websocketDisabled || false || Отключение получения данных через вебсокеты
+
| websocketDisabled || false || отключение получения данных через вебсокеты
 
|-
 
|-
−
| gridFormulaRowHidden || false || Скрытие строки с формулой над гридом
+
| gridFormulaRowHidden || false || скрытие строки с формулой над гридом
 
|-
 
|-
−
| colspan="2" | '''theme''' || Настройки темизации (подробнее [[Платформа_3V/Навигатор/Темы_навигатора|Темы_навигатора]])
+
| colspan="2" | '''theme''' || настройки темизации (подробнее [[Платформа_3V/Навигатор/Темы_навигатора|Темы_навигатора]])
 
|-
 
|-
 
|    defaultThemeName || "default" || имя темы по умолчанию, используется если пользователь не менял тему (настройка сохраняется в localStorage и ее можно очистить вместе с cookies)
 
|    defaultThemeName || "default" || имя темы по умолчанию, используется если пользователь не менял тему (настройка сохраняется в localStorage и ее можно очистить вместе с cookies)
Строка 69: Строка 69:
 
|    isEnabled || false || включена ли (выключена бывает при локальной отладке)
 
|    isEnabled || false || включена ли (выключена бывает при локальной отладке)
 
|-
 
|-
−
|    clientId || || Настройка clientId для сервера авторизации
+
|    clientId || || настройка clientId для сервера авторизации
 
|-
 
|-
−
|    clientSecret || || Настройка clientSecret для сервера авторизации
+
|    clientSecret || || настройка clientSecret для сервера авторизации
 
|-
 
|-
−
|    revokeOnLogout || false || Настройка для логаута (позволяющая отзывать токен при логауте)
+
|    revokeOnLogout || false || настройка для логаута (позволяющая отзывать токен при логауте)
 
|-
 
|-
−
| colspan="2" |    '''poibSettings''' || Настройки для случая работы с ПОиБ
+
| colspan="2" |    '''poibSettings''' || настройки для случая работы с ПОиБ
 
|-
 
|-
 
|       accessTokenName ||  ||  
 
|       accessTokenName ||  ||  
 
|-
 
|-
−
| colspan="2" |    '''plainOAuth2''' || Настройки для случая работы с plain OAuth2 по http
+
| colspan="2" |    '''plainOAuth2''' || настройки для случая работы с plain OAuth2 по http
 
|-
 
|-
 
|       loginUrl ||  ||  
 
|       loginUrl ||  ||  
Строка 91: Строка 91:
 
|       scope ||  ||  
 
|       scope ||  ||  
 
|-
 
|-
−
| colspan="2" |    '''multipleNamespaces''' || Настройки для мультинеймспейсности
+
| colspan="2" |    '''multipleNamespaces''' || настройки для мультинеймспейсности
 
|-
 
|-
−
|       urlSearchPattern ||  || Регулярное выражение для поиска неймспейса в текущем хосте.
+
|       urlSearchPattern ||  || регулярное выражение для поиска неймспейса в текущем хосте.
 
Например, взять домен 3го уровня, исключая 3v (пример хоста: trivium-test.3v-group.net):
 
Например, взять домен 3го уровня, исключая 3v (пример хоста: trivium-test.3v-group.net):
 
"^(\\w{1}|3[^v]|[^3]v|[^3][^v]|[-\\w]{3,}){1}.[-\\w]+.[-\\w]+$"
 
"^(\\w{1}|3[^v]|[^3]v|[^3][^v]|[-\\w]{3,}){1}.[-\\w]+.[-\\w]+$"
 
|-
 
|-
−
|       authReplacePattern ||  || Регулярное выражение для поиска дефолтного неймспейса в урле по работе с авторизацией.
+
|       authReplacePattern ||  || регулярное выражение для поиска дефолтного неймспейса в урле по работе с авторизацией.
 
Например, поиск реалма в строке авторизации в киклоке (пример урла авторизации: https://3v.3v-group.net/auth/realms/trivium):
 
Например, поиск реалма в строке авторизации в киклоке (пример урла авторизации: https://3v.3v-group.net/auth/realms/trivium):
  
 
"https?:\\/\\/[-\\w]+.[-\\w]+.[-\\w]+\\/[-\\w]+\\/[-\\w]+\\/([-\\w]+)"
 
"https?:\\/\\/[-\\w]+.[-\\w]+.[-\\w]+\\/[-\\w]+\\/[-\\w]+\\/([-\\w]+)"
 
|-
 
|-
−
| colspan="2" | '''gateway''' || Настройки для взаимодействия с сервисами(бакендом)
+
| colspan="2" | '''gateway''' || настройки для взаимодействия с сервисами(бакендом)
 
|-
 
|-
−
|    baseUrl ||  || Базовый урл для всех сервисов
+
|    baseUrl ||  || базовый урл для всех сервисов
 
|-
 
|-
−
| colspan="2" |    '''locations''' || Адреса (обычно относительные) сервисов
+
| colspan="2" |    '''locations''' || адреса (обычно относительные) сервисов
 
|-
 
|-
−
|       auth ||  || Сервис авторизации
+
|       auth ||  || сервис авторизации
 
|-
 
|-
−
|       calculation || "engine" || Сервис методик
+
|       calculation || "engine" || сервис методик
 
|-
 
|-
−
|       cards || "cards" || Сервис карточек
+
|       cards || "cards" || сервис карточек
 
|-
 
|-
−
|       dictionaries || "dictionaries" || Сервис справочников
+
|       dictionaries || "dictionaries" || сервис справочников
 
|-
 
|-
−
|       engine || "engine" || Сервис ядра
+
|       engine || "engine" || сервис ядра
 
|-
 
|-
−
|       importexportdata || "import-export" || Сервис импорта/экспорта
+
|       importexportdata || "import-export" || сервис импорта/экспорта
 
|-
 
|-
−
|       pgprovider || "pgprovider" || Сервис pgprovider
+
|       pgprovider || "pgprovider" || сервис pgprovider
 
|-
 
|-
−
|       repository || "repository" || Сервис репозитория
+
|       repository || "repository" || сервис репозитория
 
|-
 
|-
−
|       subjects || "subjects" || Сервис прав на объекты
+
|       subjects || "subjects" || сервис прав на объекты
 
|-
 
|-
−
|       updates || "updates" || Сервис обновлений
+
|       updates || "updates" || сервис обновлений
 
|-
 
|-
−
|       workflow || "workflow" || Сервис согласования
+
|       workflow || "workflow" || сервис согласования
 
|-
 
|-
−
| extendCardInstanceLifeInMinutes || 15 || Интервал в минутах запуска выполнения запроса по таймеру для продления времени жизни карточки на сервере, если <= 0 то автопродление отключено
+
| extendCardInstanceLifeInMinutes || 15 || интервал в минутах запуска выполнения запроса по таймеру для продления времени жизни карточки на сервере, если <= 0 то автопродление отключено
 
|}
 
|}

Версия 15:51, 20 апреля 2021

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

Расположение

Конфиги лежат внутри навигатора

  1. в исходниках для разработки или локального запуска их можно найти в "trv-ui/projects/navigator/src/assets/config/"
  2. в собранном навигаторе их можно найти в "assets/config/"

Приложение для установки на стенд обычно собирается в "prod" конфигурации и тогда используется конфиг "config.docker.json". При деплое проекта на стенд конфиг обычно подменяется (заранее подготовленным и хранящимся в гитлабе, для каждого стенда каждого проекта собственный конфиг).

Описание свойств конфига

Свойство Значение по умолчанию Описание
env описание конфига
   name "docker" имя конфига
rootName "3V" имя рутовой папки
titleName "Trivium Navigator" заголовок вкладки браузера
navigatorSearchMinimumLetters 2 минимальное количество символов для поиска в дереве навигатора
navigatorSearchTimeout 300 таймаут для поиска в дереве навигатора
homePageId (устаревшее) идентификатор объекта используемого в качестве стартовой страницы
homePageCode код объекта используемого в качестве стартовой страницы
configObjectCode код объекта с настройками кастомизации (используется для настройки разных стартовых страниц и оформления для разных ролей пользователей)
newObjectFolderCode код объекта для расположения новых объектов
defaultGridComponent "DataTables" грид используемый по умолчанию(доступные варианты: DataTables, AgGridViewport, AgGrid)
agGridLicence лицензия для AgGrid
gridResetEmbeddedFlag false сброс флага areDataEmbedded в пивотах полученных из карточек, для работы с гридом через окна
languageSwitcher false отображение переключения языков на стартовой странице
instantAutoFilterButton false отображать кнопку автофильтра постоянно в шапке грида для всех столбцов
limitDictionaryElementsCount 1000 ограничение на количество загружаемых элементов справочника
gzip false нужно ли дополнительно упаковывать содержимое запросов к бакенду с помощью gzip
trimValues false обрезать пробелы и переводы строки редактируемых значений
serverWait 500 задержка для скрола DataTables прежде чем будут запрашиваться данные (Datatables API)
websocketDisabled false отключение получения данных через вебсокеты
gridFormulaRowHidden false скрытие строки с формулой над гридом
theme настройки темизации (подробнее Темы_навигатора)
   defaultThemeName "default" имя темы по умолчанию, используется если пользователь не менял тему (настройка сохраняется в localStorage и ее можно очистить вместе с cookies)
   additionalThemes коллекция дополнительных тем
logging настройки логирования
auth настройки авторизации
   isEnabled false включена ли (выключена бывает при локальной отладке)
   clientId настройка clientId для сервера авторизации
   clientSecret настройка clientSecret для сервера авторизации
   revokeOnLogout false настройка для логаута (позволяющая отзывать токен при логауте)
   poibSettings настройки для случая работы с ПОиБ
      accessTokenName
   plainOAuth2 настройки для случая работы с plain OAuth2 по http
      loginUrl
      logoutUrl
      tokenEndpoint
      revocationEndpoint
      scope
   multipleNamespaces настройки для мультинеймспейсности
      urlSearchPattern регулярное выражение для поиска неймспейса в текущем хосте.

Например, взять домен 3го уровня, исключая 3v (пример хоста: trivium-test.3v-group.net): "^(\\w{1}|3[^v]|[^3]v|[^3][^v]|[-\\w]{3,}){1}.[-\\w]+.[-\\w]+$"

      authReplacePattern регулярное выражение для поиска дефолтного неймспейса в урле по работе с авторизацией.

Например, поиск реалма в строке авторизации в киклоке (пример урла авторизации: https://3v.3v-group.net/auth/realms/trivium):

"https?:\\/\\/[-\\w]+.[-\\w]+.[-\\w]+\\/[-\\w]+\\/[-\\w]+\\/([-\\w]+)"

gateway настройки для взаимодействия с сервисами(бакендом)
   baseUrl базовый урл для всех сервисов
   locations адреса (обычно относительные) сервисов
      auth сервис авторизации
      calculation "engine" сервис методик
      cards "cards" сервис карточек
      dictionaries "dictionaries" сервис справочников
      engine "engine" сервис ядра
      importexportdata "import-export" сервис импорта/экспорта
      pgprovider "pgprovider" сервис pgprovider
      repository "repository" сервис репозитория
      subjects "subjects" сервис прав на объекты
      updates "updates" сервис обновлений
      workflow "workflow" сервис согласования
extendCardInstanceLifeInMinutes 15 интервал в минутах запуска выполнения запроса по таймеру для продления времени жизни карточки на сервере, если <= 0 то автопродление отключено
Источник — https://wiki.3v-group.net/index.php?title=Платформа_3V/Навигатор/Конфиг_навигатора&oldid=1682