Alpha.Community

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

Настройка

Конфигурирование службы

После установки Alpha.Reports нужно настроить работу сервера. Все файлы настроек имеют расширение *.json и находятся рядом с исполняемым файлом.

После редактирования файла appsettings.json нужно перезапустить службу Alpha.Reports.

Примеры конфигураций могут отличаться от действительных из-за различия версий.

Файл конфигурации appsettings.json:

{
  "Kestrel": {
    "EndPoints": {
      "HTTP": { "Url": "http://*:5000" }
    }
  },
  "Application": {
    "Name": "Alpha.Reports",
    "ServerAddress": "http://127.0.0.1:5000",
    "LicenseFile": "license.lic",
    "BasePath": "",
    "RedirectToHTTPS": "false",
    "LdapServer": "",
    
    "DataBaseServer": {
      "Address": "localhost",
      "DataBase": "ar_base",
      "Login": "postgres",
      "Password": "postgres"
    },
    
    "LDAPSecurity": {
      "Host": "localhost",
      "Port": "389",
      "BaseName": "AlphaSecurity",
      "AppName": "Reports",
      "DomainName": "dc=test,dc=ru"
      "Rights": {
        "AdminRight": "Administration",
        "ViewRight": "View"
      },
      "Servers": [
        {
          "Host": "127.0.0.1",
          "Port": "389"
        },
        {
          "Host": "192.168.21.51",
          "Port": "389"
        }
      ]
    },
    
    "AlphaLicenceName": "",
    "DisableDataAccessAutoUpdate": "false",
    "AllowAllNIC": "false",
    
    "EntryPoints": [
      "http://127.0.0.1:5000",
      "http://192.168.25.128:5000",
      "http://localhost:5000",
    ],
    "CleanupInterval": 600,
    "SMTP": {
      "Address": "smtp.example.com",
      "Port": "25",
      "Login": "alpha[email protected]",
      "Password": "password",
      "UseSsl": "false",
      "Sender": "[email protected]"
    }
  }
}

В списке EntryPoints нужно перечислить все адреса, по которым должен быть доступен базовый сервер, в том числе все сетевые карты компьютера (если их больше одной) – для CORS политики.

Обращаться к серверу нужно строго по IP-адресу, указанному в поле Application → ServerAddress. Значение localhost – не равно 127.0.0.1.

Для работы в сети рекомендуется указать статичный IP-адрес сервера.

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

  • Application → LDAPSecurity → DomainName – доменное имя LDAP-сервера. Значение по умолчанию: "dc=maxcrc,dc=com".

    Пример: "DomainName": "dc=test,dc=ru".

  • Application → LDAPSecurity → Servers – резервные LDAP-серверы. Если резервных LDAP-серверов нет, добавлять параметр не нужно.

  • Application → SMTP → UseSsl – будет ли использоваться SSL-сертификат. Значение по умолчанию: "true".

    Пример: "UseSsl": "false".

  • Application → SMTP → Sender – адрес отправителя электронной почты. Значение по умолчанию: null.

    Пример: "Sender": "[email protected]".

После перезагрузки Alpha.Reports, если произошло успешное подключение к БД, то все параметры DataBaseServer зашифруются:

"DataBaseServer": "cft0TBFOqHcyy7Iq64i/zhdnMn0fnnZnIQkh3x6TsAKSRUu6Ly0TzIVu4MPr+0NViVCbO kTH8VfcaqJVfQAc5FGAzixEWRpnREbSFDHLalWIy9mlytWw2mz4KRHSTW3crc0aMBt8DkT SO+ScLvuFds1lZDbTyt1BI2cP+lxkM8WkGg59TMjyHS8+As22YGTbsVVm40+dyktO8tMFk mfbyOaureqAsTFkAQ=="

Чтобы изменить параметры подключения к БД, структуру полей DataBaseServer нужно будет восстановить, например скопировать её из примера выше.

Для логирования используется библиотека NLog. Все правила и настройки логирования хранятся в файле NLog.config в каталоге C:\Program Files\Automiq\Alpha.Reports.

Пример файла:

