Command line parameters

Starting Vertec with command line parameters

Product line

Standard

|

Expert

Operating mode

CLOUD ABO

|

ON-PREMISES

Modules

Services & CRM

Budget & Phases

Purchases

Resource Planning

Business Intelligence

Created: 29.07.2003
Updated: 14.05.2024 | Fixed spelling error with parameter/password.

Various Vertec apps and the Cloud Server can be started with parameters. These are described below.

Available parameters

Cloud App

Parameters Description
/batch

Available from Vertec 6.5.0.22. The Vertec process starts, but the program does not appear on the interface.

Authentication takes place either via /username + /password or via the login screen.

In batch mode, the software automatically exits after performing the specified action(s).

/culture:<code>

Changes the country setting of the client (number and date format).
Codes according to https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20)

Vertec.Cloud.exe /culture:en-US
/noevents

Available from version 6.5.0.22. Administrator only.

Deactivates the event script system for the current session. This option is useful for debugging problems caused by event scripts.

/noupdate

Suppresses automatic update (see AutoUpdate setting in Vertec.ini File).

Vertec.Cloud.exe /noupdate
/paysync

Available from Vertec 6.5.0.22. To automate the payment import, the Cloud App can be started with the parameter /paysync.

/regserver

The Vertec COM Server is automatically registered with the Cloud App Installer (requires administrator rights). For manual registration, e.g. for troubleshooting or installation by a software distribution, Vertec.Cloud.exe can be called up with this parameter.

Vertec.Cloud.exe /regserver
/script <scriptname>

Available from Vertec 6.5.0.22. Executes the script specified by name or the specified file name. Can only be executed by an administrator. The session remains started afterwards; the Cloud App can continue to be used normally.

Vertec.Cloud.exe /script <scriptname>
/super

Available from Vertec 6.5.0.22. To run the Cloud App in SUPER mode, it must be started with the parameter /super and the logged-in user must also have the super right (rtSuper).

SUPER mode has the following consequences:

  • Allows SystemContext() in scripts in interactive mode (otherwise only for registered scripts with advanced privileges).
  • Allows use of Invoice.SetTotal method (COM). Used to place invoice totals on charged invoices (used in migrations).
  • Skips the cascaded deletion rights check when deleting objects. The deletion right is only checked on the original object.
  • General rights check: Prevents the effect of final rights, i.e. the SUPER mode allows everything, even things that are otherwise forbidden by business logic.

We recommend that you exercise caution when using Vertec in SUPER mode. Due to its extensive capabilities, Vertec can be brought into an inconsistent, no longer operational state.

/server <Server URL>

The Cloud App determines the server address according to the following multi-level logic:

  1. /server parameters with server URL
  2. “Server” value under [CloudApp] .ini section
  3. Composite values of the [CloudServer] .ini section
Vertec.Cloud.exe /server http://localhost:8081/
/unregserver

Administrators only. Unregisters the COM Server (Typelibrary)

Vertec.Cloud.exe /unregserver
Vertec URL

URL of the object which should be used to start Vertec.

Vertec.Cloud.exe vertec://Christoph+Keller-676/eigene+Projekte-49/

Cloud Installer (Cloud App)

The Cloud Installer is the Vertec.CloudInstaller.exe that is used to install the Cloud App locally. Without command line arguments, /update runs without options.

Parameters Description
/install

Downloads Vertec.Cloud.exe and saves it with the configuration file to the current directory where the Cloud Installer is located (without optional components ).

  • The server name from which Vertec.Cloud.exe is downloaded (your Vertec domain) is specified with the parameter /server or encoded in the file name (see examples).
  • Starting from version 6.5.0.20, an alternative directory can be specified with the parameter /dir.

