Client-Installation

Hier finden Sie die Systemvoraussetzungen und eine Anleitung für die Installation des primedocs-Windows-Clients.



Systemvoraussetzungen

Betriebssystem

Der primedocs-Client kann auf folgenden Betriebssystemen installiert werden:

Unterstützte Microsoft Office-Versionen

primedocs unterstützt alle Microsoft Office-Versionen ab Office 2013, sowohl in der 32-bit- als auch in der 64-bit-Variante. primedocs unterstützt die früheren Versionen von Microsoft Windows und von Microsoft Office für Windows bis zu deren Lebensende, d. h. bis zum Ende der "erweiterten Supportdauer" von Microsoft zu den jeweiligen Produkten.

.NET Framework

Für den primedocs-Client ist mindestens das .NET Framework 4.8 vorausgesetzt.

CPU & Arbeitsspeicher

Es wird empfohlen, mindestens eine CPU mit 1.6 GHz und 2 Cores zu verwenden.

Als Arbeitsspeicher sollten mindestens 4 GB RAM verwendet werden. Da primedocs sich in die Office Produkte integriert und es daher wahrscheinlich ist, dass neben primedocs auch Microsoft Word, Outlook oder Teams laufen, empfiehlt es sich, mindestens 8 GB RAM einzuplanen.

Festplattenspeicher

Die Software selbst benötigt etwa 200 MB Festplattenspeicher. Der primedocs-Client speichert zudem Log-Dateien zur Fehlerbehandlung und Einstellungen und legt zusätzlich einen lokalen Cache für die Offline-Nutzung an. Die Größe des Caches ist abhängig von der Anzahl und Größe der Vorlagen.

Auflösung

Für den primedocs-Client wird eine Bildschirmauflösung von mindestens 1024 * 768 vorausgesetzt.


Client-Authentifizierung

"Software as a Service"-Variante

In der "Software as a Service"-Variante werden serverseitige Komponenten eingesetzt, welche die Anmeldeanfragen zu Ihrem Azure Active Directory weiterleiten. Bei dieser Variante müssen während der Installation die beiden Parameter ClientId und ClientSecret angegeben werden.

OnPremises-Standardvariante: (siehe OnPremises-Varianten)

In der Standardvariante werden serverseitige Komponenten eingesetzt, welche die Anmeldeanfragen zu Ihrem Active Directory weiterleiten. Bei dieser Variante müssen während der Installation die beiden Parameter ClientId und ClientSecret angegeben werden.

OnPremises-"WithoutIdS"-Variante: (siehe OnPremises-Varianten)

Bei der "WithoutIdS"-Variante ist es erforderlich, dass sich primedocs-Client und -Server in der gleichen bzw. in einer über eine Vertrauensstellung authorisierten Domäne befinden.


32-bit oder 64-bit

Den primedocs-Installer gibt es in einer 32- oder 64-bit-Variante. Die benötigte Variante ist abhängig von der verwendeten Microsoft Office-Version. Wird ein 64-bit-Office verwendet, muss die 64-bit-primedocs-Version installiert werden.


Ports & Server-Verbindung

Der primedocs-Client kommuniziert ausschliesslich über HTTP/HTTPS mit dem primedocs-Server. Damit wird in der Standardkonfiguration nur Port 80 bzw. 443 benötigt.


MSI-Parameter

Das primedocs-MSI-Paket enthält den primedocs-Client und die Microsoft Office-AddIns.

primedocs-spezifische Parameter

  • APPLICATIONFOLDER: Installationsverzeichnis (Standard ist C:\Program Files (x86)\primedocs)

  • INSTALLDESKTOPSHORTCUT: 1 / 0 für Ja oder Nein

  • AUTOSTART: 1 / 0 für Ja oder Nein

  • SERVICEENDPOINTURL: Service-Endpunkt (kann via Registry überschrieben werden)

  • ADDLOCAL: Features

    • WordAddInFeature: Word-Add-In für “classic”-Vorlagen - bei Verwendung muss das CommonAddInWordFeature ebenfalls installiert sein, da dies die Textbausteine verwaltet!

    • OutlookAddInFeature: Outlook-Add-In

    • Diese Liste umfasst alle Common-Add-Ins (Modernes Add-In für PowerPoint/Excel/Word):

      • CommonAddInWordFeature: Word-Add-In für neue Vorlagentypen

      • CommonAddInPowerPointFeature: PowerPoint-Add-In

      • CommonAddInExcelFeature: Excel-Add-In

