To work with the Vertec.ini configuration file
Product line
Standard
|Expert
Operating mode
CLOUD ABO
|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:\Programs\Vertec\DB\Vertec.fdb User Name=SYSDBA Password=xxx Buffers=10000
Server name | Identifies the server and database. |
User Name | Identification for the database server. |
Password | Encrypted password for identification on the database server, together with the user name. To encrypt your password, use the Customer Portal . |
Buffers | Starting with Vertec 6.5, the Firebird Buffer Size shall be overwritten: Default value is 10000. Please refer to the article Firebird Pages and Buffersize . |
[Database] Provider=SQLOLEDB Data Source=MYSERVER Initial Catalog=vertec User ID=Vertecuser Password=xxx
Providers |
|
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\Instance Name |
Initial Catalog | Name of the database on the SQL Server |
User ID | Identification for the database server. |
Password | Encrypted password for identification on the database server, together with the User ID. To encrypt your password, use the Customer Portal . |
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:\Programs\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:\Programs\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. E.g. Host=SERVER1. Here you can also specify an IP address. |
Port | TCP port of the Notif server. Default: Port=8091 |
PollInterval | Time interval for client requests to the Notif server in milliseconds. Default: PollInterval=10000 (equivalent to 10 seconds). Note: Values below 1000 are not useful and may cause problems. Values between 1000 and 10000 should only be selected for special tests. Values above 10000 should be selected for running. |
Note: If multiple Cloud Server
to be used, Notif must be active on exactly one server ( Notif Server=True
) and must not be activated more than once.
If Vertec is installed on a server that also has a firewall for the internal network (e.g. Server 2008), 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, the Notif will not run.
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=demo.vertec-cloud.com Server Port=8081 Management Port=8082 SSH Remotehost=ssh.vertec-cloud.com SSH remote port=12345 SSH User=vtc1849 SSH Password=xxx 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 |
---|---|---|---|
BI API |
True | From Vertec 6.4.0.14. Turns off the BI API (Application Programming Interface) for querying BI data from external applications. [CloudServer] BI API=True
|
No. |
BI Task Scheduler Range StartBI Task Scheduler Range End |
This allows you to define the time window in which the BI data is to 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 the dice: Base on the start time, the quantity of minutes to the end time is determined. A random number from 0 to the quantity of minutes is then rolled, and this value is added to the start time. This results in the CRON expression for determining the next execution, see also Schedule Tasks. |
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 served 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. |
Login Max Failures |
10 | Starting with Vertec 6.2. Brute-force prevention mechanism to prevent numerous unsuccessful login attempts as used in brute-force authentication attacks. The authentication server remembers and counts failed attempts per login name. If the quantity of failed attempts for a given login name reaches a threshold, authentication requests for that login name will no longer be processed for a given period of time. If a successful login occurs before the threshold is reached, the counter for that login name is reset. The quantity of possible attempts and the time span can be configured. If nothing is specified, the default is used. [CloudServer] Login Max Failures=10 (default) Login Ban Minutes=10 (default) If one of the settings is set to These settings are independent and work even if the Authentication via LDAP Server is carried out. |
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. By default, access to the Management Console is only possible via Localhost address to prevent that the Management Console, which does not require a login, can be easily accessed 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 shared accordingly and it must be ensured that the port cannot be accessed from the 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 monitoring calls, see above. | No. |
Notif Server |
True | The Notif Server can be explicitly disabled with [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 | Enables/disables the Outlook app to operate with this Cloud Server instance. [CloudServer] Outlook app Server=True |
No. |
Outlook app Session Timeout |
60 | Time in minutes after which an Outlook app session expires and the user must log in again. The value entered must be greater than 0 and less than 2147483647. [CloudServer] Outlook app Session Timeout=75 |
No. |
Phone app Server |
True | From version 6.2. Enable/disable the Phone app for operation with this Cloud Server instance. [CloudServer] Phone app Server=True For more information, see Enable Cloud Server Services individually. |
No. |
Phone app Session Timeout |
60 | Starting with 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 switched off Token Lifetime : Enable enough session time, otherwise the user will have to re-login all the time |
No. |
Portal Page |
True | From version 6.6.0.7. Allows the display of the App Portal
. If the setting to False set, calls to the page are automatically forwarded to the Web app. |
No. |
Process Limit |
0 | Maximum number and 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 that are started from stock. If a new user logs in with a cloud client, he applies this session and a new idle session is automatically started. This makes the start / login process shorter for the client. See also Cloud Server Management Console. |
No. |
Restricted filesystem access |
True | Starting with 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. |
Restricted scripting |
True | Starting with version 6.1.0.9. Restricts scripting when accessing via cloud clients. For detailed information, see Restrict scripting for cloud sessions. |
No. |
Restricted Session Process |
True | Starting with version 6.4.0.12. Starts session processes with limited capabilities.
If this setting is set, make sure that when using Firebird, the
The corresponding Log file (Vertec.Session.log) can then be found (as set by Windows) under C:\WINDOWS\system32\config\systemprofile\AppData\LocalLow. (In case of LogFileFolder is set, but no write access exists, no log is written.) This setting is automatically enabled in the Vertec Cloud Suite. From version 6.6.0.7 onward, 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 (https:// is a must in the url...). 0 = Disabled | For SSL/TLS |
Server Address |
"” | The address of the server (e.g. 192.168.1.1 or demo.vertec-cloud.com) is used by the Desktop App to generate the Vertec URL (vertec://...) and for the Python function vtcapp.getvertecserveraddress() used. The logic is implemented as follows:
|
Yes |
Server port |
0 | The port on which the HTTP server can be reached. When 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, no HTTP server is started. | Yes |
Show Error Call Stack |
True | Show the call stack in the error dialog. | No. |
Show License Dialog |
True | Opening the license dialog via Settings > Change license... can be deactivated by pressing Show [CloudServer] Show License Dialog=False |
|
SSH Remote Host |
"” | The host for SSH Tunnel (ssh.vertec-cloud.com). If set, SSH Proxying is Enabled. Otherwise, Disabled. | For SSH |
SSH remote port |
0 | The port for SSH tunnel. Must be set if SSH remotehost is set. | For SSH |
SSH User |
"” | The user for SSH tunnel. Must be set if SSH remotehost is set. | For SSH |
SSH Password |
"” | The password to the SSH user in encrypted form (Vertec database password encryption). Must be set if SSH remotehost is set. | For SSH |
Token Lifetime |
7 | Specifies 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 user . |
No. |
Trusted Certificate |
"” | Hash of a bound certificate (see Cloud Server) | No. |
Task Scheduler |
True | Controls whether Task Scheduling is active or not. If not, no scheduled tasks are 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) | Starting with Vertec 6.4.0.8. If a Vertec.Taskrunner process does not complete correctly, it persists and unnecessarily blocks memory on the server. Therefore, under Task Scheduler Max Minutes, you can specify the maximum running time in minutes for a scheduled task. The default value is 1200 (20h). If a process runs longer than the maximum time specified here, Cloud Server will automatically complete it. 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 this is turned off, these clients cannot be used. 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 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 available for the Vertec 6.4.0.14 BI API used. |
No. |
XML Server |
True | Enables/disables the XML Server to operate with this Cloud Server instance. [CloudServer] XML Server=True For more information, see Enabling 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 made available to minimize the risks of attack.
In the [Cloudserver] section, the following settings are available:
[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 is True
for all.
Exception: If multiple Cloud Server
may be used: Notif Server
and Task Scheduler
be active only on one Cloud Server. To disable one of the services, it must be set to False
.
Settings | Default | Significance | Required |
---|---|---|---|
Servers |
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 installing the Cloud app, the Cloud app Installer automatically sets the settings to If the setting is missing from the Vertec.ini file or if it is set to |
No. |
Trusted Certificate |
"” | Hash of a self-signed certificate to be accepted (see Cloud Server) | No. |
Only Vertec versions prior to 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. Will be taken into account in the Update Installation and Client Setup. Possible Values: Y and N. |
ExplorerAddin |
Specifies whether the Explorer add-in was selected for installation. Will be taken into account in the update installation and client setup. Possible Values: Y and N. |
OutlookAddin |
Specifies whether the Outlook add-in was selected for installation. Will be taken into account in the update installation and client setup. Possible Values: Y and N. |
ExplorerAddin |
Specifies whether the Explorer add-in was selected for installation. Will be taken into account in the 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, certain settings of Vertec Logging can be overridden. The following parameters are available:
[Log] LogFileName=MyLogfile.log DebugCategories=vertec.dmbtim, vertec.examplecategory
LogFile |
Name of the log file. If a file is specified here, logging to this file instead of the default log file Vertec.log. Unlike the default 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, it 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 log files are not to be stored in Programdata or Appdata, an alternative folder path can be specified here. All log files 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 for logging various operations in Vertec. To find out which Debugcategories are relevant to you, please contact your Vertec adviser. If a value is specified in the registry under HKLM\SOFTWARE\Vertec\DebugCategories, it 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. |
LogglyToken |
Starting with 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 |
As of Vertec 6.4.0.9. Base URL for Loggly. If not specified, https://logs-01.loggly.com/ is used. |