Examples:

  • Vertec.CloudInstaller.exe /install /server=https://domain.com   loads Vertec.Cloud from the server that was indicated with /server.
  • Vertec.CloudInstaller_https_domain.com_port.exe /install loads Vertec.Cloud from the server encoded in the URL.
  • Vertec.CloudInstaller_https_domain.com_port.exe corresponds to the download file. This can be started anywhere without parameters. The download of Vertec.Cloud is done by the server encoded in the file name. The default installation is done in %localappdata%/Vertec Cloud App.
/installoptional

Same as /install, but with optional components .

/dir

Available from Vertec 6.5.0.20. Specifies an alternate folder for installation. If the directory does not already exist, it will try to create it. Without the parameter /dir the Cloud App is installed in the directory where the Cloud Installer is located. The name of the desktop icon takes the name of this folder.

Vertec.CloudInstaller.exe /install /dir=<mein Verzeichnis>
/uninstall

Uninstalls the Cloud App. This is an alternative to uninstalling using add program or remove program.

Vertec.CloudInstaller.exe /uninstall
/update

This is used in the same way as /install and updates the Cloud App.

Note: The Vertec.CloudInstaller.exe file must be up to date. It will only be in auto update  if automatically retrieved from the server.

Vertec.CloudInstaller.exe /update /server=https://domain.com
/server

Specify the corresponding domain. Alternatively, the server name can also be encoded in the installer name, then the parameter /server is omitted (see parameters or /update).

/silent

Available from Vertec 6.5.0.20. If the Cloud Installer is started with /silent, no user interface or dialogs are shown. To prevent a reboot during installation, you should also use the parameter /norestart.

In case of an error (write rights, admin rights for runtime installation, destination directory not writable, etc.) the return value is != 0 . The console displays the error message.    

/norestart
Available from Vertec 6.7.0.6. Suppressed when using /silent as a possible reboot at the end of the installation.

Outlook Installer (Outlook App)

The Outlook Installer is the Vertec.Outlookinstaller.exe , with which the Windows edition of the Outlook App is installed locally. Without command line arguments, /update is executed without options.

Parameters Description
/install

Installs the Outlook App Windows Edition locally for the current user. The server name from which the Outlook App is downloaded (your Vertec domain) is specified with the parameter /server or encoded in the file name. The default installation happens in %LocalAppData%\Vertec Outlook App.

Examples:

Vertec.OutlookInstaller.exe /install /server=https://domain.com

loads the Outlook App Windows Edition from the server specified with /server.

Vertec.OutlookInstaller_https_domain.com_80.exe /install 

loads the Outlook App Windows Edition from the server encoded in the URL (download via App Portal ).

/server

Available from version 6.6.0.10. Must be specified if the server name cannot be determined from the file name of the Outlook Installer or if there is no download from the App Portal .

Vertec.OutlookInstaller.exe /install /server=<server url>
/dir

Available from Vertec 6.6.0.10. Specifies an alternate folder for the installation. If the directory does not exist yet, it will try to create it.

Vertec.OutlookInstaller.exe /install /dir=<mein Verzeichnis>

If not specified, the Outlook App is installed under %LocalAppData%\Vertec Outlook App or with the argument /localmachine under Program Files\Vertec Outlook App.

/localmachine

Available from version 6.6.0.10. The Outlook App Installer can be set by an administrator using the argument /localmachine and thus installs the Outlook App for all users of the computer.

Installation is carried out by default in %ProgramFiles%\Vertec Outlook App.

Note: An Outlook App installed under Program Files can only be updated by an administrator.

/silent

Available from version 6.6.0.10. If the Outlook App Installer is additionally started with /silent are started, no user interface or dialogs are shown.

Vertec.OutlookInstaller.exe /install /silent /server=https://domain.com
/uninstall

An administrator can uninstall the Outlook App locally.

The server does not need to be specified unless the installation was done in an alternate directory (/dir ). With /localmachine the app is removed for all users. Optionally, /silent can be given.

Vertec.OutlookInstaller.exe /uninstall

With /uninstall /dir, the directory and its entire contents are removed.

/update

Updates the Outlook App Windows Edition. The File Vertec.OutlookInstaller.exe must be up to date for this.