<?xml version="1.0" encoding="utf-8" ?>
<nlog xmlns="http://www.nlog-project.org/schemas/NLog.xsd"
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  autoReload="true"
  throwExceptions="false"
  internalLogLevel="Off"
  internalLogFile="/tmp/nlog-internal.log">
  <variable
    name="AppName"
    value="Alpha.Reports" />
  <variable
    name="FileName"
    value="Service" />
  <targets>
    <target
      xsi:type="Null"
      name="discard" />
    <target
      xsi:type="ColoredConsole"
      name="console"
      layout="${longdate}|${level}|${var:AppName}|${message}${onexception:|${exception:maxInnerExceptionLevel=5:innerExceptionSeparator=|}}">
      <highlight-row
        condition="level == LogLevel.Info"
        foregroundColor="Green"/>
      <highlight-row
        condition="level == LogLevel.Debug"
        foregroundColor="Cyan"/>
    </target>
    <target
      name="file"
      xsi:type="File"
      fileName="/var/log/Automiq/Alpha.Reports/${var:FileName}.log"
      keepFileOpen="true"
      encoding="utf-8"
      archiveAboveSize="10485760"
      enableArchiveFileCompression="true"
      layout="${longdate}|${level}|${var:AppName}|${message}${onexception:|${exception:maxInnerExceptionLevel=10:innerExceptionSeparator=|}}" />
    <target
      name="quartzFile"
      fileName="/var/log/Automiq/Alpha.Reports/${var:FileName}.Quartz.log"
      xsi:type="File"
      keepFileOpen="true"
      encoding="utf-8"
      archiveAboveSize="10485760"
      enableArchiveFileCompression="true"
      layout="${longdate}|${level}|${var:AppName}|${message}${onexception:|${exception:maxInnerExceptionLevel=10:innerExceptionSeparator=|}}" />
    <target
      name="aspnet"
      xsi:type="File"
      fileName="/var/log/Automiq/Alpha.Reports/${var:FileName}.AspNet.log"
      keepFileOpen="false"
      encoding="utf-8"
      archiveAboveSize="10485760"
      enableArchiveFileCompression="true"
      layout="${longdate}|${level}|${var:AppName}|${message}${onexception:|${exception:maxInnerExceptionLevel=10:innerExceptionSeparator=|}}" />
  </targets>
  <rules>
    <logger
      name="Microsoft.AspNetCore*"
      minlevel="Warn"
      writeTo="console" />
    <logger
      name="Microsoft.AspNetCore*"
      writeTo="aspnet"
      final="true" />
    <logger
      name="Quartz*"
      minlevel="Warn"
      writeTo="console" />
    <logger
      name="Quartz*"
      minlevel="Debug"
      writeTo="quartzFile"
      final="true" />
    <logger
      name="*"
      minlevel="Debug"
      writeTo="console" />
    <logger
      name="*"
      minlevel="Trace"
      writeTo="file" />
  </rules>
</nlog>

Более подробую информацию по конфигурированию логирования можно получить на сайте https://github.com/nlog/NLog/wiki.

Раздел targets – описание правил формирования файлов логов.

Атрибут Описание
name Имя правила.
xsi:type

Тип сохраняемого результата:

  • File – файл
layout Шаблон формирования сообщений.
deleteOldFileOnStartup Удалять или нет предыдущий файл при запуске.
concurentWrites Включает поддержку оптимизированных параллельных записей в один и тот же файл журнала из нескольких процессов на одном компьютере.
keepFileOpen Следует ли держать файл открытым или открывать и закрывать его при каждом событии.
archiveAboveSize Размер в байтах, больше которого файлы журнала будут автоматически архивироваться.
enableArchiveFileCompression Указывает, следует ли сжимать архивные файлы в zip.
fileName Имя файла и путь его сохранения.

Раздел rules – описание правил записи сообщений.

Атрибут Описание
name Имя библиотеки, от которой поступают сообщения.
minlevel Минимальный уровень выводимых сообщений.
maxlevel Максимальный уровень выводимых сообщений.
writeTo Имя правила формирования логов, куда следует сохранять сообщения: значение атрибута name в разделе targets.

Настроенные для формирования по расписанию задания хранятся в схеме quartz базы данных, параметры подключения к которой находятся в конфигурационном файле.

В версиях Alpha.Reports до 1.1.3.xxx настройки заданий хранились в файле формата XML. Если путь к нему указан в параметре Jobs конфигурационного файла, и файл существует, при запуске Alpha.Reports будет проведена миграция заданий и триггеров из файла в БД. После этого файл будет удалён.

Если нужно при формировании отчётов по расписанию отправлять их по списку электронных адресов, требуется сконфигурировать работу сервера отчётов.Для этого в файле appsettings.json в разделе Application/SMTP заполните параметры:

  • Address – адрес smtp-сервера.
  • Port – порт для подключения, по умолчанию 25.
  • Login – почтовый адрес (полный), с которого будет осуществляться рассылка.
  • Password – пароль для подключения к smtp-серверу.

После перезагрузки Alpha.Reports, если произошло успешное подключение к SMTP-серверу, то в файле будут зашифрованы все параметры поля SMTP:

"SMTP": "fYgWghLveu7GkoYJwg4HKj 7STwertrewgQNc2QP9fwP9Jcm2XbJ7wl74obpxBg4 1YnF6BuULW1MudsgdsgXULQ+gJ1Zn0DHqyGeFBQ==”

Чтобы изменить параметры подключения к БД или SMTP серверу, структуру полей нужно будет восстановить.