File server.ini
BackupClient
Key Description Value Default value
5529 Specifies how many days may elapse between the last synchronization and the execution of the job in the BackupClient. After this period, the job must be resynchronized in order to run. 1 … 300 30
[Common]
Key Description Value Default value
5500 Specifies the path of the temporary files directory.
RootDirAdmin: Path inside the server archive (<
vdServerArchive>VD_TMP_VD
or<vdClientArchive>VD_TMP_VD
TEMP_DIR_OS: Path of the temporary directory is defined for the user in the operating system.
<drive:<directory name>
RootDirAdmin
5501 Specifies the language for the server.
<language abbreviation>
For example, DE, EN, CZ, IT.
Empty string
5502 Specifies whether mixed directory structures (project within a project) are possible. Y, N N
5503 Specifies the available memory in MB. If this is too low, a warning will be issued. 128 1048576 10240
5504 Specifies the available memory in MB below which an error message is issued. 64… 1048576 1024
5508 Specifies the root directory for project data if project data and metadata are to be stored separately.
<Path to a directory>
If no value is specified, project data and metadata will not be separated and have the same root directory.
Empty string
5511 Specifies the minimum number of characters that must be specified as a comment when creating a new version. 0 … 255 0
5512 Specifies whether an email is to be sent when a warning or error occurs. Y, N N
5522
Specifies whether the JobResults.fdb database is stored on a remote share by default.
This key is only observed if a path is specified in key 5508 and project data and metadata are stored separately.
The process of copying from the local to the remote directory, and vice versa, or, for example, when moving the server archive, must be done manually.
Y, N N
5525 Specifies the time period, in seconds, after which an upload and comparison is aborted. 900 … 7200 1800
5535 Specifies the time period, in minutes, after which maintenance mode activation is cancelled. 1 … 360 2
5537 Specifies the separator for CSV files.<string>
The default list separator, set in your Windows system under Time and Region > Change date, time, or number format > Other Settings > List Separator
5538
Specifies how often the attempt to back up the files in the local server archive is to be repeated.
This key is only observed if a path is specified in key 5508 and project data and metadata are stored separately. Also, bakadmintoremote must have the value Y.
0 … 60 1
5539 Specifies whether individual archives may be deleted from the version history of a component. Y, N N
5543 Specifies whether only the current server or both servers and the synchronization state are displayed in the System dashboard in parallel server mode.
Y: Only the current server is displayed.
N: Both servers and the synchronization status are displayed.
Y
When installing a new server, the value is reset to N by default.
5544 Specifies whether to delete all local data from the client archive when the client exits. Y, N N
5545 Specifies whether the offline help opens and the help page What’s new is displayed the first time you log in after installation or an update. Y, N Y
5564 Specifies whether databases are backed up to the temporary files directory (key 5500) before migration (during an update). Y, N Y
5572 Specifies the IDs of the users who should receive emails when an error occurs and is submitted to the event log. <Base64 List>
Group of administrators
5582 Specifies whether a warning is issued if local changes were detected during check-out that have not yet been versioned.
0: A warning is always issued.
1: The warning can be disabled by the user.
2: No warning is issued.
1
5605 Specifies the number of days for which data is contained in the octoplant hub data package.Theoctoplant hubpackage contains data from the octoplant server that is exported via the ExportModuleand then displayed graphically in the octoplant hub. The restriction to a specific time period only applies to the JobResults, EventLog, AdminLog and ComponentLog exports. Number (in days) 365
TimeoutAgentUpdateInMinutes
Specifies a timeout for the automatic update of the agents during a server update.
Number (in minutes) 10
[Compare]
Key Description Value Default value
7003 Specifies the maximum number of differences that will be searched and displayed during a comparison. 64… 16384 512
[CsVExport]
Key Description Value Default value
MaskingPolicy
Specifies the masking method for cells of exported CSV files.
BasicIfRequired, BasicAlways, FullIfRequired, FullAlways BasicIfRequired
Examples for possible masking methods
Initial value | BasicIfRequire | BasicAlway | FullIfRequire | FullAlway |
---|---|---|---|---|
“a | ‘”a | |||
a” | “a””a | “a””a | “‘a””a | “‘a””a |
a, | “a,a | “a,a | “‘a,a | “‘a,a |
a’ | a’ | “a’a | “‘a’a | “‘a’a |
a; | a; | “a;a | “‘a;a | “‘a;a |
= | = | “=a | “‘=a | “‘=a |
+ | + | “+a | “‘+a | “‘+a |
– | – | “-a | “‘-a | “‘-a |
@ | @ | “@a | “‘@a | “‘@a |
[QuickSave]
Key Description Value Default value
5560 Specifies whether Quicksaves can be created in the UserClient. Y, N N
5561
Specifies the maximum number of Quicksaves.
Once the maximum amount has been reached, the oldest quicksave will be deleted as soon a new one has been created.
0 … 214748367 5
[Scheduler]
Key Description Value Default value
9854
Specifies the date when the next email with job results should be sent from the server.
The date is given as the number of days from the start of the census on 01/01/1970.
Number
0
9858 Specifies the path of the log file for the scheduler.<Path>
Empty string
[Scripting]
Key Description Value Default value
12670 Specifies whether the checksum of the scripts should be formed or checked for each client or server synchronization. Y, N N
12671 Specifies whether to run scripts on the server. Y, N N
12672 Specifies whether to run scripts on the clients. Y, N N
12673 Specifies the time period in minutes after which the execution of a server script is aborted. 1 … 720 15
12674 Specifies the time period in minutes after which the execution of a client script is aborted. 1 … 120 15
[ServerSynchronisation]
Key Description Value Default value
12650 Specifies whether the server synchronizes with another server in parallel server mode. Y, N N
12651 Specifies the maximum packet size for traffic between servers during server synchronization. 1024… 64512 64512
12652 Specifies the waiting time between two packets for traffic between servers during server synchronization. 0 … 1000 0
12653 Specifies the period, in minutes, during which the availability of the synchronization partner is checked. 0 … 60 5
12655 Specifies the maximum number of open synchronization jobs above which a server is put into maintenance mode if the synchronization partner is not reachable. 5000 50000 5000
12658 Specifies whether the takeover of job execution by the synchronization partner is disabled in case of server failure.
Y: If the server fails, the jobs assigned to it are not taken over by the synchronization partner.
N: If the server fails, the jobs assigned to it are taken over by the synchronization partner.
N
12659 Specifies the time period, in minutes, since the last client log on or termination within which a new client log on can attempt to use the same server from a parallel server group. 1 … 1440 60
12660 Specifies the time period, in minutes, after which an error message is sent if the parallel server is unavailable. 1 … 1440 0