Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourGrey
titleСтатус
Status
colourRed
titleразработка

Note

Доступно начиная с версии ExeMES 1.3, ExeReport 1.3

Для удобства администрирования ПО ExePlant и сокращения времени реакции на ошибки лицензии в ПО добавлена возможность настройки рассылки уведомлений об ошибках лицензии.

Table of Contents

Настройка отправки уведомлений через web API:

Если необходимо оповещать об ошибках лицензии стороннюю систему (например, систему мониторинга) необходимо настроить уведомления об ошибках лицензии с использованием web API: при возникновении ошибки модуль лицензирования ПО ExePlant будет отправлять post запрос на указанный вами URL.

Чтобы включить отправку уведомлений через web API, необходимо добавить и определить значение следующих переменных:

  • IsApiSend - признак включения/отключения оповещений через api:
    • true - оповещения включены;
    • false - оповещения отключены (значение по умолчанию);
  • ApiSendUrl - URL, на который необходимо отправлять POST-запрос.
Code Block
titleНастройка при запуске docker контейнера
dotnet run -e LicenseNotification:IsApiSend="true" -e LicenseNotification:ApiSendUrl="https://url.site/"
Code Block
titleНастройка через appsettings.json
{
  "LicenseNotification": {
    "IsApiSend": true,
    "ApiSendUrl": "https://url.site/",
  }
}
Code Block
titleТело запроса
{
  "MessageSendingTimeUTC0": "2024-09-25T13:20:08.5106728Z",
  "MessageSendingTimeLocal": "2024-09-25T16:20:08.5106728+03:00",
  "ProductName": "EXEReport",
  "LicenseStatus": 0,
  "LicenseStatusText": "NotFound",
  "AvailableLicenseStatusList": [
    "NotFound",
    "Actual",
    "NotActual"
  ],
  "MessageRuLanguage": "Во время запуска приложения 'EXEReport' произошла ошибка лицензии. Код ошибки: (33) DONGLE_NOT_FOUND",
  "MessageEnUSLanguage": "A license error occurred while launching the 'EXEReport' application. Error code: (33) DONGLE_NOT_FOUND",
  "MessageEnGBLanguage": "A license error occurred while launching the 'EXEReport' application. Error code: (33) DONGLE_NOT_FOUND"
}


Настройка отправки уведомлений через электронную почту

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

  • IsMailSend - признак включения/отключения оповещений через электронную почту:
    • true - оповещения включены;
    • false - оповещения отключены (значение по умолчанию);
  • MailServer - адрес smtp сервера;
  • MailPort - порт smtp сервера;
  • MailUseSSL - включение SSL (по умолчанию - false);
  • MailUseAuth - признак включения/отключения авторизации на smtp сервере:
    • true - включена (значение по умолчанию);
    • false - отключена;
  • MailUserName - пользователь (e-mail) smtp сервера, от имени которого отправляется сообщение;
  • MailPassword - пароль пользователя, указанного в переменной MailUserName;
  • MailSocket - сокет, используемый для подключения. Доступные значения сокетов:
    • None - обозначает, что при подключение не требуется использовать шифрование SSL или TLS;
    • Auto - обозначает, что IMailService самостоятельно определит какие параметры SSL или TLS использовать, если smtp сервер не поддерживает SSL или TLS, то будет установлено соединение без шифрования;
    • SslOnConnect - должно быть установлено зашифрованное SSL или TLS соединение;
    • StartTls - должно быть установлено зашифрованное TLS соединение, если smtp сервер не поддерживает StartTLS, то соединение будет разорвано;
    • StartTlsWhenAvailable - должно быть установлено зашифрованное TLS соединение, если оно поддерживается smtp сервером;
  • MailSendToAddressesList - список адресов, на которые должна быть выполнена рассылка.
    Tip

    Если необходима рассылка на несколько адресов - перечислите их через запятую

Expand
titleПримеры настройки для почтового сервера без авторизации
Code Block
titleНастройка при запуске docker контейнера
dotnet run -e LicenseNotification:IsMailSend=true -e LicenseNotification:MailServer="smtp.my.site" -e LicenseNotification:MailPort=25 -e LicenseNotification:MailUseSSL=false -e LicenseNotification:MailUseAuth=false -e LicenseNotification:MailUserName="UserName@my.site" -e LicenseNotification:MailSocket="None" -e LicenseNotification:MailSendToAddressesList="user1@my.site,user2@my.site"
Code Block
titleНастройка через appsettings.json
{
  "LicenseNotification": {
    "IsMailSend": true,
    "MailServer": "smtp.my.site",
    "MailPort": 25,
    "MailUseSSL": false,
    "MailUseAuth": false,
    "MailUserName": "UserName@my.site",
    "MailSocket": "None",
    "MailSendToAddressesList": "user1@my.site,user2@my.site"
  }
}
Expand
titleПримеры настройки для почтового сервера с авторизацией по паре логин/пароль
Code Block
titleНастройка при запуске docker контейнера
dotnet run -e LicenseNotification:IsMailSend=true -e LicenseNotification:MailServer="smtp.my.site" -e LicenseNotification:MailPort=465 -e LicenseNotification:MailUseSSL=true -e LicenseNotification:MailUserName="UserName@my.site" -e LicenseNotification:MailPassword="UserPassword" -e LicenseNotification:MailSendToAddressesList="user1@my.site,user2@my.site"
Code Block
titleНастройка через appsettings.json
{
  "LicenseNotification": {
    "IsMailSend": true,
    "MailServer": "smtp.my.site",
    "MailPort": 465,
    "MailUseSSL": true,
    "MailUserName": "UserName@my.site",
    "MailPassword": "UserPassword",
    "MailSendToAddressesList": "user1@my.site,user2@my.site"
  }
}