Die folgenden Parameter werden nur in bestimmten Installationsvarianten (z. B. Installation auf Terminal-Servern) benötigt und sind optional:

  • DATAINLOCALAPPDATAFOLDER: False/True (muss True sein bei Netzlaufwerken)

  • CACHEFOLDER: Pfad, z. B. \\Share\... (mit Platzhaltern wie %username% von Umgebungsvariablen etc.)

  • SETTINGFOLDER: Pfad, z. B. \\Share\... (mit Platzhaltern wie %username% von Umgebungsvariablen etc.)

  • SHUTDOWNONDISCONNECT: true/false (wenn true: primedocs wird bei einem Verbindungsabbruch wie z. B. beim Beenden einer RDP-Sitzung beendet)

  • TRYSYNCONLOGOFF: true/false (wenn true: primedocs wird bei einem Windows Session Logoff versuchen die letzten Änderungen zum Server zu synchronisieren.)

  • LOGFOLDER: Pfad für Speicherung der Logdateien mit NLog-Platzhaltern (siehe Layout renderers, Special Folder Layout Renderer und Environment.SpecialFolder Enum)

    • Beispiele: \\Share\..., ${specialfolder:LocalApplicationData}\Logs\primedocs

    • Achtung: Der Zugriff auf Umgebungsvariablen wie in %LOCALAPPDATA%\Logs wird von NLog nicht unterstützt – bitte stattdessen die "Special Folders" benützen.
      Bitte beachten, dass ${specialfolder:LocalAppData} nicht gültig ist, da es keinen Special Folder namens LocalAppData gibt. ${specialfolder:LocalApplicationData} hingegen ist gültig, da es den Special Folder namens LocalApplicationData gibt.

  • ENCRYPTCACHE: false/true (Standard ist false, wenn true: primedocs verschlüsselt den Offline-Cache. Mehr...) (kann via Registry überschrieben werden)

  • SILENTSSOAUTHENTICATIONTRYONSTARTUP: false/true (Standard ist false, wenn true: Beim Start von primedocs wird im Hintergrund ein Loginversuch unternommen, der funktioniert, wenn bei On-Premises-Umgebungen mit IdentityServer die automatische Windows-Authentifizierung greift) (kann via Registry überschrieben werden)

  • SILENTSSOAUTHENTICATIONTIMEOUTINSECONDS: (Standard ist 30, Timeout für den Loginversuch im Hintergrund) (kann via Registry überschrieben werden)

  • ACCESSIBILITYFOCUSNONINTERACTIVEELEMENTS: Standard ist false, wenn true: Nicht interaktive Elemente (z. B. Textelemente beim Dokument-Parameter) können per Tastatur fokussiert werden und so einfacher von Screen Reader Software erfasst werden. (kann via Registry überschrieben werden)

  • DEFAULTDATASOURCEID: Standard ist “leer” und die primäre DataSource wird automatisch gewählt. Wenn gesetzt: Die DataSource mit der gewählten ID wird als "Start-Datenbank" genutzt. (kann via Registry überschrieben werden)

  • USELAZYLOADINGCACHE: Standard ist false, wenn true: Die Synchronisierung lädt Vorlagen- und Textbausteindaten erst bei aktiver Verwendung der Vorlage bzw. des Textbausteins. Dieser Modus setzt voraus, dass der Client immer Zugriff auf den Service hat. (kann via Registry überschrieben werden)

  • Ribbon spezifische Einstellungen (kann via Registry überschrieben werden)

