Kommandozeilen-Parameter

Vertec mit Kommandozeilen-Parametern starten

Produktlinie

Standard

|

Expert

Betriebsart

CLOUD ABO

|

ON-PREMISES

Module

Leistung & CRM

Budget & Teilprojekt

Fremdkosten

Ressourcenplanung

Business Intelligence

Erstellt: 29.07.2003
Aktualisiert: 14.05.2024 | Schreibfehler beim Parameter /password korrigiert.

Verschiedene Vertec Apps sowie der Cloud Server können mit Parametern gestartet werden. Diese sind hier nachfolgend beschrieben.

Verfügbare Parameter

Cloud App

Parameter Bedeutung
/batch

Ab Vertec 6.5.0.22. Der Vertec-Prozess wird gestartet, aber das Programm erscheint nicht auf der Oberfläche.

Die Authentisierung erfolgt entweder über /username + /password oder über den Loginscreen.

Im Batchmodus wird die Software nach Ausführen der angegebenen Aktion(en) automatisch wieder beendet.

/culture:<code>

Ändert die Ländereinstellung des Clients (Zahlen- und Datumsformat).
Codes gemäss https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20)

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

Ab Version 6.5.0.22. Nur Administratoren.

Deaktiviert das Eventscript System für die aktuelle Session. Diese Option ist nützlich für das Debugging von Problemen, die durch Eventscripts verursacht werden.

/noupdate

Unterdrückt das automatische Update (siehe Einstellung AutoUpdate im Vertec.ini File).

Vertec.Cloud.exe /noupdate
/paysync

Ab Vertec 6.5.0.22. Um den Zahlungsabgleich zu automatisieren kann die Cloud App mit dem Parameter /paysync gestartet werden.

/regserver

Der Vertec COM Server wird mit dem Cloud App Installer automatisch registriert (benötigt Administratorrechte). Für die manuelle Registrierung, z.B. zur Fehlerbehebung oder bei einer Installation durch eine Softwareverteilung, kann Vertec.Cloud.exe mit diesem Parameter aufgerufen werden.

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

Ab Vertec 6.5.0.22. Führt den via Namen angegebenen Scripteintrag oder die angegebene Script-Datei aus. Kann nur von einem Administrator ausgeführt werden. Die Session bleibt anschliessend gestartet, die Cloud App kann normal weiterverwendet werden.

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

Ab Vertec 6.5.0.22. Um die Cloud App im SUPER Modus auszuführen, muss sie mit dem Parameter /super aufgestartet werden und der angemeldete Benutzer muss zusätzlich über das Super-Recht (rtSuper) verfügen.

Der SUPER Modus hat folgende Auswirkungen:

  • Erlaubt SystemContext() in Scripts im interaktiven Modus (sonst nur für registrierte Scripts mit erweiterten Rechten).
  • Erlaubt Verwendung von Rechnung.SetTotal Methode (COM). Dient zum Setzen von Rechnungstotalen auf verrechneten Rechnungen (wird in Migrationen verwendet).
  • Überspringt beim Löschen von Objekten die kaskadierte Prüfung von Löschrechten. Es wird nur das Löschrecht auf dem ursprünglichen Objekt geprüft.
  • Allgemeine Rechteprüfung: verhindert Effekt von finalen Rechten, das heisst, der SUPER Modus darf alles, auch Dinge, die von Businesslogik her sonst verboten sind.

Bei der Verwendung von Vertec im SUPER Modus ist Vorsicht geboten. Durch die weitreichenden Möglichkeiten kann man Vertec in einen inkonsistenten, nicht mehr lauffähigen Zustand bringen.

/server <Server URL>

Die Cloud App bestimmt die Server Adresse nach folgender mehrstufiger Logik:

  1. /server Parameter mit Server URL
  2. "Server"-Wert unter [CloudApp] .ini Section
  3. Zusammengesetzte Werte der [CloudServer] .ini Section
Vertec.Cloud.exe /server http://localhost:8081/
/unregserver

Nur Administratoren. Unregistriert den COM Server (Typelibrary)

Vertec.Cloud.exe /unregserver
Vertec URL

URL des Objekts, mit dem Vertec gestartet werden soll.

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

Cloud Installer (Cloud App)

Beim Cloud Installer handelt es sich um das Vertec.CloudInstaller.exe, mit welchem die Cloud App lokal installiert wird. Ohne Command Line Arguments wird /update ohne Optionen ausgeführt.

