Microsoft Windows
There are two installation types:
- Fabasoft Cloud Enterprise Client
In general this type is the right choice. The Fabasoft Cloud Enterprise Client is installed for all users of this computer (so-called per-machine installation) and can be centrally distributed by administrators. But this installation requires administrative rights on your computer. In general, the Fabasoft Cloud Enterprise Client installation provides the appropriate settings so that the web browser extensions are installed automatically. - Fabasoft Cloud Client
If the Fabasoft Cloud Enterprise Client cannot be installed or distributed by an administrator on this computer, then this installation type (so-called per user installation) may be used as alternative. But be aware that local security policies deployed by administrators may prevent that the Fabasoft Cloud Client will work correctly. Moreover, the web browser extensions have to be installed separately.
Basically, the functionality of the Fabasoft Cloud Enterprise Client and Fabasoft Cloud Client is the same.
Attention: The installation of the Fabasoft Cloud Enterprise Client and the Fabasoft Cloud Client on the same computer is not supported.
Installing
Fabasoft Cloud Enterprise Client
To install the Fabasoft Cloud Enterprise Client (into the per-machine installation context), perform the following steps:
- Download the CloudClientEnterprise.msi installation package from the Fabasoft Cloud.
https://at.cloud.fabasoft.com/folio/fscasp/content/lib/CloudClientEnterprise.msi
Make sure that you have administrative rights. - Run the CloudClientEnterprise.msi installation package and follow the installation wizard.
The Fabasoft Cloud Enterprise Client is installed in the following folder:
C:\Program Files\Fabasoft\Cloud\Client\.
Note: The installation of the Fabasoft Cloud Client and the Fabasoft Cloud Enterprise Client on the same computer is not supported.
Fabasoft Cloud Client
To install the Fabasoft Cloud Client (into the per-user installation context), perform the following steps:
- Download the CloudClient.msi installation package from the Fabasoft Cloud.
https://at.cloud.fabasoft.com/folio/fscasp/content/lib/CloudClient.msi - Run the CloudClient.msi installation package and follow the installation wizard.
The Fabasoft Cloud Client is installed in the following folder: C:\Users\<username>\AppData\Local\Fabasoft\
Note:
- The installation of the Fabasoft Cloud Client and the Fabasoft Cloud Enterprise Client on the same computer is not supported.
- The Google Chrome or Microsoft Edge extension uses the “Native Messaging Host” to communicate with the Fabasoft Cloud Client. Ensure that the following key is not set or set to 1.
[HKEY_LOCAL_MACHINE\Software\Policies\Microsoft\Edge]
"NativeMessagingUserLevelHosts"=dword:00000001
[HKEY_LOCAL_MACHINE\Software\Policies\Google\Chrome]
"NativeMessagingUserLevelHosts"=dword:00000001
Fabasoft Cloud Enterprise Client
This chapter is about the advanced configuration for the Fabasoft Cloud Enterprise Client installation.
Browser Extensions
By default, the Fabasoft Cloud Enterprise Client setup will register all web browser extensions for all supported web browsers. The extension for Mozilla Firefox will always be installed locally. For Google Chrome and Microsoft Edge this will require a connection to the respective online extension store of the web browser. If no connection to the store is available you can specify that a local version of the extension should be registered instead. This only works for Microsoft Windows workstations that are joined to a Microsoft Active Directory domain (security feature of the web browsers).
msiexec /i <msipath> EXTLOCAL=1
Note:
- In addition to installing the local extension, the configuration parameters override_update_url, ExtensionInstallAllowList and NativeMessagingAllowlist are automatically set so that the extension can be functionally installed and updated. A more detailed description of the respective configuration parameters can be found on the websites of the web browser manufacturers.
- If the Fabasoft Cloud Enterprise Client Setup installs the local extension and therefore sets the configuration parameter override_update_url, the corresponding extension must not be installed via the store in the user profile of the web browser, otherwise the web browser extension will be marked as “broken”. The configuration parameter override_update_url is necessary for the web browser to update the locally installed extension.
- If the ExtensionInstallForceList or the ExtensionSettings policy is rolled out centrally in JSON format, no automatic registration and configuration of the web browser extensions takes place via the Fabasoft Cloud Enterprise Client setup. This is because the modified JSON string would be overwritten by the central deployment tool.
To prevent these web browser extensions from being installed, there are parameters that can be specified when installing the MSI package:
msiexec /i <msipath> CHROMEEXT=0 EDGEEXT=0 FIREFOXEXT=0 THUNDERBIRDEXT=0
For example, the following command disables the installation of the Google Chrome extension:
msiexec /i CloudClientEnterprise.msi CHROMEEXT=0
Native Client Service
The Native Client Service can be used to synchronize or provide data even without an interactively logged in user. The service is designed to run without user interaction, therefore a password for applications is used. If the Native Client Service is installed via setup, you will automatically be asked to create a password when you start synchronization. If the password is expired, you will automatically be asked to recreate a password. The password will be stored within the Credential Manager of Microsoft Windows.
The service is by default configured to automatically start with the operating system, so you do not have to log in after a restart of the system after you have configured the synchronization with the password for applications. If the specified user logs on interactively to the respective device, the processes of the service are stopped, and an interactive process takes over the synchronization until it is terminated again.
msiexec /i <msipath> INSTALLNCLSERVICE=1 NCLSERVICE_ACCOUNT="<fully qualified Windows account name>" NCLSERVICE_PASSWORD="<Windows account password>"
Note:
- Keep in mind that the appropriate Microsoft Windows user account needs the “Log on as Service” permission (see https://learn.microsoft.com/en-us/system-center/scsm/enable-service-log-on-sm?view=sc-sm-2022: new window)
- On a device where the Native Client Service is installed it is recommended that only the user that was used for the service should login because system configurations can affect the synchronization process. Therefore, it is not allowed to install the service in a multi user environment (e.g. terminal services or similar).
Central Distribution of the Web Browser Extensions
This chapter is about the own deployment of the web browser extensions and the corresponding policies.
Deployment of the Microsoft Edge Extension
The Microsoft Edge Extension is automatically deployed when running the Fabasoft Cloud Enterprise Client setup using the Microsoft Store. The deployment of the Microsoft Edge Extension is described in the official Microsoft Edge documentation: https://docs.microsoft.com/en-us/deployedge/microsoft-edge-policies#extensioninstallforcelist: new window
If you want to use the Microsoft Store for automatic deployment the following key has to be deployed:
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallForcelist
"1"="jdibaejnifcnoojmhgcbaohifohjamlg"
Note: If there are security policies rolled out (e.g. ExtensionInstallBlocklist or NativeMessagingBlocklist, see also https://learn.microsoft.com/de-de/deployedge/microsoft-edge-policies: new window) then it should be considered to allow the functionality for the Microsoft Edge Extension.
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallAllowlist
"1"="jdibaejnifcnoojmhgcbaohifohjamlg"
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\NativeMessagingAllowlist
"1"="com.fabasoft.nmhostpu"
Deployment of the Google Chrome Extension
The Google Chrome Extension is automatically deployed when running the Fabasoft Cloud Enterprise Client setup using the Google Chrome web store. The deployment of the Google Chrome Extension is described in the official Chromium documentation: https://chromeenterprise.google/policies/#ExtensionInstallForcelist
If you want to use an own policy for automatic deployment, the following key has to be deployed:
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\ExtensionInstallForcelist
"1"="icjlkccflchmagmkfidekficomdnlcig;https://clients2.google.com/service/update2/crx"
Note: If there are security policies rolled out (e.g. ExtensionInstallBlocklist or NativeMessagingBlocklist, see also https://chromeenterprise.google/policies/: new window) then it should be considered to allow the functionality for the Google Chrome extension.
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\ExtensionInstallAllowlist
"1"="icjlkccflchmagmkfidekficomdnlcig"
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\NativeMessagingAllowlist
"1"="com.fabasoft.nmhostpu"
Deployment of the Mozilla Firefox Extension
The Mozilla Firefox Extension is automatically deployed when running the Fabasoft Cloud Enterprise Client setup. If the Fabasoft Cloud Client setup will be installed the deployment of the Mozilla Firefox Extension is described in the official Mozilla documentation: https://developer.mozilla.org/en-US/Add-ons/WebExtensions/Alternative_distribution_options/Add-ons_in_the_enterprise: new window
If you want to deploy the Mozilla Firefox extension on your own the following keys has to be deployed:
[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Mozilla\Firefox\Extensions\Install]
"1"="file://C:\\Program Files\\Fabasoft\\Cloud\\x64\\CloudFirefoxExtension.xpi"
[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Mozilla\Firefox\Extensions\Locked]
"1"="nmextmozpu@fabasoft.com"
https://github.com/mozilla/policy-templates/blob/master/README.md#extensions: new window
Note: Without changing the Mozilla Firefox preferences (as described in the documentation: extensions.autoDisableScopes, extensions.enabledScopes), each user will be notified on the next application startup, that a new Mozilla Firefox Extension was installed. In this case, the user must explicitly confirm, that the Mozilla Firefox Extension should be enabled.
Update
An update is only possible if the version number of the new package is higher than the version number of the installed package. If this is the case, the old package is automatically uninstalled when the new package will be installed. Otherwise, the Fabasoft Cloud Client setup terminates with an error message or in case of the Fabasoft Cloud Enterprise Client the setup terminates with a corresponding exit code.
During the update process, the installation is carried out with the same setup parameters as the current version is installed. If the setup parameters are to be changed, this must be explicitly specified via the respective parameter or an explicit uninstallation must take place beforehand.
If a downgrade is necessary, please uninstall the package itself first and then install the older package.
When the same version of the Fabasoft Cloud Client will be installed again the repair mode will be triggered. The repair mode only re-registers the already installed components, but does not change the installed features like the web browser extensions or the update service even if they are applied as new parameter.
Uninstalling
For uninstalling the Fabasoft Cloud Client or the Fabasoft Cloud Enterprise Client manually use the “Apps and Features” dialog provided by Microsoft Windows.
For uninstalling the Fabasoft Cloud Client or the Fabasoft Cloud Enterprise Client automatically, a signed Microsoft PowerShell script file is provided, which is added to the installation directory. This script includes the product code of the currently installed version and can be used by a deployment tool (like Microsoft Software Center) for uninstalling this version even if it was automatically updated before.
Fabasoft Cloud Client: %LOCALAPPDATA%\Fabasoft\uninstall.ps1
Fabasoft Cloud Enterprise Client: %PROGRAMFILES%\Fabasoft\Cloud\uninstall.ps1
General Settings
To avoid that users have to make settings on their own and for best performance deploy following settings on the clients:
- Increase the WebDAV file size limit to 1 GB to be able to work with large documents.
Key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\WebClient\Parameters
Value name: FileSizeLimitInBytes
Type: REG_DWORD
Value data: 1073741824 - Allow opening hyperlinks in Microsoft Office (http://support.microsoft.com/kb/218153: new window).
Key: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Office\9.0\Common\Internet (32 bit operating system)
or
HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\Microsoft\Office\9.0\Common\Internet (64 bit operating system)
Value name: ForceShellExecute
Type: REG_DWORD
Value data: 1
For more information about the meaning of these keys, consult http://msdn.microsoft.com: new window.
Predefined Settings for Users
The users have the possibility to make different settings in the options dialog. These settings can also be set by the administrator using group policies so that the users can no longer change them.
To ease the group policy setup, you can find the corresponding administrative template here: Policy Templates: new window.
The predefined settings can be defined in the following registry key:
HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Fabasoft\NativeClient\Cloud
For more information about the functionality, see https://help.cloud.fabasoft.com/index.php?topic=doc/User-Help-Fabasoft-Cloud-eng/the-fabasoft-cloud-client.htm#options-dialog: new window
- Enable Automatic Update
Value name: AUTOUPDATE
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Automatic Update URL
Value name: AUTOUPDATE_URL
Type: REG_SZ
Value data: <web server>/<vdir> - Enable Synchronization
Value name: SYNC_FS
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Enable Document Exchange via LAN
Value name: SYNC_FS_LAN
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Configure Port for Document Exchange via LAN
Value name: SYNC_FS_LANPORT
Type: REG_DWORD
Value data: 1024 – 65535 - Enable Contact Synchronization
Value name: SYNC_MAPI_CONTACT
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Enable Open Network Drive
Value name: MOUNT_WEBDAV
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Automatic Proxy Login
Value name: AUTOLOGIN_PROXY
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Download Speed Limitation
Value name: DOWNLOAD_KBSEC
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): <KB/s> - Upload Speed Limitation
Value name: UPLOAD_KBSEC
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): <KB/s> - Generate PDF Preview on the Device (Unencrypted Documents)
Value name: AUTOSAVE_PDF
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Generate PDF Preview on the Device (Encrypted Documents)
Value name: AUTOSAVE_PDF_ENC
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Generate Thumbnails From the PDF Preview on the Device (Encrypted Documents)
Value name: AUTOSAVE_THUMB_ENC
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled): 1 - Maximize CPU Utilization for Conversion
Value name: CONV_THREADLIMIT
Type: REG_DWORD
Value data (disabled): 1
Value data (enabled, maximum threads depending on CPU cores): 0
Value data (enabled, defined maximum threads): <number> - Restrict the Allowed Domains
Value name: VALIDDOMAINS
Type: REG_SZ
Value data (only *.fabasoft.com): <empty>
Value data (additional): <domain>(:<port>) - Manually defined proxy server (see also “Manual Proxy Configuration”)
Value name: PROXYSERVER
Type: REG_SZ
Value data: <proxy server>(:<port>)
File and Registry Locations
The data in these locations must not be removed or modified. The configuration settings will be written during the setup process and/or when logging in with the Fabasoft Web Browser Client.
- C:\Users\<user>\AppData\Local\Temp (%TEMP%)
- C:\Users\<user>\AppData\Local\Fabasoft (%LOCALAPPDATA%)
- C:\Users\<user>\<synchronized folder> (%USERPROFILE%)
- C:\Program Files\Fabasoft (Fabasoft Cloud Enterprise Client)
- HKEY_CURRENT_USER\Software\Fabasoft
- HKEY_CURRENT_USER\Software\Classes\CLSID\<CLSID>
- HKEY_CURRENT_USER\Software\Classes\<ProgID>
- HKEY_CURRENT_USER\Software\Microsoft\Office\Excel\AddIns\<ProgID>
- HKEY_CURRENT_USER\Software\Microsoft\Office\Outlook\AddIns\<ProgID>
- HKEY_CURRENT_USER\Software\Microsoft\Office\PowerPoint\AddIns\<ProgID>
- HKEY_CURRENT_USER\Software\Microsoft\Office\Word\AddIns\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Fabasoft
- HKEY_LOCAL_MACHINE\SOFTWARE\WOW6432Node\Fabasoft
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\CLSID\<CLSID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\ShellIconOverlayIdentifiers
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\*\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Directory\background\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Directory\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Folder\Background\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Folder\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\IE.AssocFile.URL\ShellEx\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\IE.AssocFile.WEBSITE\ShellEx\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\InternetShortcut\ShellEx\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\lnkfile\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Classes\Microsoft.Website\shellex\ContextMenuHandlers\<ProgID>
- HKEY_LOCAL_MACHINE\Software\Microsoft\Edge\NativeMessagingHosts\<ID>
- HKEY_LOCAL_MACHINE\Software\Mozilla\NativeMessagingHosts\<ID>
- HKEY_LOCAL_MACHINE\Software\Google\Chrome\NativeMessagingHosts\<ID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\ExtensionInstallForcelist\<ID>
- HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallForcelist\<ID>