Folgende Parameter werden in der "Software as a Service"-Variante und in der OnPremises-Standardvariante benötigt:

  • AUTHCLIENTID: Client ID für den Zugriff auf das primedocs-Authentifizierungssystem (kann via Registry überschrieben werden)

  • AUTHCLIENTSECRET: Client Secret für den Zugriff auf das primedocs-Authentifizierungssystem (kann via Registry überschrieben werden)

Ansonsten gelten die normalen MSIEXEC Command-Line Options.

Beispiel (CMD) (installiert alle Add-Ins):

msiexec /qb /i "primedocs.Install(x86).msi" APPLICATIONFOLDER="C:\Program Files (x86)\primedocs" SERVICEENDPOINTURL="https://appurl/Service/primedocs.svc" AUTHCLIENTID="DefaultClient" AUTHCLIENTSECRET="GENERATED_PASSWORD" SILENTSSOAUTHENTICATIONTRYONSTARTUP="true" INSTALLDESKTOPSHORTCUT=1 AUTOSTART=1 /l* PrimeDocsInstall.log AddLocal=CommonAddInWordFeature,CommonAddInPowerPointFeature,CommonAddInExcelFeature,WordAddInFeature,OutlookAddInFeature

HINWEIS
Das Beispiel von oben funktioniert so nur in CMD.
In PowerShell müssten die Argumente anders übergeben werden.

HINWEIS
Bei der Verwendung von Platzhaltern wie %username% oder %appdata% muss dies beim CMD-Aufruf korrekt maskiert werden, ansonsten wird der Wert direkt beim Aufruf umgewandelt.

Beispiel in einer eigenen Datei (doppelte % maskieren die Parameter):

  • msiexec /qb /i [...] CACHEFOLDER="D:\%%username%%\primedocs\" [...]

Beispiel für einen direkten Aufruf in der CMD (mit delayed environment variable expansion):

  • cmd /v /c msiexec /qb /i [...] CACHEFOLDER="D:\%username%\primedocs\" [...]

"Per-Machine"- und "Per-User"-Installation

Der Standardinstaller ist ein "Dual-Purpose-Package" und kann primedocs sowohl für alle Benutzer auf der Maschine ("Per-Machine") oder nur für den angemeldeten Benutzer ("Per-User") installieren. Im Standardfall wird primedocs für alle Benutzer installiert. Über den MSIEXEC-Parameter MSIINSTALLPERUSER=1 oder über die MSI-Oberfläche kann die Installationsvariante ausgewählt werden.

Konfigurationswerte über die Registry

Bestimmte primedocs-Konfigurationsparameter werden auch in der Registry gesucht – dies ist insbesondere bei der Verwendung von Group Policies nützlich.

Folgende Parameter werden als String-Value in der Registry gesucht:

  • ServiceAddress

  • AuthClientId

  • AuthClientSecret

  • EncryptCache

  • SilentSsoAuthenticationTryOnStartup

  • SilentSsoAuthenticationTimeoutInSeconds

Der Ablauf am Beispiel von der "ServiceAddress":

String-Value "ServiceAddress" wird unter diesen Schlüsseln (HKCU & HKLM) gesucht:

bzw.

bzw. (für Group-Policies geeignet)

Findet der Client diesen Wert, wird dieser anstelle der ServiceAddress aus der “primedocs.exe.config” verwendet. Um diese Einstellungen via Gruppenrichtlinien steuern zu können, stehen Primedocs-ADMX-Vorlagen zur Verfügung:


Single-Sign-On

In der OnPremises-Standardvariante kann der primedocs Client sich beim ersten Start auch automatisch mit dem aktuellen Windows-Benutzer am Authentifizierungssystem anmelden. Hierfür muss der MSI-Parameter SILENTSSOAUTHENTICATIONTRYONSTARTUP auf true gestellt werden. Damit die Anmeldedaten automatisch weitergegeben werden können, muss ausserdem der "Host" in der "Intranet Zone" des Internet Explorers gelistet sein.