Parameter Bedeutung
/install

Lädt Vertec.Cloud.exe herunter und speichert es mitsamt der Konfigurationsdatei im aktuellen Verzeichnis, in dem sich der Cloud Installer befindet (ohne optionale Komponenten ).

  • Der Servername, von wo Vertec.Cloud.exe heruntergeladen wird (Ihre Vertec-Domain), wird mit dem Parameter /server angegeben oder im Filenamen encodiert (siehe Beispiele).
  • Ein alternatives Verzeichnis kann ab Version 6.5.0.20 mit dem Parameter /dir angegeben werden.

Beispiele:

  • Vertec.CloudInstaller.exe /install /server=https://domain.com  lädt Vertec.Cloud vom Server, der mit /server angegeben wurde.
  • Vertec.CloudInstaller_https_domain.com_port.exe /install lädt Vertec.Cloud vom Server, der in der URL codiert ist.
  • Vertec.CloudInstaller_https_domain.com_port.exe entspricht dem Download-File. Dieses kann ohne Parameter irgendwo gestartet werden. Der Download von Vertec.Cloud erfolgt vom Server, der im Filename encodiert ist. Es erfolgt die Standardinstallation in %localappdata%/Vertec Cloud App.
/installoptional

Gleich wie /install, aber mit optionalen Komponenten .

/dir

Ab Vertec 6.5.0.20. Gibt einen alternativen Ordner für die Installation an. Falls das Verzeichnis noch nicht existiert, wird versucht, dieses anzulegen. Ohne den Parameter /dir wird die Cloud App im Verzeichnis, in dem sich der Cloud Installer befindet, installiert. Der Name des Desktop-Icons erhält den Namen dieses Ordners.

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

Deinstalliert die Cloud App. Dies ist eine Alternative zur Deinstallation über "Programme hinzufügen oder entfernen".

Vertec.CloudInstaller.exe /uninstall
/update

Wird analog zu /install verwendet und aktualisiert die Cloud App.

Hinweis: Die Datei Vertec.CloudInstaller.exe muss aktuell sein, diese wird nur im Auto Update Fall automatisch neu vom Server geholt.

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

Angabe der entsprechenden Domain. Alternativ kann der Servername auch im Installername encodiert sein, dann entfällt der Parameter /server. (siehe Parameter bzw. /update).

/silent

Ab Vertec 6.5.0.20. Wird der Cloud Installer mit /silent gestartet, werden keine Benutzeroberfläche bzw. keine Dialoge angezeigt. Um einen Restart während der Installation zu verhindern, verwenden Sie zusätzlich den Parameter /norestart.

Im Fehlerfall (Schreibrechte, Admin-Rechte für Runtime Installation, Zielverzeichnis nicht schreibbar etc.) ist der Rückgabewert != 0. In der Konsole wird die Fehlermeldung ausgegeben. 

/norestart
Ab Vertec 6.7.0.6. Unterdrückt bei der Verwendung von /silent einen eventuellen Restart am Ende der Installation.

Outlook Installer (Outlook App)

Beim Outlook Installer handelt es sich um das Vertec.OutlookInstaller.exe , mit welchem die Windows Edition der Outlook App lokal installiert wird. Ohne Command Line Arguments wird /update ohne Optionen ausgeführt.

Parameter Bedeutung
/install

Installiert die Outlook App Windows Edition für den aktuellen Benutzer lokal. Der Servername, von wo die Outlook App heruntergeladen wird (Ihre Vertec-Domain), wird mit dem Parameter /server angegeben oder im Filenamen encodiert. Es erfolgt die Standardinstallation in %LocalAppData%\Vertec Outlook App .

Beispiele:

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

lädt die Outlook App Windows Edition vom Server, der mit /server angegeben wurde.

Vertec.OutlookInstaller_https_domain.com_80.exe /install 

lädt Outlook App Windows Edition vom Server, der in der URL codiert ist (Download via App Portal ).

/server

Ab Version 6.6.0.10. Muss angegeben werden, wenn sich der Servername nicht aus dem Dateinamen des Outlook Installers bestimmen lässt bzw. wenn kein Download aus dem App Portal verwendet wird.

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

Ab Vertec 6.6.0.10. Gibt einen alternativen Ordner für die Installation an. Falls das Verzeichnis noch nicht existiert, wird versucht, dieses anzulegen.

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

