Инструкция по развёртыванию модуля триггеров в операционной системе Windows: версия 16.Х.

Перед началом установки модуля триггеров убедитесь, что установка Системы ADVANTA проведена корректно, иначе модуль триггеров не запустится. Информацию об установке Системы можно найти на страницах:
  1. Windows server 2012 R2, или выше. Со всеми последними обновлениями
  2. MS Internet Information Services (IIS) 8.5.
  3. .net core 3.1.3 hosting bundle
  1. Windows server 2012 R2, или выше. Со всеми последними обновлениями
  2. Один из вариантов СУБД:
    1. MS SQL Server 2012, или выше. Со всеми последними обновлениями
    2. PostgreSql версии 10, или выше
  1. Открыть оснастку SQL Server Management Studio
  2. Создать новую базу данных. В названии указать любое значение (например triggers)
  3. Создать учетную запись для базы данных модуля триггеров.
    1. В окне «Обозреватель объектов» (Object Explorer) раскрыть «Безопасность» (Security), нажать правой кнопкой мыши на «Имена входа» (Logins) и выбрать «Создать имя» (New Login)
    2. В разделе «Общие» (General):
      1. В поле «Имя входа» (Login name) ввести любое значение (например triggers). Введённый логин затем понадобится указать на сервере приложения для доступа к базе данных.
      2. Ввести пароль учетной записи. Введённый пароль затем понадобится указать на сервере приложения для доступа к базе данных
      3. Выставить опцию «Проверка подлинности SQL Server» (SQL Server authentication)
      4. Убрать опцию «Требовать использование политики паролей» (Enforce password policy)
      5. Выставить используемый язык «Язык по умолчанию» (Default language), выбрав в выпадающем меню «Русский» (Russian)
      6. Выставить используемую базу данных «База данных по умолчанию», выбрав в выпадающем списке меню базу, созданную на шаге 2.1.1.2
    3. Нажать «OK»
  4. Открыть созданную учетную запись. Перейти на страницу «Сопоставление пользователей» (User Mapping):
    1. В окне «Пользователи, сопоставленные с этим именем входа» (User mapped to this login) в столбце «Схема» (Map) установить галочку напротив базы, созданную на шаге 2.1.1.2
    2. В окне «Членство в роли базы данных для: <выбранная база данных>» (Database role for membership for) выставить права db_owner.

Настройка PostgreSql

  1. Открываем pgAdmin
  2. Добавляем пользователя
  3. Создаем новую БД.
  1. Установить Net core 3.1.3 hosting bundle
  2. Установить Internet Information Services с компонентами по умолчанию
  3. Добавить учетную запись пользователя в систему, от которого будет работать сервис через оснастку «Локальные пользователи и группы».
  4. Распаковать архив с предоставленным модулем триггеров в папку содержащую контенты сайтов IIS (по умолчанию для IIS путь к папке: C:\inetpub\wwwroot\)
  5. Настроить конфигурационный файл модуля триггеров appsettings.json в скопированном контенте
    1. Секция «Database»: «ConnectionStrings», строка подключения к созданной базе данных модуля триггера
    2. RuntimeUser – логин и пароль администратора, от чьего имени будут вестись запросы в API системы Advanta при исполнении триггеров (параметры Login и Password соответственно). Под этим пользователем, через API так же осуществляется запрос на извлечение данных о типах объектов.
    3. Host – URL адрес сервера для осуществления запросов в API системы Advanta. Должно работать через https и доменное имя адреса обязательно должно совпадать с именем, на которое был выдан сертификат для системы Адванта.
    4. Секция «Rebus»: «ConnectionStrings», строка подключения к шине событий системы Advanta (к той базе системы ADVANTA, для которой настраиваются триггеры).

Раздел Logging, подраздел File

  • RootPath – абсолютный путь по которому будет размещаться папка с логами. По умолчанию полный путь до папки с приложением.
  • BasePath – относительный путь до папки, в которой будут создаваться файлы с логами. По умолчанию Logs. Конечный путь до папки с файлами логов будет сформирован объединением путей: [RootPath]\[BasePath].
  • LogLevel – набор фильтров сообщений, поступающих в лог. Формируется по правилам стандартного логирования в Asp.Net Core. Для полного отключения логов, необходимо внутри данной секции указать параметр «Default» : «None».

Раздел Advanta

RuntimeUser - используется логин и пароль локальной учетной записи администратора системы Адванта.

**Подраздел Api**
  • ObjectsSyncTimeout – период синхронизации типов объектов с системой Advanta. Задаётся в секундах. Параметр необязательный. Значение по умолчанию 1440 (т.е. раз в 24 минуты).
  • RequestTimeout – период ожидания ответа SOAP API системы Advanta. Задаётся в секундах. Параметр необязательный. Если параметр не задан или его значение равно 0, то будет использовано значение по умолчанию равное 3600 (т.е. 3600 секунд, что равно одному часу).
**Подраздел Rebuild (Api)**
  • RootPath – абсолютный путь в котором будет размещаться папка для генерации исходного кода Api. По умолчанию [полный путь до папки с приложением]\\CompilerConfig.
  • BasePath – относительный путь до папки, в которой будет собираться Api. По умолчанию Api. Папка должна присутствовать на сервере и у приложения триггеров должен быть доступ на запись и чтение в папку.
  • Endpoints – строковый массив названий soap endpoint-ов, которые будут опрашиваться для сборки Api. По умолчанию : [«Login», «Persons», «APIDiscussions», «APIPlans», «APIProjects», «APIService», «APISecurity», «APIRelations»].
  • Disabled – признак принудительного запрета на сборку Api во время работы модуля. По умолчанию false.
