Configuration

This functionality is only available, if a E3.enterprise license is present!

How to use the XML-Configuration File

The XML-configuration file configure.xml is used to control different settings regarding the MultiUser-functionality. The XML-configuration file is created by use of the MuSetup program on the project server.

Note

Some predefined setting values may not be changed (see How to use XML-elements)

The following example displays the XML-elements for the XML-configuration file:

<?xml version="1.0" encoding="UTF-8"?>

<Name>SqlServer</Name>

<Dbms>SqlServer</Dbms>

<Name>ConnectDbms</Name>

<Value>Provider=sqloledb;Server=SERVER_NAME;User Id=E3MUDB;Password=start##123;</Value>

</Parameter>

</Parameter>

<Name>ConnectDb</Name>

<Value>%ConnectDbms%Database=%DbName%;</Value>

</Parameter>

<Name>ConnectDbDelete</Name>

<Value>%ConnectDb%OLE DB Services=-2;</Value>

</Parameter>

<Name>DbName</Name>

</Parameter>

<Name>Crypted</Name>

</Parameter>

</Parameters>

</Configuration>

</Configurations>

</Database>

<Admin>

<Name>E3MUADMIN</Name>

</Admin>

<Log>

</Eventlog>

<File>

<Debug>

</Debug>

</File>

</Log>

<DbConfig>SqlServer</DbConfig>

</Project> <Dictionary>

<DbConfig>SqlServer</DbConfig>

<Name>DbName</Name>

<Value>E3DICTIONARY</Value>

</Parameter>

</Parameters>

</Dictionary>

</Database>

</Timeout>

<Cache>

<Path>E:\e3-mu\cache\</Path>

</Cache>

<CompressionLevel>Uncompressed</CompressionLevel>

</Parameters>

<CompressionLevel>Default</CompressionLevel>

</Parameters>

<CompressionLevel>Default</CompressionLevel>

</Parameters>

</Transmission>

<Path>E:\e3-mu\export\</Path>

</Export>

</Transactions>

<Path>E:\e3-mu\export\</Path>

</Journal>

<Check>

</Check>

<BackupPath>E:\e3-mu\backup\</BackupPath>

</ExternalConverter>

</Server>

</E3Multiuser>

How to use XML-Elements

Note

Settings with grey background may not be changed.

Notes on tracing project-related actions

The element <ProjectTracing> for tracing project-related actions can be used within the element <Log> for all child elements (<Eventlog>, <File> and <File_n>).

The following actions are traced together with information on user and timestamp:

Multi-user project opened
Multi-user project closed
Multi-user project created
Multi-user project copied
Multi-user project renamed

Note:

Messages regarding renaming projects are only stored in the multi-user server's log file. The log file of the renamed project does not store who created the project and when.

If tracing is activated, the log file contains information regarding which user did which project-related actions and when.
Tracing messages are stored in <EventLog> with the ID 57004.

Example of format saved message

[8192] [Project Trace ] [30.03.2022 12:03:12] [30196]: User 'JohnDoe' created new project 'Project1'.

XML-Element / Description

<Name>

Name of the configuration

<Dbms>

Database Type (SqlServer or Oracle)

List of parameters of the configuration (<Parameter><Name><Value></Parameter>)

ConnectDbms

Connectstring to connect to the database management system.

Note: Masked spelling for special characters&, <, >, ' and " in the password.

Uid

User name of the user used to create the tables

ConnectDb

Connectstring to connect to the database (differs from ConnectDbms for SQL-Server).

ConnectDbDelete

Connectstring used when deleting projects. (OLE DB Services=-2; disables ADO connection pooling)

DbName

database name (MuService sets this parameter to E3MP<x> database name for the project).

Crypted

Defines whether the password for the multi-user server is encrypted.
0 = the password is not encrypted
1 = the password is encrypted

%<parameter name>% refers to parameter <parameter name>

If these parameters are not contained in the configuration file, the default value is 1, this means without this parameter the server will record all transactions and delete them after export.

Save

0 = transactions are not saved anymore
1 = transactions are saved

ClearAfterExport

