You are using an outdated browser. For a faster, safer browsing experience, upgrade for free today.

Файл конфигурации системы

В файле конфигурации содержатся следующие настройки:

  1. PORT — порт, который система занимает при старте.
  2. PROTOCOL — протокол передачи данных HTTP, или защищенный протокол HTTPS.
  3. PATH_HTTPS_KEY — директория, где хранится ключ для HTTPS.
  4. PATH_HTTPS_CERTIFICATE — директория, где хранится сертификат для HTTPS
  5. Директории, где хранятся ключ и сертификат для HTTPS, необходимо указать только если выбран соответствующий протокол передачи данных. В случае если указан протокол HTTP, поля ключа и сертификата игнорируются.
  6. DB_DIR — директория, где хранится база данных системы.
  7. Пути к директориям ключа, сертификата и базы данных системы указываются, обязательно, начиная с корневого каталога (полный путь) и с использованием «\\», как знака разделения каталогов, которые составляют путь к файлу, и без пробелов.

    Например: D:\\office-work-place\\dev-place\\db

    Если директория для базы данных указывается – системная (без вложенной папки), тогда необходимо запускать систему с помощью пользователя с правами администратора.

    Путь к папке с базой данных, которая хранится на удаленном компьютере имеет следующий формат: \\\\ip-address remote\\path, где
    • ip-address remote — ip-адрес удаленного компьютера;
    • path — полный путь к папке с базой данных (к папке обязательно должен быть открыт доступ).
    Пример: \\\\192.168.0.221\\office-work-place\\dev-place\\db
  8. LOG_LANGUAGE — язык для системных сообщений, которые будут также отображаться в системном журнале.
  9. Язык системных сообщений, по умолчанию, английский, изменить его можно только в данной строке.
  10. *_LOG_LEVEL — уровни логирования для разных модулей системы.
  11. Конфигурационный файл должен называться – config.json и быть в формате JSON. Файл должен находится в той же папке с которой запускается система.
  12. SYS_LOG_TO_FILE — автоматическое сохранение системных сообщений в папку logs, в папку с которой запускается система (true – сообщения сохраняются, false – не сохраняются).
  13. WS_PORT_START — начальное значение диапазона портов, для подключения фотоверификации.
  14. WS_PORT_END — конечное значение диапазона портов.
  15. При необходимости подключения к конкретному порту, и начальное и конечное значение диапазона должно совпадать. Например: WS_PORT_START: 3001, WS_PORT_END: 3001
  16. FOTOVERIFICATION_RECONECT_FRONT_TIME — время, в миллисекундах, через которое интерфейс фотоверификации должен переподключиться к порту, в случае разрыва соединения.
  17. CLOSE_TERMINATE_OFF
  18. DEF_RTU_TIMER_MS — время тишины на шине RS-485
  19. MIGRATION_DIRECTION — направление миграции базы данных.
  20. MIGRATION_VERSION — версия базы данных, которая необходима пользователю.
  21. TCP_CLIENT_WRITE_TIME_OUT — время таймаута записи в контроллер, для устройств в режиме CLIENT.
  22. TCP_SERVER_WRITE_TIME_OUT — время таймаута записи в контроллер, для устройств в режиме SERVER.

Если конфигурационный файл не будет найден – система создает его с настройками по умолчанию:

  • port — 5870;
  • protocol — http;
  • path_https_key — «-»;
  • path_https_certificate — «-»;
  • db_dir — будет создана папка db в директории откуда запускается система;
  • log_language — «en»;
  • *_log_level — 2;
  • sys_log_to_file — true;
  • ws_port_start — 3000;
  • ws_port_end — 3010;
  • fotoverification_reconect_front_time — 2;
  • close_terminate_off — true;
  • def_rtu_timer_ms — 150;
  • migration deriction — up;
  • migration version — last;
  • tcp_client_write_time_out — 3001;
  • tcp_server_write_time_out — 3001.

При создании файла конфигурации, по умолчанию, устанавливаются уровни логирования «2», но в случае, если пользователь неправильно укажет уровень логирования или название модуля, тогда «5»

Пример содержания конфигурационного файл:

{

    • PORT: 5870
    • PROTOCOL: «http»
    • PATH_HTTPS_KEY: «-»
    • PATH_HTTPS_CERTIFICATE: «-»
    • DB_DIR: «./db»
    • LOG_LANGUAGE: «en»
    • DEVICE_MNG_LOG_LEVEL: 2
    • CONVERTER_LOG_LEVEL: 2
    • CONTROLLER_LOG_LEVEL: 2
    • CONTROLLER_ROUTE_LOG_LEVEL: 2
    • CONTROLLER_MANAGER_LOG_LEVEL: 2
    • GUARD_PROTOCOL_LOG_LEVEL: 2
    • EMPLOYEE_MANGEMENT_HANDLER_LOG_LEVEL: 2
    • ROUTES_LOG_LEVEL: 2
    • MODELS_LOG_LEVEL: 2
    • SYSTEM_SETTINGS_LOG_LEVEL: 2
    • ACCESS_GATE_WAY_LOG_LEVEL: 3
    • SYSTEM_LOG_CLASS_LOG_LEVEL: 5
    • UDP_CLINET_LOG_LEVEL: 2
    • SYS_LOG_TO_FILE: true
    • LOG_CLASS_LOG_LEVEL: 2
    • WS_PORT_START: 3000
    • WS_PORT_END: 3010
    • FOTOVERIFICATION_RECONECT_FRONT_TIME: 2
    • CLOSE_TERMINATE_OFF: true
    • DEF_RTU_TIMER_MS: 250
    • MIGRATION_DIRECTION: «up»
    • MIGRATION_VERSION: «last»
    • CONVERTER_POLLING_INERVAL: 101
    • TCP_CLIENT_WRITE_TIME_OUT: 10000
    • TCP_SERVER_WRITE_TIME_OUT: 10000
    • DEF_GET_SERIAL_CONTROLLER_TIMOUT_MS: 3001
}

Значения уровней логирования:
  1. Только критические события
  2. Вывод всех ошибок
  3. Вывод предупреждений
  4. Вывод информационных сообщений
  5. Вывод сообщений для отладки
  6. Вывод всех видов сообщений
Уровни логирования имеют вложенность, то есть при уровне логирования «3» - будут выводиться сообщения, которые соответствую уровням «1», «2» и «3».
Начиная с версии V1.3.0.3 введены дополнительные параметры конфигурации (MIGRATION_DIRECTION и MIGRATION_VERSION), которые необходимы для поддержки мягкого перехода с одной версии на другую. Подробную информацию о миграции см. раздел Миграция.