Vertec.OutlookInstaller.exe /update /server=https://domain.com

An Outlook App installed under Program Files (see parameters /localhost) cannot perform an auto update or user update. In this case, the update must be carried out by an administrator.

Cloud server

Without command line arguments, Vertec.CloudServer can only be run by Windows ServiceManager.

Parameters Description
/noservice

Starts the CloudServer as executable (no service, as administrator or port binding)

Vertec.CloudServer.exe /noservice
/install
[Service Name]
[Service Display Name]

Installs the Vertec cloud service (as administrator). The command can be executed completely without parameters. However, the service name must be unique. The service display name is optional.

Each service needs its own installation with its own configuration (Vertec.ini). Important settings are server port, secure server port and management port – these must not overlap. See also the article about Multiple Cloud Server instances .

Vertec.CloudServer.exe /install Vertec.CloudServer2
/uninstall
[Service Name]

Uninstalls the Vertec cloud service (as administrator). The parameter is optional (must match the installed name).

Vertec.CloudServer.exe /uninstall
/service

Used only internally by Windows Service Manager. The parameter gives the Vertec Cloud Server the service name to start as. At startup, it is checked whether this name matches a registered Windows service.

Vertec.CloudServer.exe /service
/start
[Service Name]

Starts the Vertec cloud service (as administrator). The parameter is optional (must match the installed name).

Vertec.CloudServer.exe /start
/stop
[Service Name]

Stops the Vertec cloud service (as administrator). The parameter is optional (must match the installed name).

Vertec.CloudServer.exe /stop
/certcreate

Creates a self-signed certificate and registers it in the (local machine) certificate store, see Cloud Server (as administrator).

Vertec.CloudServer.exe /certcreate
/csrcreate

Opens a command prompt with the settings and creates a certificate signing request (as administrator).

Vertec.CloudServer.exe /csrcreate
/certbind

Required only if the Vertec.CloudServer is not operated with administrator rights or has triggered a binding error.

Binds the specified certificate to an endpoint (port) once.

The command requires the following settings in the Vertec.ini configuration file:

  • Certificate name (read access)
  • Secure server port (read access)
  • Trusted certificate (write access)
Vertec.CloudServer.exe /certbind
/certunbind

Removes the certificate binding from the endpoint (port) once.

The command requires the secure server port setting in the Vertec.ini configuration file.

Vertec.CloudServer.exe /certunbind
/status
[Service Name]

Shows the service status. The parameter is optional (must match the installed name).

Vertec.CloudServer.exe /status
/help
[Service Name]

Shows the help. The parameter is optional (must match the installed name).

Vertec.CloudServer.exe /help

Desktop App (Vertec On-Premises only)

Parameters Description
/batch

The Vertec process is started, but the program does not appear on the interface. Used in particular for scheduling .

/batch_nologin

Available from version 6.1.0.12. The Desktop App starts in batch mode and exits the application before logging in. /batch_nologin has the following impact:

  • Vertec.Desktop starts in batch mode (see also parameters /batch )
  • Any errors are shown on the command line, %errorlevel% is 1 instead of 0
  • The application is exited before login.
  • If the Vertec version has changed, default data is run through (see also Parameter /DD )

Is only useful for executing default data and cannot be combined with other parameters such as /script because Vertec is closed again before starting.

/culture

Changes the country setting of the client (number and date format).
Codes according to https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20)

Vertec.Desktop.exe /culture:en-US
/DB <DB-Name>

Starts a database other than the default one. The name must correspond to the database section in Vertec.ini – File .

/DB TestDB
/DC

Starts the database converter instead of Vertec. See also the article about updating Vertec.

/DD

Performs a standard data check when starting Vertec. Normally, such a check is performed automatically when starting Vertec with a new program version.

/gendb <Path>

Available from Vertec 6.6.0.6. Firebird only. With this parameter, you can generate a new local, empty Vertec database and save it on the specified path.

You must specify the path and the database name, e.g. V:\DB\MyEmptyVertec.fdb.

