В этой статье:

Автоматическое создание файла Scheduler.xml

Структура файла Scheduler.xml

Раздел Metabases

Раздел настроек репозитория

Раздел LogonData

Раздел Credentials

Раздел TaskContainer

Раздел LOG

Раздел Host

Настройка конфигурации планировщика задач

Для работы планировщика задач должен содержаться файл конфигурации Scheduler.xml в папке с приложением Scheduler:

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

Примечание. Убедитесь, что в реестре или файле Metabases.xml заданы параметры подключения к репозиториям, в которых содержатся контейнеры запланированных задач, указанные в файле Scheduler.xml.

В ОС Windows при изменении файла Scheduler.xml обновите настройки планировщика задач:

Автоматическое создание файла Scheduler.xml

Для автоматического создания файла Scheduler.xml из контейнера запланированных задач выполните действия:

  1. Нажмите кнопку «Параметры запуска» в главном меню. После выполнения действия будет открыто окно «Параметры запуска»:

  1. Задайте параметры подключения к базе данных:

Примечание. Актуально только в ОС Windows.

  1. Нажмите кнопку «Скачать».

После выполнения действий файл Scheduler.xml будет сохранён в папку загрузок. Переместите полученный файл в папку с приложением Scheduler.

Структура файла Scheduler.xml

Файл Scheduler.xml должен состоять из раздела <Metabases>, содержащего список репозиториев. Настройки каждого репозитория задаются в разделе, название которого соответствует идентификатору репозитория. Для каждого репозитория создаются разделы <LogonData>, <Credentials>, <TaskContainer>, <LOG>, <Host>.

Примечание. Раздел Host является обязательным, если в параметрах задач контейнера настроена отправка сообщений по электронной почте или сохранение файла на FTP-сервер. Разделы Host и LOG не создаются автоматически. Если в настройках файла конфигурации планируется более одного подключения к репозиторию, то настройки в разделах Host и LOG считаются с первого подключения и используются для всех последующих.

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

Пример файла Scheduler.xml, созданного автоматически:

<Metabases>
  <REPOSITORY_ID Name="REPOSITORY_ID" Authentication="1" Driver="POSTGRES" Package="STANDARDSECURITYPACKAGE" DebugMode="0">
    <LogonData CASESENSITIVE="true" DATABASE="DATABASE_NAME" SERVER="SERVER_NAME"/>
    <Credentials Authentication="6">
      <Key Name="Item0" Realm="SCHEDULER" Crs="U2FsdGVkX19I8RM+TgNiRH70x+/ja0KUcPbHf8k3eeEGYZvE7qb16mHBUP9u6gCzEHzhSl4Yvh/+jsrVWwZ8r3BAw60yRh8+CCeU0Tr+wDLbouvJOqn2DGECH8LbZ9ZFK5pBwNXngon2ObKNVI89T9GNVU6Cygo7skyMFoMtpP8DOmVbfH4tazQBRN16a5rToirnkQ4/OaWxWnBVrTTQq8tf8c0KZWfddVgxYFD4+kuo7REbHLK9wcL1u6jg7RfagLa7M6YxDanigidFiBq755PQr25eS7zdZ9CnUe4+SVSYBgQzdvp0HT3RPZKy9hceoogZ4tpky7NABsn0Cx34OdOtJcDBLCDwEKVC8wKJydeXDeJoqMrIqg85u1D2H0JI+ycR0yPMdrIjj8Ejql8tKYwpyHHZUFay7yla5kL8PuI7OF//I2VQruHrihuRHCaKEv8WyEG/ocPT5TF39/RB+ZcD6QwTXINhlYmdrWF5Lqk=" Crsa="KDFLCIAGNELIGOAEHECOJDBPLBKMIIMELLDPDEEPONGAACNM://gos"/>
    </Credentials>
    <TaskContainer KEY="430979" ID="TASK_CONTEINER" RestartSecs="30"/>
  </REPOSITORY_ID>
</Metabases>

Примеры настроек конфигурации планировщика задач, заданных вручную:

Настройки выполнения задач двух контейнеров, содержащихся в разных репозиториях, которые расположены в одной базе данных

Настройки нескольких планировщиков задач, расположенных на разных компьютерах, для выполнения задач одного контейнера

Раздел Metabases

Раздел представляет собой список репозиториев, а также может содержать собственный набор атрибутов:

Атрибуты Описание
ProcessLocale Значение региональных настроек для планировщика задач.
Если атрибут не задан, то значение региональных настроек будет взято из настроек операционной системы.
UILocale Значение языка интерфейса планировщика задач.
Если атрибут не задан, то значение берётся из языковых настроек «Форсайт. Аналитическая платформа» для текущего пользователя. Если языковые настройки не заданы, то они будут соответствовать значению атрибута ProcessLocale.
ThreadsCount Максимальное количество одновременно выполняемых задач в планировщике задач.
Необходимость ограничения количества выполняемых потоков обусловлена определёнными проблемами на сервере, например, нехваткой памяти, возникающими при одновременном выполнении большого количества задач.
Если атрибут не задан, то работа осуществляется без ограничений.