Falls nicht angegeben, wird die Outlook App unter %LocalAppData%\Vertec Outlook App , bzw. mit Argument /localmachine unter Program Files\Vertec Outlook App installiert.

/localmachine

Ab Version 6.6.0.10. Der Outlook App Installer kann durch einen Administrator mit dem Argument /localmachine ausgeführt werden und installiert damit die Outlook App für alle Benutzer des Rechners.

Die Installation erfolgt standardmässig in %ProgramFiles%\Vertec Outlook App .

Hinweis: Eine unter Program Files installierte Outlook App kann nur durch einen Administrator geupdatet werden.

/silent

Ab Version 6.6.0.10. Wird der Outlook App Installer zusätzlich mit /silent gestartet, werden keine Benutzeroberfläche bzw. keine Dialoge angezeigt.

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

Ein Administrator kann die Outlook App lokal deinstallieren.

Der Server muss dabei nicht angegeben werden, ausser die Installation erfolgte in einem alternativen Verzeichnis ( /dir ). Mit /localmachine wird die App für alle Benutzer entfernt. Optional kann /silent mitgegeben werden.

Vertec.OutlookInstaller.exe /uninstall

Mit /uninstall /dir wird das Verzeichnis mit seinem gesamten Inhalt wieder entfernt.

/update

Aktualisiert die Outlook App Windows Edition. Die Datei Vertec.OutlookInstaller.exe muss dafür aktuell sein.

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

Eine unter Program Files installierte Outlook App (siehe Parameter /localhost ) kann keinen Auto Update  bzw. Update durch den Benutzer durchführen. In diesem Fall muss das Update durch einen Administrator erfolgen.

Cloud Server

Ohne Command Line Arguments kann Vertec.CloudServer ausschliesslich vom Windows ServiceManager ausgeführt werden.

Parameter Bedeutung
/noservice

Startet den CloudServer als Executable (kein Service, als Administrator oder port binding)

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

Installiert den Vertec Cloud Service (als Administrator). Der Befehl kann komplett ohne Parameter ausgeführt werden. Der Service Name muss jedoch einmalig sein. Der Service Anzeigename ist Optional.

Jeder Service braucht eine eigene Installation mit eigener Konfiguration (Vertec.ini). Wichtige Einstellungen sind dabei Server Port, Secure Server Port und Management Port - diese dürfen sich nicht überschneiden. Siehe dazu auch den Artikel über Mehrere Cloud Server Instanzen .

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

Deinstalliert den Vertec Cloud Service (als Administrator). Der Parameter ist optional (muss mit dem installierten Namen übereinstimmen).

Vertec.CloudServer.exe /uninstall
/service

Wird nur intern vom Windows Service Manager verwendet. Der Parameter übergibt dem Vertec Cloud Server den Service Namen, als den er starten soll. Beim Start wird geprüft, ob dieser Name mit einem registrierten Windows Dienst übereinstimmt.

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

Startet den Vertec Cloud Service (als Administrator). Der Parameter ist optional (muss mit dem installierten Namen übereinstimmen).

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

Stoppt den Vertec Cloud Service (als Administrator). Der Parameter ist optional (muss mit dem installierten Namen übereinstimmen).

Vertec.CloudServer.exe /stop
/certcreate

Erstellt ein Self-Signed Certificate und registriert dieses im (Local-Machine) Zertifikats-Store, siehe Cloud Server (als Administrator).

Vertec.CloudServer.exe /certcreate
/csrcreate

Öffnet ein Command Prompt mit den Einstellungen und erstellt einen Certificate Signing Request (als Administrator).

Vertec.CloudServer.exe /csrcreate
/certbind

Wird nur benötigt, falls der Vertec.CloudServer nicht mit Administrator-Rechten betrieben wird oder einen Binding Fehler ausgelöst hat.

Bindet einmalig das angegebene Zertifikat an einen Endpunkt (Port).

Der Befehl benötigt folgende Einstellungen in der Konfigurationsdatei Vertec.ini:

  • Certificate Name (Lesezugriff)
  • Secure Server Port (Lesezugriff)
  • Trusted Certificate (Schreibzugriff)
Vertec.CloudServer.exe /certbind
/certunbind

Entfernt einmalig das Binding des Zertifikates vom Endpunkt (Port).

Der Befehl benötigt die Einstellung Secure Server Port in der Konfigurationsdatei Vertec.ini.

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

