Расширение конфигурационного файла вручную

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

Структура конфигурационного файла

Раздел <Metabases>

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

Раздел <LogonData>

Раздел <Credentials>

Раздел <TaskContainer>

Раздел <LOG>

Раздел <HOST>

Раздел <Mail>

Раздел <Ftp>

Раздел <Credentials>

Раздел <MailTo>

Раздел <SPCredentials>

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

Для расширения конфигурационного файла вручную выполните шаги:

  1. Откройте конфигурационный файл в любом текстовом редакторе.

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

  3. Сохраните конфигурационный файл в формате .xml и обновите настройки планировщика задач.

Структура конфигурационного файла

Конфигурационный файл со всеми возможными настройками для одного контейнера задач выглядит следующим образом:

<Metabases ThreadsCount = "10" ProcessLocale = "1033" UILocale = "1033">

<TEST Name="TEST" Authentication="1" Driver="ORCL8" Package="STANDARDSECURITYPACKAGE" DebugMode="1">

<LogonData SCHEME="TEST" SERVER="TEST" />

<Credentials Authentication="1" USER="User1" PASSWORD="Password" />

<TaskContainer ID="MY_TASK_CONTEINER" RestartSecs="300"/>

<LOG Logging="1" File = "File.log" MaxRecordCount = "1000"/>

<Host>

<Mail Host="mail.example.com" Port="0" From="user1@example.com" />

<Ftp Agent="prognoz application server" AccessType="0" ProxyName="" />

<Credentials USER="domain\user" PASSWORD="password" Ask="1"/>

<MailTo Mail="admin@example.com"/>

<SPCredentials SAME="0" USER="domain\user" PASSWORD="<password>"/>

</Host>

</TEST>

</Metabases>

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

Дочерние элементы раздела <Metabases> содержат информацию о подключении к репозиториям, настройках почтового сервера, настройках планировщика задач и др.

Раздел <Metabases>

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

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

Раздел настроек репозитория может иметь произвольное наименование. При автоматическом создании конфигурационного файла название раздела будет соответствовать идентификатору репозитория. В приведенном выше примере конфигурационного файла данный раздел имеет название «TEST». Данный раздел содержит несколько подразделов.

Атрибут Краткое описание

Name

 Задаёт наименование репозитория.

Authentication

Задаёт тип аутентификации:

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

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

  • 3. Ролевая.

Driver

Задаёт тип используемого драйвера:

  • ORCL8 - Oracle;

  • MSSQL2008 - Microsoft SQL Server 2008;

  • MSSQL2012 - Microsoft SQL Server 2012\2014\2016;

  • MSSQL2012ODBC - Microsoft SQL Server (ODBC);

  • TRDT - Teradata;

  • POSTGRES - PostgreSQL;

  • SQLITE - SQLite.

Совет. Для получения подробной информации о поддерживаемых версиях СУБД обратитесь к статье «Поддерживаемые СУБД»

Package

 Задаёт пакет безопасности.

DebugMode

 

Определяет признак использования кэширования сборок на локальном диске:

  • 0. Без кэширования;

  • 1. Кэширование сборок.
DL

Определяет авторизацию с отложенной загрузкой дескрипторов:

  • FALSE (по умолчанию). Отложенная загрузка выключена.

  • TRUE. Отложенная загрузка включена.

Раздел <LogonData>

Атрибут Краткое описание
Server Задаёт наименование сервера СУБД, на котором расположен репозиторий. Указывается при работе с одной из СУБД: Oracle, Teradata, PostgreSQL, Microsoft SQL Server.
Scheme Задаёт наименование схемы, в которой создан репозиторий. Указывается при работе с одной из СУБД: Oracle, PostgreSQL.
Database Задаёт наименование схемы, в которой создан репозиторий. Указывается при работе с одной из СУБД: Microsoft SQL Server, Teradata.
FileName Задаёт наименование файла базы данных. Указывается при работе с СУБД SQLite.

Список актуальных версий СУБД, с которыми поддерживается работа, представлен в подразделе «Поддерживаемые СУБД».

Раздел <Credentials>

Атрибут Краткое описание
Authentication

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

  • 0. Тип авторизации выбирается в момент запуска;

  • 1. Парольная авторизация;

  • 2. Доменная авторизация;

  • 6. Парольная с шифрованием регистрационных данных.
USER Задаёт имя пользователя для парольной авторизации.
PASSWORD Задаёт пароль пользователя для парольной авторизации.
Ask

Определяет, запрашивать ли имя пользователя и пароль при авторизации в репозитории:

  • 1. Запрашивать имя пользователя и пароль. Будет открыт диалог авторизации. Если тип авторизации выбирается в момент запуска планировщика задач, то при запросе имени пользователя и пароля будет возможно использовать доменную авторизацию.

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

Раздел <TaskContainer>

Атрибут Краткое описание
ID Задаёт идентификатор контейнера задач в указанном репозитории.
RestartSecs Задаёт интервал проверки контейнера задач в секундах.

Раздел <LOG>

Журнал операций ведется, если в конфигурационном файле содержится данный подраздел.

Атрибут Краткое описание
Logging

Определяет, будет ли вестись журнал операций:

  • 1. Вести;

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

Раздел <HOST>

Раздел <HOST> необходим, если в параметрах задач контейнера настроена отправка сообщений по электронной почте.

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

Раздел <HOST> содержит несколько подразделов.

Раздел <Mail>

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

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

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

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

Раздел <Ftp>

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

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

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

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

  • 2. Используется прокси.
ProxyName Задаёт имя прокси-сервера.

Раздел <Credentials>

Данный элемент необходим, если сервер исходящей почты запрашивает авторизацию.

Атрибут Краткое описание
USER Задаёт имя пользователя для авторизации.
Если в атрибуте USER встречается знак «\», то до знака указывается домен, после – имя пользователя.
PASSWORD Задаёт пароль пользователя для авторизации на сервере.
Ask

Определяет, запрашивать ли имя пользователя и пароль при авторизации:

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

Раздел <MailTo>

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

Раздел <SPCredentials>

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

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

Атрибут Краткое описание
SAME

Определяет, использовать ли указанные учетные данные:

  • 0. Используются учетные данные, указанные в атрибутах USER и PASSWORD данного подраздела;

  • 1. Используются учетные данные, указанные в подразделе «Credentials» раздела «HOST».
USER Задаёт имя пользователя для авторизации.
Если в атрибуте USER встречается знак «\», то до знака указывается домен, после – имя пользователя.
PASSWORD Задаёт пароль пользователя для авторизации на сервере.

См. также:

Конфигурационный файл