Раздел настроек репозитория

Настройки каждого репозитория задаются в разделе, название которого соответствует идентификатору репозитория. Данный раздел содержит собственный набор атрибутов и подразделы.

Атрибуты Описание
Name Наименование репозитория.
Authentication

Тип аутентификации:

  • 1. Парольная;

  • 2. Интегрированная доменная;

  • 3. Ролевая.

Примечание. Ролевой тип аутентификации является устаревшим и используется для совместимости с предыдущими версиями.

Driver

Идентификатор СУБД:

  • ORCL8. Oracle;

  • MSSQL2012. Microsoft SQL Server;

  • MSSQL2012ODBC. Microsoft SQL Server (ODBC);

  • POSTGRES. PostgreSQL.

Package

Тип пакета безопасности:

  • STANDARDSECURITYPACKAGE. Стандартный пакет безопасности.

Раздел LogonData

Раздел содержит параметры подключения к репозиторию:

Атрибуты Описание
DATABASE Идентификатор базы данных, к которой будет осуществляться подключение по умолчанию.
SCHEME

Идентификатор используемой схемы по умолчанию. По умолчанию для Microsoft SQL Server используется схема «dbo», а для PostgreSQL - «public». Если при подготовке серверной части СУБД была создана пользовательская схема, которая используется в качестве схемы по умолчанию, то укажите её.

Также идентификатор пользовательской схемы можно указать через точку после идентификатора базы данных в атрибуте DATABASE, например: REPOSITORY_ID.myschema.

SERVER

IP-адрес или DNS-имя, под которым зарегистрирован сервер СУБД с подключаемой базой данных (репозиторий).

Если порт сервера СУБД отличается от порта по умолчанию, то значение атрибута задаётся в формате:

  • для Microsoft SQL Server: <IP-адрес или DNS-имя сервера>,<номер порта>;

  • для PostgreSQL: <IP-адрес или DNS-имя сервера>:<номер порта>.

При использовании СУБД Oracle порт сервера определяется в файле tnsnames.ora.

CASESENSITIVE

Признак учёта регистра при работе с СУБД:

  • true. Регистр учитывается;

  • false. По умолчанию. Регистр не учитывается.

Атрибут доступен, если используется СУБД: Microsoft SQL Server, PostgreSQL.

Примечание. При подготовке серверной части СУБД PostgreSQL параметры задаются в верхнем регистре. Для корректного подключения к СУБД используйте атрибут со значением true.

Раздел Credentials

Раздел содержит параметры учётных данных пользователей, используемых при подключении к базе данных в СУБД:

Атрибуты Описание
Authentication

Тип аутентификации при запуске планировщика задач:

  • 0. При запуске планировщика задач доступен выбор типа аутентификации с помощью окна «Авторизация в БД». Для открытия окна задайте атрибут Ask со значением «1»;

Примечание. Актуально только в ОС Windows.

  • 1. Парольная. Аутентификация пользователя производится при указании имени пользователя в атрибуте USER и пароля в атрибуте PASSWORD;

  • 2. Интегрированная доменная. Аутентификация пользователя производится с использованием доменного имени пользователя и пароля (текущей учётной записи ОС). Если тип аутентификации выбран для Oracle в ОС Windows, то выполните дополнительные настройки сервера.

Важно. При использовании интегрированной доменной аутентификации не требуется указание атрибутов USER и PASSWORD.

  • 4. Доменная. Аутентификация пользователя производится одним из способов:

    • при указании домена, имени пользователя в атрибуте USER и пароля в атрибуте PASSWORD;

    • при указании домена, имени пользователя и пароля в зашифрованном виде в атрибутах Crs, Crsa. Для получения учётных данных пользователя в зашифрованном виде используйте утилиту PP.Util с параметром encrypt_creds. Атрибуты Crs, Crsa задаются в отдельном разделе Key.

  • 6. Парольная с шифрованием регистрационных данных. Аутентификация пользователя производится при указании имени пользователя и пароля в зашифрованном виде в атрибутах Crs, Crsa. Для получения учётных данных пользователя в зашифрованном виде используйте утилиту PP.Util с параметром encrypt_creds. Атрибуты задаются в отдельном разделе Key.

USER Имя пользователя. Атрибут используется для парольной/доменной аутентификации, если атрибут Authentication задан со значением «1»/«4».
PASSWORD Пароль пользователя. Атрибут используется для парольной/доменной аутентификации, если атрибут Authentication задан со значением «1»/«4».
Ask

