Working with ELMA configuration files

Configuration files allow setting up the system parameters without recompiling. In addition, using configuration files, administrators can determine policies that affect the execution of applications on specific computers. The configuration file consists of elements, which are logical data structures that define the configuration information. By default, the system configuration file is stored in the ELMA directory, UserConfig folder, named configuration.config. 

The configuration file is critical for the system functioning. Only you are responsible for all the changes you make to it; errors in the configuration file make the system not functional and may have irreversible consequences.

Configuration for MS SQL

Working with the database:

The <configuration> tag contains all the system configuration data.  

  • The <add name="MainDB" connectionString="Data Source=(local);Initial Catalog=first;Integrated Security=true;"/> string defines the database to connect to.
  • The Integrated Security parameter is responsible for verifying Windows. If this parameter is set to true, then the account, on whose behalf the ELMA server is running will be used for authentication on MS SQL Server. If the Integrated Security is set to false, authentication on MS SQL Server is performed using the account specified in the configuration file as follows (a connection string example): <add name="MainDB" connectionString="Data Source=(local);Initial Catalog=ELMA3;Integrated Security=false;User ID=UserName;Password=pass"/>
  • The Data Source parameter defines the server name. The Initial Catalog parameter defines the name of the MS SQL database.
  • In this example, the database file name is "first". If you have several databases, you can change the database file name in the Initial Catalog parameter and restart the ELMA web server.

The <main connectionStringName="MainDB" type="EleWise.ELMA.Extensions.MSSQL.MSSQLProvider, EleWise.ELMA.Extensions.MSSQL" backupEnabled="false" commandTimeOut="1000"/> string defines whether backing up is required when starting the server and sets the MS SQL response timeout. 

  • The commandTimeOut parameter defines the MS SQL server response timeout. You can assign any value in seconds; the default value is 30 seconds. To learn more about configuring server response, follow this link.
  • The backupEnabled parameter is responsible for backup copying. It can have the following values:

           1) false – a backup copy is not created when starting the server. When backing up is disabled, you can skip the backup path.

           2) changed to backupPath  -  means that the backupEnabled parameter is ommited, its default value (true) is used, backup copies are created. The backupPath parameter defines the path to the storage for backup copies. If it is empty, the backup copies are saved to the folder, specified in the MS SQL Server settings. By default, ~\Program Files\Microsoft SQL Server\MSSQL10_50.MSSQLSERVER\MSSQL\Backup.

           3) A path is specified in the backupPath parameter – means that backup copies will be saved to the specified directory.

Working with the file storage:

In the <add name="FSProvider" type="EleWise.ELMA.Runtime.Providers.Impl.FileSystemFileStoreProvider, EleWise.ELMA.SDK" filesPath="Files"/> string, you can specify an alternative path to the Files folder. By default, this folder is in the ELMA directory, UserConfig folder. You can type the full path to a Files folder in the filesPath parameter, and the files will be saved to this folder, e.g.:  C:\ELMA3-Standard\Files

If you use a network path as a file storage, you must specify the full network path to the folder, e.g. \\server\folder. And make sure that the user, on whose behalf ELMA server is running, has access to the specified folder.

Configuration for Firebird:

The <configuration> tag contains all the system configuration data. 

Working with the database:

The <add name="MainDB" connectionString="Data Source=127.0.0.1;Initial Catalog={CONFIGDIR}\ekon.fdb;User ID=sysdba;Password=masterkey;Port=3056;Dialect=3;ServerType=0"/> string defines database connection settings.

  • The Data Source parameter contains the server address.
  • The Initial Catalog parameter contains the Firebird database name, with the database file directory in brackets (you can specify a path to a file instead of CONFIGDIR).  
  • The User ID parameter contains the database username, and the Password parameter - the user password.
  • The Port parameter contains the Firebird connection port.
  • The ServerType parameter indicates the server type. For the system to function, the ServerType must be 0.

Working with the file storage:

In the <add name="FSProvider" type="EleWise.ELMA.Runtime.Providers.Impl.FileSystemFileStoreProvider, EleWise.ELMA.SDK" filesPath="Files"/> string, you can specify an alternative path to the Files folder. By default, this folder is in the ELMA directory, UserConfig folder. You can type the full path to a Files folder in the filesPath parameter, and the files will be saved to this folder, e.g.:  C:\ELMA3-Community\Files

If you use a network path as a file storage, you must specify the full network path to the folder, e.g. \\server\folder. And make sure that the user, on whose behalf ELMA server is running, has access to the specified folder.

In a similar way, you can move the Preview folder to another server, having specified the full path to it. Specify the full path to the Preview folder, which will store all the preview files in the filesPath parameter.

Working with the connection.config file.

The connection.config file is the same for all the system editions.

The connection.config defines the path to the configuration file. You can specify a new full path to a configuration file in the connectionString parameter in <add name="ConfigurationFile" connectionString="C:\ELMA3-Standard\UserConfig\configuration.config"/>