Extending Configuration File Manually

Configuration file extension is required if on automatic creation of configuration file the required sections in structure were not created.

To extend configuration file manually, follow the steps:

1. Open configuration file in any text editor.

2. Add the required modifications according to the configuration file structure and section description.

3. Save configuration file in the XML format and refresh settings of task scheduler.

Configuration File Structure

A configuration file with all possible settings for one task container looks as follows:

<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 KEY="111111" 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" EnableSsl="1"/>

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

<Credentials USER="domain\user" PASSWORD="password" Ask="0" AuthProtocol="LOGIN"/>

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

</Host>

</TEST>

</Metabases>

NOTE. The <HOST> section is required if the container task parameters are set up to send email messages or to save the file to an FTP server. This section and the <LOG> subsection are not created automatically. If more than one connection to repository is planned in the configuration file settings, settings of the <HOST> section and the <LOG> subsection are read from the first connection and will be used for all next connections.

Child elements of the <Metabases> section contain information on repository connection, email server settings, task scheduler settings, and so on.

The <Metabases> Section

Attribute	Brief description
ProcessLocale	It determines regional settings value for the task scheduler. If this attribute is not set, the value of regional settings is obtained from regional settings of the operating system.
UILocale	It determines the interface language value for the task scheduler. If this attribute is not set, the value is taken from Foresight Analytics Platform language settings for the current user. If language settings are not determined, they match value of the ProcessLocale attribute.
ThreadsCount	It determines the maximum number of tasks running simultaneously at the task scheduler. Restriction of the number of simultaneously running threads is caused by certain server problems, for example, memory shortage, which arise when a large number of tasks are executed at the same time. If this attribute is not set, the number of threads is not restricted.

Repository Settings Section

Repository settings section may have an arbitrary name. When a configuration file is created automatically, the section name matches the repository identifier. In the example of the configuration file given above this section has the name TEST. This section includes several subsections.

Attribute	Brief description
Name	It sets repository name.
Authentication	It sets authentication type: 1. Password. 2. Integrated domain. 3. Role. NOTE. The role authentication type is outdated and is used for compatibility with previous versions.
Driver	It sets the driver type: 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. TIP. For details about supported DBMS versions, see the Supported DBMS subsection.
Package	Sets a security package.
DebugMode	It determines whether assemblies are cached on the local disk: 0. Without caching. 1. Assemblies are cached.
DL	It determines authorization with delayed loading of descriptors: FALSE (by default). Delayed loading is disabled. TRUE. Delayed loading is enabled.

The <LogonData> Section

Attribute	Brief description
Database	It sets name of the schema, in which a repository is created. It is specified when working with one of the DBMS: Microsoft SQL Server, Teradata.
FileName	It sets database file name. It is specified when working with SQLite DBMS.
ODBCPARAMS	It sets additional parameters of repository connection using the Connection String parameter. It is specified when working with Microsoft SQL Server DBMS.
Server	It sets name of the DBMS server containing a repository. It is specified when working with one of the DBMS: Oracle, Teradata, PostgreSQL, Microsoft SQL Server.
Scheme	It sets name of the schema, in which a repository is created. It is specified when working with one of the DBMS: Oracle, PostgreSQL.

The list of latest supported DBMS versions is given in the Supported DBMS subsection.

The <Credentials> Section

Attribute	Brief description
Authentication	It sets a type of authorization in the repository at task scheduler start: 0. Authorization type is selected at the server start. 1. Password authorization. 2. Domain authorization. 6. Password with credentials encryption.
USER	It sets the user name for password authorization.
PASSWORD	It sets the user password for password authorization.
Ask	It determines whether the user name and the password should be requested during user authorization in the repository: 1. Request user name and password. The authorization dialog box opens. If the authorization type is chosen at the scheduler start, you can use domain authorization when the user name and the password are requested. If this attribute is missing, the user name and the password are not requested during authorization.

The <TaskContainer> Section

Attribute	Brief description
KEY	It sets key of task container in the specified repository.
ID	It sets task container identifier in the specified repository.
RestartSecs	It sets the interval for task container check (in seconds).

<LOG> Section

Operations log is maintained if the configuration file contains this section.

Attribute	Brief description
Logging	It determines whether operation log is maintained: 1. Maintain. 0. Do not maintain.
File	Determines a name of the file to maintain operation log. If the attribute is missing, Scheduler.log is used by default. The log file is located in the folder with installed Foresight  Analytics Platform.
MaxRecordCount	It determines the maximum number of entries in the operation log. If the attribute is missing, the maximum number of records in the log equal to 10 000 000 is set by default.

The <HOST> Section

The <HOST> section is required, if in container tasks parameters sending email messages is set up.

NOTE. Sending notifications by email is available only for tasks executed by schedule. On starting tasks manually, messages are not sent.

The <HOST> section includes several subsections.

The <Mail> Section

Attribute	Brief description
Host	It sets the server to send email messages.
Port	It sets the number of the email port.
From	It sets the email address, which is specified as the sender.
EnableSsl	It determines whether SSL encryption is required for sending messages via external mail services: 1. In use. 0. Not in use.

The <Ftp> Section

Attribute	Brief description
Agent	It sets a name of the application that is used to connect to FTP server.
AccessType	It sets access type: 0. Registry settings are used. 1. The Internet is used. 2. Proxy is used.
ProxyName	It sets proxy server name.

The <Credentials> Section

This element is required only if the outgoing mail server requests authorization.

Attribute	Brief description
USER	It sets user name for authorization. If the USER attribute contains the "\" character, the domain name is specified before this character, and the user name is specified after this character.
PASSWORD	It sets user password for server authorization.
Ask	It determines whether user name and the password should be requested during user authorization: 1. Show authorization dialog box on the outgoing mail server. If this attribute is missing, the user name and password are not requested during authorization, and the data specified in the USER and PASSWORD attributes is used.
AuthProtocol	It sets authentication protocol on SMTP server. As a parameter value specify one of the protocols supported by SMTP server, with which the work is executed. For example, PLAIN, LOGIN. and so on. The list of supported protocols can be obtained by studying parameters of specific SMTP server. If there is no information about the protocol, leave the string empty. In this case SMTP server selects how the user is to be authenticated. If this attribute is absent, authentication on SMTP server is executed based on the LOGIN protocol.

The <MailTo> Section

Attribute	Brief description
Mail	It sets the email address, to which a message will be sent on repository connection. This message contains information on whether the connection has been successful or not. Also, messages on errors not related to tasks execution are sent to this address.