Extending Configuration File Manually

Extension of the Scheduler.xml configuration file is required if on automatic creation of configuration file the required sections in structure were not created.

To extend configuration file manually:

1. Open the Scheduler.xml file for edit, which is located:

• In the /opt/foresight/fp10.x-biserver/etc folder in Linux OS.

• Next to the Scheduler.exe scheduler's executable file in the folder C:\Program Files\Foresight\Analytics Platform 10.x in Windows OS.

2. Make necessary changes based on configuration file structure an description of sections.

3. Make sure that the registry or in the Metabases.xml has configured connection parameters for the repositories, which contain scheduled tasks containers specified in the Scheduler.xml file.

4. Save the file and refresh task scheduler settings.

Scheduler.xml Configuration File Structure

The Scheduler.xml file should contain the <Metabases> section with a list of repositories. Each repository settings are set in the section, which name corresponds to repository identifier. The following sections are created for each repository: <LogonData>, <Credentials>, <TaskContainer>, <LOG>, <Host>.

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

The Scheduler.xml file may contain settings for starting one or several scheduled tasks containers. Make sure that the following conditions are satisfied:

• The container is set up for start only in one task scheduler. Use of several task schedulers for starting the same container is not allowed.

• Starting several containers in the same task scheduler should be executed in one database.

The example of the Scheduler.xml file with startup settings for two task containers contained in different repositories located in the same database:

• Task container with the TASK_CONTEINER_1 identifier in the REPOSITORY_ID repository.

• Task container with the TASK_CONTEINER_2 identifier in the WAREHOUSE repository.

<Metabases ThreadsCount="10" ProcessLocale="1033" UILocale="1033">
  <REPOSITORY_ID Name="REPOSITORY_ID" Authentication="1" Driver="POSTGRES" Package="STANDARDSECURITYPACKAGE">
    <LogonData DATABASE="DATABASE_NAME" SERVER="SERVER_NAME" />
    <Credentials Authentication="1" USER="User1" PASSWORD="Password1" />
    <TaskContainer KEY="430979" ID="TASK_CONTEINER_1" 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>
  </REPOSITORY_ID>
  <WAREHOUSE Name="WAREHOUSE" Authentication="1" Driver="POSTGRES" Package="STANDARDSECURITYPACKAGE">
    <LogonData DATABASE="DATABASE_NAME" SERVER="SERVER_NAME" />
    <Credentials Authentication="1" USER="User2" PASSWORD="Password2" />
    <TaskContainer KEY="637482" ID="TASK_CONTEINER_1" RestartSecs="300" />
  </WAREHOUSE>
</Metabases>

The Metabases Section

The section is a list of repositories and may also contain a proper set of attributes:

Attributes	Description
ProcessLocale	Regional settings value for task scheduler. If this attribute is not set, the value of regional settings is obtained from regional settings of the operating system.
UILocale	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	The maximum number of tasks running simultaneously in 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 the attribute is not set, the number of threads is not restricted.

Repository Settings Section

Each repository settings are set in the section, which name corresponds to repository identifier. This section includes a proper set of attributes and subsections.

Attributes	Description
Name	Repository name.
Authentication	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	DBMS identifier: ORCL8 - Oracle. MSSQL2012 - Microsoft SQL Server. MSSQL2012ODBC - Microsoft SQL Server (ODBC). POSTGRES - PostgreSQL. SQLITE - SQLite.
Package	Security package type. STANDARDSECURITYPACKAGE. Standard security package.
DL	Lazy loading of descriptors: true. Lazy loading of repository object descriptors is executed during repository connection. false. Default value. Lazy loading of repository object descriptors is not executed during repository connection. For details about features of lazy loading of descriptors see the Setting Up Repository Connection subsection.

The LogonData Section

The section contains repository connection parameters:

Attributes	Description
DATABASE	Identifier of the database, to which the default connection is executed. It is specified when working with one of the DBMS: PostgreSQL, Microsoft SQL Server.
FILENAME	Name of file with database connection settings. It is specified when working with SQLite DBMS.
ODBCPARAMS	Additional parameters of repository connection using the Connection String parameter. It is specified when working with Microsoft SQL Server DBMS.
SERVER	IP address or DNS name of the DBMS server with connected database. It is specified when working with one of the DBMS: Oracle, PostgreSQL, Microsoft SQL Server.
SCHEME	Name of the schema, in which a repository is created. It is specified when working with Oracle DBMS.

For details about latest DBMS versions, see the Supported DBMS subsection.

The Credentials Section

The section contains user credentials saving parameters used during database connection:

Attributes	Description
Authentication	Type of authentication in the repository at task scheduler start: 0. Password authentication is used in Linux OS. When starting task scheduler in Windows OS, one can select authentication type in the Database Authorization dialog box. 1. Password. The user is authenticated if user name is specified in the USER attribute and password is specified in the PASSWORD attribute. 2. Integrated domain. The user is authenticated by means of specifying domain user name and password explicitly (of the current operating system account). If authentication type is selected for Oracle in Windows OS, determine advanced server settings. 4. Domain. The user is authenticated if domain and user name are specified in the USER attribute and password is specified in the PASSWORD attribute. The authentication type is available if the driver type is selected: Oracle, Microsoft SQL Server, Microsoft SQL Server (ODBC), PostgreSQL. 6. Password with credentials encryption. The user is authenticated if user name is specified in the USER attribute and password is specified in the PASSWORD attribute. The specified user name and password are encrypted.
USER	User name for password/domain authentication.
PASSWORD	User password for password/domain authentication.
Ask	Indicates whether user name and password should be requested during authentication 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

The section contains task container parameters:

Attributes	Description
KEY	Key of task container in the specified repository.
ID	Task container identifier in the specified repository.
RestartSecs	Interval for task container check (in seconds).

The LOG Section

The section contains operation log parameters:

Attributes	Description
Logging	Indicates whether operation log is used: 1. Operation log is used. 0. Operation log is not used.
File	Operation log file name. If the attribute is absent, the Scheduler.log file is used by default. The log file is located in the folder with installed Foresight  Analytics Platform.
MaxRecordCount	The maximum number of records 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.

If the section is not set, logging is not executed.

The Host Section

The section is required if container task parameters are set up to send email messages or to save file to FTP server.

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

The Mail Section

The section contains email connection parameters:

Attributes	Description
Host	Server for sending email messages.
Port	The number of the email port.
From	Email address, which is specified as the sender.
EnableSsl	Indicates whether SSL encryption is required for sending messages via external mail services: 1. In use. 0. Not in use.

The Ftp Section

The section contains FTP server connection parameters:

Attributes	Description
Agent	Name of the application that is used to connect to FTP server.
AccessType	Required access type: 0. Registry settings are used. 1. The Internet is used. 2. Proxy is used.
ProxyName	Proxy server name. It is specified if the AccessType attribute is set to 2.

The Credentials Section

This section is required if outgoing mail server requests authorization.

Attributes	Description
USER	User name for authorization on outgoing mail server. 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	User password for server authorization.
Ask	Indicates whether user name and password are requested during authorization: 1. Show authorization dialog box on the outgoing mail server. If this attribute is absent, user name and password are not requested during authorization, and the data specified in the USER and PASSWORD attributes is used.
AuthProtocol	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	Description
Mail	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.