Признак запроса имени пользователя и пароля при запуске планировщика задач:

  • 1. Запрашивать имя пользователя и пароль с помощью окна «Авторизация в БД», если атрибут Authentication задан со значением «0». В момент запуска планировщика задач при запросе имени пользователя и пароля доступно использование доменной авторизации.

Если атрибут не задан, то имя пользователя и пароль при авторизации не запрашиваются.

Примечание. Актуально только в ОС Windows.

Раздел Key

Раздел содержит параметры доменной/парольной аутентификации с шифрованием регистрационных данных, если атрибут Authentication задан со значением «4»/«6»:

Атрибуты Описание
Name Наименование набора параметров. Допустимые значения: «Item0», «Item1», ... , «ItemN». Где N - порядковый номер набора параметров.
Realm Область действия учётных данных - планировщик задач. Допустимое значение: SCHEDULER.
Crs, Crsa Учётные данные пользователя в зашифрованном виде, полученные с помощью утилиты PP.Util с параметром encrypt_creds.

Раздел TaskContainer

Раздел содержит параметры контейнера запланированных задач:

Атрибуты Описание
KEY Ключ контейнера запланированных задач в указанном репозитории.
ID Идентификатор контейнера запланированных задач в указанном репозитории.
RestartSecs Интервал проверки контейнера запланированных задач в секундах. По умолчанию планировщик задач проверяет наличие задач каждые 5 минут.

Раздел LOG

Раздел содержит параметры ведения журнала операций:

Атрибуты Описание
Logging

Признак ведения журнала операций:

  • 1. Журнал операций ведётся;

  • 0. Журнал операций не ведётся.

File Имя файла, в котором будет вестись журнал операций.
Если атрибут не задан, то по умолчанию будет использоваться файл Scheduler.log. Файл журнала операций располагается в папке с установленным продуктом «Форсайт. Аналитическая платформа».
MaxRecordCount Максимальное количество записей в журнале операций.
Если атрибут не задан, то по умолчанию устанавливается максимальное количество записей в журнале операций равное 10 000 000.

Если раздел не задан, то логирование не выполняется.

Раздел Host

Раздел необходим, если в параметрах задач контейнера настроена отправка уведомлений по электронной почте или публикация результата выполнения задачи на FTP-сервере.

Примечание. Отправка уведомлений по электронной почте доступна только для задач, выполняемых по расписанию. При запуске задач вручную сообщения не отправляются.

Раздел Mail

Раздел содержит параметры подключения к электронной почте:

Атрибуты Описание
Host Сервер для отправки сообщений по электронной почте.
Port Номер порта для электронной почты.
From Электронный почтовый адрес, который будет указан как отправитель.
EnableSsl

Признак использования SSL-шифрования для отправки сообщений через внешние почтовые серверы:

  • 1. Используется;

  • 0. Не используется.

Раздел Ftp

Раздел содержит параметры подключения к FTP-серверу:

Атрибуты Описание
Agent Имя приложения, которое используется для подключения к FTP-серверу.
AccessType

Тип требуемого доступа:

  • 0. Используются настройки реестра;

  • 1. Используется сеть Интернет;

  • 2. Используется прокси-сервер.

ProxyName Имя прокси-сервера. Указывается, если атрибут AccessType задан со значением «2».
Раздел Credentials

Раздел используется, если сервер исходящей почты запрашивает авторизацию.

Атрибуты Описание
USER Имя пользователя для авторизации на сервере исходящей почты.
Если в атрибуте USER встречается символ «\», то до символа указывается домен, после – имя пользователя.
PASSWORD Пароль пользователя для авторизации на сервере.
Ask

Признак запроса имени пользователя и пароля при авторизации:

Если атрибут не задан, то имя пользователя и пароль при авторизации не запрашиваются, а используются указанные данные в атрибутах USER и PASSWORD.
AuthProtocol Протокол аутентификации на SMTP-сервере. В качестве значения параметра указывается один из протоколов, которые поддерживает SMTP-сервер, с которым осуществляется работа. Например, PLAIN, LOGIN и другие. Список поддерживаемых протоколов можно получить, изучив параметры конкретного SMTP-сервера. Если протокол неизвестен, то укажите пустую строку. В этом случае SMTP-сервер сам выберет, каким образом будет осуществляться аутентификация пользователя.
Если атрибут не задан, то аутентификация на SMTP-сервере будет осуществляться по протоколу LOGIN.
Раздел MailTo

Раздел используется для отправки письма на указанную электронный почтовый адрес при подключении к репозиторию.

Атрибут Описание
Mail Электронный почтовый адрес, на который будет отправлено письмо при подключении к репозиторию. Письмо будет содержать информацию об удачном/неудачном подключении. Также на данный адрес будут отправляться сообщения об ошибках, не связанных с выполнением задач.

См. также:

Установка планировщика задач