Zeigt den Status des Services an. Der Parameter ist optional (muss mit dem installierten Namen übereinstimmen).

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

Zeigt die Hilfe an. Der Parameter ist optional (muss mit dem installierten Namen übereinstimmen).

Vertec.CloudServer.exe /help

Desktop App (nur Vertec On-Premises)

Parameter Beschreibung
/batch

Der Vertec-Prozess wird gestartet, aber das Programm erscheint nicht auf der Oberfläche. Wird vor allem beim Scheduling gebraucht.

/batch_nologin

Ab Version 6.1.0.12. startet die Desktop App im Batch Modus und beendet die Applikation vor dem Login wieder. Die Angabe von /batch_nologin bewirkt Folgendes:

  • Vertec.Desktop startet im Batch-Modus (siehe auch Parameter /batch)
  • Allfällige Fehler werden auf der Commandline angezeigt, %errorlevel% ist dann 1 statt 0
  • Die Applikation wird vor dem Login beendet.
  • Wenn die Vertec Version geändert hat, wird Defaultdata durchlaufen (siehe auch Parameter /DD)

Ist nur sinnvoll für die Ausführung von Defaultdata und kann nicht mit anderen Parametern wie /script kombiniert werden, da Vertec vor dem Start wieder geschlossen wird.

/culture

Ändert die Ländereinstellung des Clients (Zahlen- und Datumsformat).
Codes gemäss https://docs.microsoft.com/en-us/previous-versions/commerce-server/ee825488(v=cs.20)

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

Startet eine andere als die Standard Datenbank. Der Name muss der Datenbank Section im Vertec.ini - File  entsprechen.

/DB TestDB

Darf nicht für produktive Instanzen verwendet werden, da damit die Notif Datenaktualisierung nicht läuft.

/DC

Startet statt Vertec den Datenbankkonverter. Siehe dazu auch den Artikel über den Update von Vertec.

/DD

Führt beim Start von Vertec eine Standarddaten Kontrolle durch. Normalerweise erfolgt ein solcher Kontrolldurchgang automatisch, wenn Vertec mit einer neuen Programmversion gestartet wird.

/gendb <Path>

Ab Vertec 6.6.0.6. Nur Firebird. Mit diesem Parameter kann eine neue lokale, leere Vertec Datenbank generiert und am angegebenen Pfad abgelegt werden.

Es muss ein Pfad sowie der Name der Datenbank angegeben werden, z.B. V:\DB\MyEmptyVertec.fdb.

Es braucht dafür eine lokale Firebird Installation, der reine Aufruf von Vertec.Desktop.exe mit dem Parameter reicht nicht.

Achtung: Befindet sich an dieser Stelle bereits eine Datenbank mit gleichem Namen, dann wird sie ohne Meldung überschrieben, falls sie nicht gerade verwendet wird. Das muss also mit Vorsicht durchgeführt werden, um nicht aus Versehen eine produktive Datenbank zu überschreiben.

/NODD

Defaultdata überspringen, auch wenn es aufgrund eines Versionssprungs eigentlich durchlaufen würde. Nicht empfehlenswert.

/noevents

Nur Administratoren. Deaktiviert die Eventscripts bis zum Logout.

Das Starten der Desktop App mit dem /noevents Parameter ist nur für Debugging und Daten-Migrationen gedacht und kann im produktiven Betrieb zu inkonsistenten Daten führen.

Um zu überprüfen, ob der eingeloggte Benutzer Administrator ist, kann /noevents erst nach dem Login ausgewertet werden. Das bedeutet, dass Eventscripts vom Typ Login immer ausgeführt werden.

/password

Angabe des zum /login passenden Passwortes. Wird vor allem beim Scheduling gebraucht.

/paysync

Um den Zahlungsabgleich zu automatisieren, also zum Beispiel via Batch-File über Nacht laufen zu lassen, kann die Desktop App mit dem Parameter /paysync gestartet werden.

/regserver

Der Vertec COM Server wird beim Desktop App Setup automatisch registriert (benötigt Administratorrechte). Für die manuelle Registrierung, z.B. zur Fehlerbehebung oder bei einer Installation durch eine Softwareverteilung, kann Vertec.Desktop.exe mit diesem Parameter aufgerufen werden.

Vertec.Desktop.exe /regserver
/releaseupgradelock