A local Firebird installation is required. Calling up Vertec.Desktop.exe with the parameter is not enough.

Note: If a database with the same name already exists at this location, it will be overwritten without any notification if it is not currently in use. Therefore, you must proceed with caution so as not to accidentally overwrite a productive database.

/NODD

Skips default data, even if it would actually run through due to a version jump. Not recommended.

/noevents

Administrators only. Deactivates the event scripts until logout.

Starting the Desktop App with the /noevents parameter is only intended for debugging and data migrations, and can lead to inconsistent data in production.

To check if the logged-in user is an administrator, /noevents can only be evaluated after login. This means that event scripts of type Login are always executed.

/password

Indication of the /login password. It is mainly used for scheduling.

/paysync

To automate the payment import, e.g. to run it overnight via batch file, the Desktop App can be started with the parameter /paysync.

/regserver

The Vertec COM Server is automatically registered with Desktop App Setup (requires administrator rights). For manual registration, e.g. for troubleshooting or installation by a software distribution, the Vertec.Desktop.exe can be called up with this parameter.

Vertec.Desktop.exe /regserver
/releaseupgradelock

If a database is converted or if the system detects a version change meaning that the Desktop App needs to adjust certain things, it is locked for access during this time. If an error occurs during this process, it may happen that this lock, the so-called upgrade lock, remains in place. The following message always appears:

To reset this lock, you can use the Desktop App with the parameter /releaseupgradelock This resets the upgrade lock on the database and exits Vertec immediately.

/setlicense <liccode> <licname> <licdbcode>

Available from version 6.1.0.10. Allow you to set a license code. The following rules apply:

  • The Licname and Licdbcode parameters are optional for existing databases.
  • The licdbcode can only be set for new databases and is only used internally by Vertec.
  • If the specified license information is invalid, an error is reported and no changes are made.
  • The error is shown on the command line in batch mode, %errorlevel% is 1 instead of 0.
  • The application is exited before login.
/setpassword <benutzer> <password>

Available from version 6.1.0.11. Allows you to set a user password. The following rules apply:

  • The user must be active
  • No password must be set yet. If the password is not empty, an error is reported
  • The error is shown on the command line in batch mode, %errorlevel% is 1 instead of 0.
  • The application is exited before login
/script <script>

Can only be called up by an administrator. Invokes a script in Vertec. The parameter specifies the name of the script, which corresponds to the designation of the registered script in Vertec. If several /script arguments exist, they are executed one after the other. Only registered scripts are supported. As of version 6.1.0.11, Python scripts that are on the file system (with extension .py) are also supported. In this case, the file path must be passed as a parameter.

/silentdbconvert

Available from version 6.2.0.5. Starts the database conversion without Windows dialogs for execution as a command line call.

Vertec.Desktop.exe /silentdbconvert

Supports only Firebird databases.

  • Starts the convert and outputs the progress via stdout.
  • If it is not a Firebird database or if the database cannot be accessed, an error is reported. Also reported via stdout, return code <> 0.
/super

To run the Desktop App in SUPER mode, it must be started with the parameter /super and the logged-in user must also have the super right (rtSuper).

SUPER mode has the following consequences:

  • Allows SystemContext in scripts in interactive mode (otherwise only for registered scripts with advanced privileges).
  • Allows use of Invoice.SetTotal method (COM). Used to place invoice totals on charged invoices (used in migrations).
  • Skips the cascaded deletion rights check when deleting objects. The deletion right is only checked on the original object.
  • General rights check: Prevents the effect of final rights, i.e. the SUPER mode allows everything, even things that are otherwise forbidden by business logic.

We recommend that you exercise caution when using Vertec in SUPER mode. Due to its extensive capabilities, Vertec can be brought into an inconsistent, non-operational state.

/username

Indicates the login name, together with the /password . Used mainly for scheduling.

/unregserver

Removes the registration of Vertec COM server .

Bitte wählen Sie Ihren Standort