**Подраздел Alerts**
  • Emails – список почтовых адресов, на которые необходимо рассылать уведомления о перезапуске или сбое в работе триггеров. Список необходимо указать через любой из разделителей: запятая, точка с запятой, пробел.
  • Подраздел SmtpServer – содержит настройки smtp сервера для отправки email уведомлений:
    • Address: адрес smtp сервера,
    • Login: логин (email) отправителя,
    • Password: пароль отправителя,
    • Port: номер порта, если требуется,
    • UseSSL: требование использовать SSL (true/false) по умолчанию false
**Подраздел Rebus**
  • Transport – тип транспорта для Rebus шины сообщений. Возможные варианты:
    • «MSSQL»
    • «PostgreSql».
      Если параметр не указан или пустой, то по-умолчанию используется значение «MSSQL».
  • ConnectionString – строка подключения к базе данных, через которую публикуются сообщения rebus.
  • InputQueueName – название очереди сообщений (канала), через которую будут поступать сообщения для данного instans-а. Для MSSQL по-умолчанию будет «Bus_TriggersInputQueue», для PostgreSql по-умолчанию будет «bus_triggers_queue».
Для MSSQL параметр игнорируется, так как для MSSQL Rebus использует (и при необходимости создаёт) таблицу с именем, совпадающим с названием входящей очереди сообщений (InputQueueName).
  • SubscriptionsTableName – название таблицы, в которую будет размещена информация о подписках. Для MSSQL по-умолчанию будет «Bus_TriggersInputQueue_Subscriptions», для PostgreSql по-умолчанию будет «bus_triggers_input_queue_subscriptions» (должно совпадать с настройками публикующего сервиса).
  • PostgreSqlMessagesTableName – название таблицы, через которую будет вестись обмен сообщениями в случае PostgreSql транспорта. По умолчанию будет использоваться «bus_triggers_messages» (должно совпадать с настройками публикующего сервиса).
**Раздел Database**
  • Provider – определяет тип СУБД, используемой для модуля триггеры. Возможные варианты:
    • “MSSQL” и “PostgreSql”.
      Если параметр не указан или пустой, то по умолчанию используется значение “MSSQL”.
    • Возможен так же вариант “Memory”. В этом варианте СУБД использоваться не будет, а все будет храниться в памяти до завершения работы приложения. Данный режим удобно использовать в процессе разработки и тестирования.
  • ConnectionString – строка подключения к базе данных, в которой размещаются триггеры.
  • MigrateOnStartup – признак автоматической миграции структуры базы данных.
    • Принимаемые значения «true» или «false». Параметр необязательный. Значение по умолчанию “false”.
    • Флаг «true» может потребоваться только если есть возможность обновления и развёртывания схемы данных через миграции (например, во время разработки или создания локальной базы). Если значение флага установлено в “true”, потребуются права на создание, изменение, удаление таблиц и индексов.
**Раздел Module**

InstanceName – наименование запускаемого инстанса модуля Триггеры. Данное наименование добавляется к логам и в тему email уведомлений

  1. Открыть «Диспетчер служб IIS» (Internet Information Services (IIS) Manager).
  2. При необходимости создать сертификат, перейти в меню «Сертификаты сервера», в окне «Действия» выбрать «Создать самозаверенный сертификат». – ЕСЛИ СЕРТИФИКАТ ЕСТЬ, САМОЗАВЕРЕННЫЙ НЕ НУЖЕН
    1. «Понятное имя сертификата» - любое, «выбор хранилища сертификатов….» выбираем «Размещение веб-служб».
    2. Данный сертификат в дальнейшем можно будет импортировать на другой сервер, для этого нужно выбрать справа «Экспортировать», выбрать расположение и задать пароль, затем полученный сертификат импортировать и добавить в «Доверенные корневые центры сертификации».


  3. Перейти к разделу «Пулы приложений» (Application pools):
    1. Создать новый пул для приложения:
      1. Имя – любое.
      2. Пул приложения – «Без управляемого кода».
      3. Режим управляемого конвейера – «Встроенный».
    2. Открыть «Дополнительные параметры» (Advanced settings) созданного пула приложений, изменить следующие параметры:
      1. «Загрузить профиль пользователя» (Load User Profile) на «True»
      2. «Режим запуска» (Start mode) на «Always Running»
      3. «Интервал сбоев (в минутах)» (Idle Time-out (minutes)) на 0
      4. «Действие при окончании времени ожидания простоя» (Idle Time-out Action) - на «Suspend»
      5. «Предварительная установка включена» (Set Preload Enabled) - «True»
      6. «Постоянный временной интервал» (в минутах)(Regular Time Interval)(minutes) на 0
  4. Перейти к разделу «сайты», нажимаем «Добавить веб сайт»:
    1. Создать новый веб сайт:
      1. Имя любое
      2. Выбрать пул, созданный на шаге 3.3 только что созданный нами пул приложения.
      3. Физический путь – выбрать папку с распакованным веб контентом модуля триггеров на шаге 2.4
    2. Выбираем в списке сайтов вновь созданный сайт, заходим в контекстное меню и выбираем пункт «Редактировать разрешение», переходим на вкладку «Безопасность» и добавляем туда созданную выше учетную запись пользователя.
    3. Заходим на созданную страницу IIS сайта, в действиях нажимаем «Тест настроек», должно открыться модальное окно, в котором все пункты будут отмечены зелеными индикаторами, говорящие об успешности настройки доступа сайта и файловой системы.