Wird eine Datenbank konvertiert, oder wird vom System ein Versionswechsel festgestellt, so dass die Desktop App gewisse Dinge anpassen muss, ist sie während dieser Zeit für den Zugriff gesperrt. Tritt nun während dieses Prozesses ein Fehler auf, kann es sein, dass diese Sperre, der sogenannte Upgrade-Lock, bestehen bleibt. Es erscheint dann immer folgende Meldung:

Um diese Sperre zurückzusetzen, können Sie die Desktop App mit dem Parameter /releaseupgradelock starten. Dieser setzt den Upgrade-Lock auf der Datenbank zurück und beendet Vertec gleich wieder.

/setlicense <liccode> <licname> <licdbcode>

Ab Version 6.1.0.10. Erlaubt das Setzen eines Lizenzcodes. Es gelten folgende Regeln:

  • Die Parameter Licname und Licdbcode sind bei bestehenden Datenbanken optional.
  • Der Licdbcode kann nur bei neuen Datenbanken gesetzt werden und wird nur Vertec intern gebraucht.
  • Falls die angegebenen Lizenzangaben ungültig sind, wird ein Fehler gemeldet und es werden keine Änderungen vorgenommen.
  • Der Fehler wird im Batchmodus auf der Commandline angezeigt, %errorlevel% ist dann 1 statt 0.
  • Die Applikation wird vor dem Login beendet.
/setpassword <benutzer> <password>

Ab Version 6.1.0.11. Erlaubt das Setzen des Passworts eines Users. Es gelten folgende Regeln:

  • Der User muss aktiv sein
  • Es darf noch kein Passwort gesetzt sein. Falls das Passwort nicht leer ist, wird ein Fehler gemeldet
  • Der Fehler wird im Batchmodus auf der Commandline angezeigt, %errorlevel% ist dann 1 statt 0.
  • Die Applikation wird vor dem Login beendet
/script <script>

Kann nur von einem Administrator aufgerufen werden. Ruft ein Script in Vertec auf. Der Parameter gibt den Namen des Scripts an, welcher der Bezeichnung des in Vertec registrierten Scripts entspricht. Falls mehrere /script Argumente vorhanden sind, werden diese nacheinander ausgeführt. Es werden nur registrierte Scripts und ab Version 6.1.0.11 auch Python Scripts, welche auf dem Filesystem liegen (mit Endung .py), unterstützt. In diesem Fall muss als Parameter der Dateipfad übergeben werden.

/silentdbconvert

Ab Version 6.2.0.5. Startet die Datenbank-Konvertierung ohne Windows Dialoge für die Ausführung als Commandline Aufruf.

Vertec.Desktop.exe /silentdbconvert

Unterstützt nur Firebird Datenbanken.

  • Startet den Convert und gibt den Fortschritt über stdout aus.
  • Falls es sich nicht um eine Firebird Datenbank handelt oder kein Zugriff auf die Datenbank möglich ist, wird ein Fehler gemeldet. Ebenfalls über stdout gemeldet, Return-code <> 0.
/super

Um die Desktop App im SUPER Modus auszuführen, muss sie mit dem Parameter /super aufgestartet werden und der angemeldete Benutzer muss zusätzlich über das Super-Recht (rtSuper) verfügen.

Der SUPER Modus hat folgende Auswirkungen:

  • Erlaubt SystemContext in Scripts im interaktiven Modus (sonst nur für registrierte Scripts mit erweiterten Rechten).
  • Erlaubt Verwendung von Rechnung.SetTotal Methode (COM). Dient zum Setzen von Rechnungstotalen auf verrechneten Rechnungen (wird in Migrationen verwendet).
  • Überspringt beim Löschen von Objekten die kaskadierte Prüfung von Löschrechten. Es wird nur das Löschrecht auf dem ursprünglichen Objekt geprüft.
  • Allgemeine Rechteprüfung: verhindert Effekt von finalen Rechten, das heisst, der SUPER Modus darf alles, auch Dinge, die von Businesslogik her sonst verboten sind.

Bei der Verwendung von Vertec im SUPER Modus ist Vorsicht geboten. Durch die weitreichenden Möglichkeiten kann man Vertec in einen inkonsistenten, nicht mehr lauffähigen Zustand bringen.

/username

Angabe des Login Namens, zusammen mit dem /password. Wird vor allem beim Scheduling gebraucht.

/unregserver

Entfernt die Registrierung des Vertec COM Servers .

Bitte wählen Sie Ihren Standort