The Vertec.ini configuration file
Operating mode
Cloud Suite
|ON-PREMISES
Modules
Services & CRM
Budget & Phases
Purchases
Resource Planning
Business Intelligence
The Vertec.ini configuration file contains all the information Vertec needs at startup. It searches for a Vertec.ini in the directory where the running Vertec.Desktop.exe is located.
By default, Vertec uses the section named [Database]
in the Vertec.ini file at startup.
[Database] ServerName=MYSERVER:C:\Programme\Vertec\DB\Vertec.fdb User Name=SYSDBA Password=xxx Buffers=10000
ServerName |
Identifies the server and the Vertec database. |
User Name |
Identification for the database server. |
Password |
Encrypted password for identification at the database server, together with the user name. When you set up Vertec, you will be asked for the database password and this will be automatically entered in Vertec.ini in encrypted form. If you need to enter it manually, e.g. when changing the database password, use the Verschlüsselungs-Option im Kundenportal. |
Buffers |
Starting with Vertec 6.5, the Firebird Buffer-Size can be overwritten: ![]() Default value is 10000. Please refer to the article Firebird Pages und Buffersize. |
[Database] Provider=SQLOLEDB Data Source=MYSERVER Initial Catalog=vertec User ID=Vertecuser Password=xxx
Provider |
|
Data source |
This is the server name (or IP address) of the SQL Server.
If there is more than one SQL Server instance on a server, the instance name must be appended: Data Source=MYSERVER\Instanzname |
Initial Catalog |
Name of the database on the SQL Server |
User ID |
Identification for the database server. |
Password |
Encrypted password for identification at the database server, together with the User ID. To encrypt your password, use the Kundenportal. |
Persist Security Info |
a SQL parameter that is not needed to run Vertec. If this parameter still exists in your configuration, you can delete it. |
Auto Translate |
a SQL parameter that is not needed to run Vertec. If this parameter still exists in your configuration, you can delete it. |
Alternate database sections can be specified. This makes it possible to support different databases with the same Vertec installation. For each of these database connections, a separate section must be created, each with its own name.
[TestDB] ServerName=MYSERVER:C:\Programme\Vertec\DB\VertecTest.fdb User Name=SYSDBA Password=xxx
The call of an alternative database takes place via the parameter /DB.
A database section can contain a value called InstanceName:
[Database] InstanceName=TEST ServerName=SERVER01:C:\Programme\Vertec\VertecTest.fdb ...
This will then be shown as follows:
Vertec (User) Instancename: Objekt
:
For access via OCL, there is an attribute named InstanceName on the session: TimSession.allInstances->first.instanceName
.
[Notif] is the section for automatic data update.
[Notif] Host=SERVER1 Port=8091 PollInterval=10000
Host |
Network address of the Notif server. For example, Host=SERVER1. An IP address can also be specified here. |
Port |
TCP port of the Notif server. Default: Port=8091 |
PollInterval |
Time interval for client requests to the Notif server in milliseconds. Default value: PollInterval=10000 (equivalent to 10 seconds). Note: Values below 1000 do not make sense and can lead to problems. Values between 1000 and 10000 should only be selected for special tests. Values above 10000 should be selected for ongoing operation. |
Note: If multiple cloud servers are used, Notif must be active on just one server (Notif Server=True
) and must under no circumstances be activated more than once.
If Vertec is installed on a server that also has a firewall for the internal network, the Notif port must be explicitly enabled. To do this, the port and Vertec.CloudServer.exe should be enabled.
If the Notif
section in Vertec.ini does not exist or no port is specified, Notif is disabled.
In the [CloudServer] section, the Notif server can be explicitly disabled by setting Notif Server=False
.
The Notif always runs on the default database. If Vertec is started
via /DB with another database, Notif will not run.
If you occasionally still use the Vertec Desktop App or work with several Vertec Cloud Servers, you must follow these instructions for full-text search.
When using multiple Vertec Cloud Servers, please follow the instructions described in the article Multiple Cloud Server instances.
The full-text search or indexing of the data is provided by the Vertec Cloud Server. If data is changed in the Vertec Desktop App, it does not automatically reach the Vertec Cloud Server.
For changes to reach the Vertec Cloud Server, there must be a connection to the Vertec Cloud Server, and the port for the indexing server must be reachable. To run the full-text search with the Vertec Desktop App and/or several Vertec Cloud Servers, the parameters Host and Port are absolutely necessary:
Parameter | Description |
---|---|
Host | The name or IP of the Vertec Cloud Server on which the indexing server runs. Relevant for the Vertec Desktop App so that it knows which Vertec Cloud Server it needs to connect to. |
Port |
The port on which the indexing server can be reached on the host. The parameter must be specified to activate the HTTP server for indexing. If it is not specified, no search is available in the Vertec Desktop App. |
Index Path |
The path on the server where the index should be saved. Is only used by the Vertec Cloud Server. If nothing is indicated, the following path is used by default: |
[Indexing] Host=SERVER1 Port=8092
Important: In order for the search to be available in the Vertec Desktop App and the changes to be tracked, the port for the indexing server must be opened. The data is transmitted via HTTP. Such information can be intercepted and should, therefore, only be provided in the LAN. Furthermore, it is also the case with the LAN that the client receives more back from the indexer than the user with their rights in Vertec can poten-tially read. If you want to prevent this, the LAN traffic must also be encrypted.
We recommend you use the Vertec Cloud App and Vertec Web App, rather than the Vertec Desktop App.
This section is no longer required as of Vertec 6.1.0.10, since the XML Server is integrated in the Cloud Server from this version.
To switch an existing XML server to Cloud Server operation, delete or comment out the [Xmlserver] section and any XML entries under [Webserver]. Instead, activate the XML server in the [CloudServer] section, and then restart both services (Vertec Service and Cloud Server).
[CloudServer] Server Address=MYSERVER Server Port=8081 Management Port=8082 XML Server=True Task Scheduler=True BI API=True Portal Page=True Restrict Scripting=True Restrict Session Process=True Restrict Filesystem Access=True
Settings | Default | Significance | Required |
---|---|---|---|
AI Recognition Ping Timeout |
1 second | As of Vertec 6.7.0.14, for automatic receipt recognition. Timeout for the “ping” request in seconds, which is executed before each detection attempt to check if the server is available. An adjustment should only be necessary in case of poor internet connection of the server. |
No |
AI Recognition Request Timeout |
20 seconds | As of Vertec 6.7.0.14, for automatic receipt recognition. Timeout for analysis of the submitted posting. An adjustment should only be necessary in case of poor internet connection of the server. |
No |
BI API |
True | As of Vertec 6.4.0.14. Enable the BI API (Application Programming Interface) to query Bi data from external applications. [CloudServer] BI API=True
|
No |
BI Task Scheduler Range StartBI Task Scheduler Range End |
Vertec versions before 6.8. This allows you to define the time window in which the BI data should be calculated. Within this time window, the Cloud Server rolls a time in which the process is started. The start time is set by a new session at the start of the Cloud Server. BI Task Scheduler Range Start=23:00 BI Task Scheduler Range End=05:00 How to roll: Start from the start time, the quantity of minutes until the end time is determined. Then, a random number from 0 to the quantity of minutes is rolled and this value is added to the start time. This yields the CRON expression used to determine the next run, see Scheduled Tasks. As of Vertec 6.8, the parameters are called Special Task Scheduler Range Start and Special Task Scheduler Range End, since they are also valid for the plated task for full-text indexing. To maintain backward compatibility, the new names are checked first and then the old ones are checked. |
No | |
Certificate Name |
“Vertec-Autogenerated” | HTTP: Name (FriendlyName or CommonName) of the certificate in the certificate store (Local Machine). See Cloud Server. | For SSL/TLS |
Excluded Protocols |
"” | Comma-separated list of HTTP transport protocols that should not be offered by the server. Possible values are WebSockets, ServerSentEvents, ForeverFrame, LongPolling. | No |
HSTS Max Age |
0 | HTTPS: Enables HTTP Strict Transport Security and specifies the HSTS policy max-age in days. | No |
Indexing server |
True | As of Vertec 6.8. Control whether the Vertec Cloud Server provides indexing operations and thus full- Full Text Search.
|
No |
Login Max Failures |
10 | As of Vertec 6.2. Brute-force prevention mechanism to prevent many failed login attempts, as used in brute-force authentication attacks. The authentication server remembers and counts failed attempts per login name. Once the quantity of failed attempts for a given login name reaches a threshold, authentication requests for that login name will not be processed for a specified period of time. If a successful login occurs before the threshold is reached, the counter for this login name is reset. The quantity of possible attempts and the time period can be configured. If nothing is specified, the default is used. [CloudServer] Login Max Failures=10 (Standard) Login Ban Minutes=10 (Standard) If one of the settings is set to These settings are independent and work even if Authentication via ldap server is done via LDAP servers. |
No |
Login Ban Minutes |
10 | ||
Management Port |
0 | The port on which the Management Server can be reached (see Cloud Server). 0 = Disable | No |
Management Port Exposed |
False | From version 6.1.0.10. Access to the Management Console is by default only possible via Localhost address to prevent that the Management Console, which does not require login, is easily accessible from outside the computer. The setting [CloudServer] Management Port Exposed=True provides the Management Console on all available interfaces. We do not recommend setting this option. The ports must be approved accordingly and it must be ensured that the port cannot be accessed from outside. |
No |
Monitoring |
False | Allows monitoring via an HTTP Get Request /monitor_session_start . For more information, see Monitoring Cloud Server. |
No |
Monitoring Ban Minutes |
10 | Quantity of minutes pause between two monitor calls, see above. | No |
Notif server |
True | The Notif Server can be explicitly disabled using [CloudServer] Server Address=SERVER1 Server Port=8081 Management Port=8082 Notif Server=False [Notif] Host=SERVER1 Port=8091 PollInterval=10000 The If it is not present, the behavior is equivalent to |
No |
Outlook App Server |
True | Activates/disables the Outlook App to work with this Cloud Server instance. [CloudServer] Outlook App Server=True For more information, see Enable |
No |
Outlook App Session Timeout |
60 | Time, in minutes, after which an Outlook App session expires and the user must log on again. The value entered must be greater than 0 and less than or equal to 2147483647. [CloudServer] Outlook App Session Timeout=75 |
No |
Phone App Server |
True | From version 6.2. Activates/disables the Phone App for operation with this Cloud Server instance. [CloudServer] Phone App Server=True For more information, see Enable Activate cloud server services individually. |
No |
Phone App Session Timeout |
60 | From version 6.2. Time in minutes after which a Phone App session expires and the user must log in again. The value entered must be greater than 0 and less than 35791. [CloudServer] Phone App Session Timeout=75 Attention when Token Lifetime is switched off: Turn on enough session time, otherwise the user will have to log in again all the time |
No |
Portal Page |
True | From version 6.6.0.7. Allow the display of the app App App Portal. If the setting is set to False set, calls to the page are automatically forwarded to the Web App. |
No |
Process Limit |
0 | Maximum number quantity of simultaneous sessions. The default value is 0. This means that no limit is set. |
No |
Process Pool Size |
1 | Quantity of idle sessions, which are started on reserve. If a new user logs in with a cloud client, he applies this session and a new idle session is automatically started. This reduces the start / login process for the client. See also Cloud Server Management Console. |
No |
Restricted Filesystem Access |
True | From version 6.1.0.9. Restrict access to the server file system when saving documents. If this option is enabled (Cloud Suite Standard), this has the following effects:
|
No |
Restrict Local IP |
False | As of version 6.7.0.14. Restrict Python access to public IP addresses when Restricted Scripting is enabled. | No |
Restricted Scripting |
False | Starting with version 6.1.0.9. Restrict scripting when accessed via cloud clients. For details, see Restrict scripting for cloud sessions. For new installations, this option is set by Setup to True. |
No |
Restricted session process |
True | Starting with version 6.4.0.12. Start the session processes with limited capabilities.
If this setting is set, make sure that when using Firebird, the
The corresponding Logfile (Vertec.Session.log) can then be found (defined by Windows) under C:\WINDOWS\system32\config\systemprofile\AppData\LocalLow. (If a Logfilefolder is set but no write access exists, no log is written.) In the Vertec Cloud Suite, this setting is automatically activated. As of version 6.6.0.7 it affects the saving of reports like Restrict Filesystem Access (see above). |
No |
Secure server port |
0 | HTTPS: The port on which the HTTPS server can be reached. 0 = Disabled | For SSL/TLS |
Server Address |
"” | The address of the server (e.g. 192.168.1.1 or vertec.company.com) is used by the Desktop App to generate the Vertec url (vertec://...) and for the Python feature vtcapp.getvertecserveraddress(). The logic is implemented as follows:
|
Yes |
Server port |
0 | The port on which the HTTP server can be reached. If HTTPS is active, the HTTP server serves as a forwarding to the Secure Server port. If the server port is not set but a Secure Server port is set, no HTTP server is started. | Yes |
Special Task Scheduler Range StartSpecial Task Scheduler Range End |
This allows you to define the time window in which the planned tasks for the BI calculations and for the Full Text Indexing may be carried out. Within this time window, the Vertec Cloud Server rolls a time in which the processes are started. The start time is set by a new session at the start of the Cloud Server. Special Task Scheduler Range Start=23:00 Special Task Scheduler Range End=05:00 How to roll: Start from the start time, the quantity of minutes until the end time is determined. Then, a random number from 0 to the quantity of minutes is rolled and this value is added to the start time. This yields the CRON expression used to determine the next run, see Scheduled Tasks. |
No | |
Show Error Call Stack |
True | Show the call stack in the error dialog. | No |
Show License Dialog |
True | The opening of the license dialog via Settings > Change license... can be disabled by using Show [CloudServer] Show License Dialog=False |
|
SSH Remote Host |
"” | The SSH parameters are used when you make Internet your Vertec available on the Internet via a service such as the Webaccess service from spektra netcom ag. The information to be entered will be provided by the operator. Once the SSH remote host (the host for the SSH tunnel) is set, SSH proxy is activated. Otherwise, it is disabled. |
For SSH / Webaccess |
SSH remote port |
0 | ||
SSH User |
"” | ||
SSH Password |
"” | ||
Token Lifetime |
7 | Returns the validity period of the option Angemeldet bleiben in days.If a value of 0, no checkbox appears on the login dialog. See Login / current current user. |
No |
Trusted Certificate |
"” | Hash of a bound certificate (see Cloud Server) | No |
Task Scheduler |
True | Controls whether the task scheduling is active or not. If not, no scheduled tasks will be executed. |
No |
Task Scheduler Polling Minutes |
1 | Controls how many minutes are checked for pending scheduled tasks. Natural number, default is 1. | No |
Task Scheduler Concurrent Tasks |
1 | Controls the maximum number of scheduled tasks that can be executed in parallel. Natural number, default is 1. | No |
Task Scheduler Max Minutes |
1200 (20h) | As of Vertec 6.4.0.8. If a Vertec.TaskRunner process does not complete correctly, it persists and blocks unnecessary memory on the server. Therefore, under Task Scheduler Max Minutes, you can specify the maximum run time in minutes for a scheduled task. Default value is 1200 (20h). If a process runs longer than the maximum time specified here, it will be automatically completed by Cloud Server. Completing Vertec.CloudServer also completes all started TaskRunner processes. |
No |
UISync Server |
True | From version 6.2. The UISync server controls the interface in the full-featured clients (Cloud App, Web App). If it is switched off, it is not possible to work with these clients. This is useful, for example, if you want to put only the Phone App or the XML Server on the Web via a Cloud Server instance. For more information, see Enable Activate cloud server services individually. |
No |
XML Session Timeout |
5 | Time, in minutes, after which an XML session expires and the user must log in again. [CloudServer] XML Server=True XML Session Timeout=10 Also used for the BI API as of Vertec 6.4.0.14. |
No |
XML Server |
True | Activates/disables the XML Server to operate with this Cloud Server instance. [CloudServer] XML Server=True For more information, see Enable CloudServer Services individually. |
No |
The different services of a cloud server instance can be started separately. For example, on a cloud server instance that is placed on the internet, only the phone app can be provided to minimize the risk of attack.
The following settings are available in the [CloudServer] section:
[CloudServer] XML Server=True UISync Server=True Phone App Server=True Notif Server=True Task Scheduler=True BI API=True Portal Page=True
Default value for all is True
.
Exception: If multiple cloud servers are deployed, Notif Server
and Task Scheduler
be active only on a cloud server. To turn off one of the services, it must be set to False
.
Setting | Default | Significance | Required |
---|---|---|---|
Server |
http://localhost:8081 | Server for the connection. | If no command line argument /server and missing [CloudServer] section. |
Auto Update |
False |
Here you can set whether the local version of the cloud app is automatically updated to the latest version on the server when it is started. When you install the cloud app, the settings of the cloud app installer are automatically set to If the setting in the Vertec.ini file is missing or |
No |
Trusted Certificate |
"” | Hash of a self-signed certificate to be accepted (see cloud server) | No |
Vertec versions before 6.6.0.7. Certain setup options are stored in the Vertec.ini file.
[Setup] Version=6.1.0.14 WordAddin=Y ExcelAddin=Y OutlookAddin=Y ExplorerAddin=Y ClientSetup=Local
version |
Version number of the last setup. |
WordAddin |
Specifies whether the Word add-in has been selected for installation. Used during update installation and client setup. Possible values: Y and N. |
ExplorerAddin |
Specifies whether the Explorer add-in has been selected for installation. Used during update installation and client setup. Possible values: Y and N. |
OutlookAddin |
Specifies whether the Outlook add-in has been selected for installation. Used during update installation and client setup. Possible values: Y and N. |
ExplorerAddin |
Specifies whether the Explorer add-in has been selected for installation. Used during update installation and client setup. Possible values: Y and N. |
ClientSetup |
There are 2 modes for the client setup:
The local client installation has the following advantages:
The default setting is Local. |
In the Log section, some settings of Vertec Logging can be overridden. The following parameters are available:
[Log] LogFileName=MyLogfile.log DebugCategories=vertec.examplecategory
LogFileName |
Name of the log file. If a file is specified here, logging is done to this file instead of the standard log file Vertec.log. Unlike the standard logfile, a logfile specified here is not deleted every time Vertec is started, but the new entries are appended. If a value is specified in the registry under HKLM\SOFTWARE\Vertec\LogFileName, this value takes precedence. See the section on versions prior to Vertec 5.4 in the Logging article. |
LogFileFolder |
As of Vertec 6.1.0.7 there is the parameter LogFileFolder. If the logfiles are not to be stored in ProgramData or Appdata, an alternative folder path can be specified here. All logfiles are then written to this folder.
|
DebugCategories |
Here you can define the debug categories for which you want to generate level 10 log entries. See the article about logging. There are a variety of built-in DebugCategories to log various operations in Vertec. To find out which DebugCategories are relevant to you, please contact your Vertec advisor. If a value is specified in the registry under HKLM\SOFTWARE\Vertec\DebugCategories, this value takes precedence. See the section on versions prior to Vertec 5.4 in the Logging article. |
SqlLogTable |
With SqlLogTable=True, the log entries are written to the LOGDATA table in the database. This allows all log entries of all Vertec users to be viewed and saved centrally. For detailed information, see article Logging. |
OpenObserveUrl |
Vertec 6.7.0.12 or later. Must be specified for Vertec to send Log Messages to the OpenObserve Log Server. For detailled information see article Logging. |
OpenObserveUsername |
Username to OpenObserveUrl. |
OpenObservePassword |
Password to OpenObserveUrl. |
LogglyToken |
As of Vertec 6.4.0.9. If a Loggly token is specified, the log output from the server-based Vertec processes (Vertec.CloudServer, Vertec.Session) is sent to the cloud-based logger service Loggly. The desired URL can be specified with the LogglyUrl parameter. For detailed information, see article Logging. |
LogglyUrl |
Vertec 6.4.0.9. Base url for Loggly. If not specified, https://logs-01.loggly.com/ is used. |