Diese Einstellung lässt sich u. A. über eine Group Policy unter dem nachfolgenden Pfad konfigurieren:

bzw.

Dort muss die Policy Site to Zone Assignment List ("Liste der Site zu Zonenzuweisungen") geöffnet werden und folgende Daten müssen hinterlegt werden:

Der Value Name muss dem "Host" des primedocs-Servers entsprechen, d. h. "https://servername/" von "https://servername/Service/primedocs.svc" ist ausreichend.

Danach sollte sich der Client automatisch anmelden.


Installationsszenarien

Die Standardeinstellungen des primedocs-Installers zielen auf eine "normale" Installation auf einem System ab, das von einem oder mehreren Windows-Benutzern gestartet werden kann. Dabei werden sowohl der Cache als auch die Einstellungen unter %AppData% gespeichert.

Jede primedocs-Client-Instanz muss für die vollständige Funktionalität exklusiven Zugriff auf den Cache bekommen – ist das nicht der Fall (z. B. für einige Citrix/Terminal-Server Konfigurationen) muss der Speicherort des Cache angegeben werden.

Standardinstallation

Es werden keine weiteren Parameter benötigt, dabei werden Cache unter %LocalAppData% und Einstellungen unter %AppData% gespeichert.

Empfohlen für:

☑ Keine serverseitig gespeicherten Roaming-Profile

Cache & Einstellungen lokal

Sowohl der Cache als auch die Einstellungen können unter %LocalAppData% gespeichert werden, wenn dieser Parameter gesetzt wird:

Empfohlen für:

☑ serverseitig gespeicherte Roaming-Profile

%LocalAppData%-Ordner, der nicht gelöscht wird

☑ Benutzer, der immer auf derselben Maschine eingeloggt ist

Cache in spezifischen Ordner

Sollte sowohl %AppData% als auch %LocalAppData% nicht in Frage kommen oder kann es passieren, dass mehrere primedocs-Instanzen pro Benutzer offen sein könnten, kann über diese Einstellung der Cache-Speicherort spezifiziert werden:

  • CACHEFOLDER: Path, e.g. //Share/... (with Placeholders like %username% etc.)

Empfohlen für:

☑ Terminal Server-Installation mit mehrere offenen Sessions pro Benutzer

Voraussetzung:

☑ Angegebenes Netzwerk-Laufwerk, das immer vorhanden und erreichbar ist

Einstellungen in spezifischen Ordner

Die Einstellungen können ebenfalls wie der Cache in einen eigenen Ordner gespeichert werden:

  • SETTINGFOLDER: Path, e.g. //Share/... (with Placeholders like %username% etc.)


Outlook: "Roaming Signatures"-Feature deaktivieren

Es gibt ein Outlook-Feature, welches die Signaturen unter verschiedenen Outlook-Windows-Desktops synchronisiert. Dieses Feature ist nicht mit primedocs-Signaturen kompatibel.

Mit dem folgenden Registry-Eintrag kann das Feature deaktiviert werden:

HINWEIS
Dieser Registry-Eintrag wird vom Client automatisch gesetzt, sobald primedocs-Signaturen als Standardsignaturen gesetzt werden.

Registry-Files hierfür:

Informationen von Microsoft zu diesem Feature:


Anti-Viren Lösungen

Um Performance-Probleme im Betrieb zu vermeiden, sollte bei Einsatz einer Anti-Viren Lösung die Auswirkungen dessen bei einem ersten Test bzw. beim ersten Rollout genauer beachtet werden.
Sollte der Start von primedocs oder Microsoft Office beispielsweise erheblich langsamer als üblich sein, empfiehlt es sich, eine Ausnahme für das primedocs-Installationsverzeichnis sowie das Cache-Verzeichnis zu erstellen.
Weitere Informationen finden Sie Troubleshooting.

 

PrimeSoft AG, Bahnhofstrasse 4, 8360 Eschlikon, Switzerland