0 = transactions remain even after export
1 = all transactions are deleted after export.

Is used to define whether the automatic database downsize shall be activated or not when creating a new SQL-server database with ALTER DATABASE database SET AUTO_SHRINK ON.

0 = automatic database downsize is deactivated.
1 = automatic database downsize is activated.

If no parameter is defined, 1 is valid by default.

Is used to define whether the performance at creation of a Multi-User project shall be accelerated.

0 = no acceleration of performance
1 = Performance will be accelerated

Is used to define the frequency of writing to the database on the sever. It is thus possible to define whether to save less large data packets or more little data packets to the database.

The larger the data packets, the larger the memory required on the client's computer.

When a valid value is defined for <UpdateBatch>, <UsePreparedStatements> from the configuration file is ignored.

Note

When using an Oracle database system, it is recommended to use <UsePreparedStatements>.

Define a value between 2 and 4294967295, to determine the size of the data packets in kilobyte.

The value 65536 is suitable for most use cases.

first port number used for projects servers (if unused)

last port number used when searching a free port for the server.

should be 0.

Only set this to 1 if you use the SAP Interface to work with multi-user projects

0 = user permissions are also stored when saving.

1 = user permissions are not stored when saving.

Default value is 0.

<Admin>

<Name>

name of the multi-user administrator

used when the server converts the dictionary database (e.g. to grant permissions)

<Log>

<File>and any number of further log files <File1> to<File_n>

<Path>

directory for the logfiles (should be a local directory on the multi-user server)

All files created using one of the elements <File1> to <File_n> have the extension _File1or _File_n assigned.

when this limit is set (MB) muservice.exe will start a new logfile when the current file reaches the limit.

<Error>		error messages
<Information>		information
<InternalError>		internal errors
<Success>		success
<Warning>		warnings
<ProjectTracing>		tracing project-related actions
<Debug>
	<Normal>	debug messages should normally be disabled (0)
	<Time>	time debug messages should normally be disabled (0)

debug messages should only be activated when the Zuken support needs more information to analyze a problem. All other message type should always be activated (1).

all message should be inactive (0) for the windows event log.

configuration used for the project database

configuration used for the dictionary database

List of parameters of the configuration (<Parameter><Name><Value></Parameter>)

DbName=E3DICTIONARY

updates sent from E³ while another user is opening a project are deferred until the project has been opened. If a update has already been started, reading the tables is deferred until the update transaction has finished. This is the maximium wait time in seconds (default: 600)

Exporting a project to a DAT file is waiting for update transactions and update transactions are waiting for exports. This is the maximum wait time in seconds (default: 300)

The server considers connections to clients lost when no message arrived for this time in seconds (default: 300)

This is the maximum time between two messages sent by E3.. If the user is not interacting with E3. keep alive messages will be sent (default: 30).

when opening a multi-user project that has been created with version 2015 or before, the project will be converted with an external converter. This can take a long time which is limited by this value (default: 3600).

<Cache>

<Path>

directory for the cache files (this directory should be a local directory on the server). Make sure that there ist enough space on the server (size of the project databases). If the server fails to create the cache files, opening the projects will be very slow.

List of parameters

the round trip time of the connection is determined by sending icmp packets (ping). The block with the highest <RTTUpperLimit> less than the real RTT is used (if the real RTT is higher than the highest limit, this block is used). The <SocketBufferSize> should be set to a value near Bandwith in bytes / s * RTT in s. For WAN connections using a Default compression level can speed up the data transfer. For LAN connections use Uncompressed.

<Path>

directory for the DAT files (Export functionality)

this directory should be a local directory on the server

<Path>

directory for the Journal files

With selected value '1' following is valid: Journal file will be created.

With selected value '0' following is valid: Journal file will not be created.

<Check>

<Flags>

Enable checks on the server (should be 1)

allow the server to use prepared statements (should be 1)

If this value is 1, the external converter program used when converting multi-user projects from Versions prior to 2016, stores the project as E3S file (version 2015). To disable these backups, set this parameter to 0.

the E3S backup files will be created in this folder. Make sure there is enough space on the multi-user server.