2021 September Release

Microsoft WindowsPermanent link for this heading

This chapter refers to a Microsoft Windows operating system.

InstallingPermanent link for this heading

Fabasoft Cloud Client

To install the Fabasoft Cloud Client (into the per-user installation context), perform the following steps:

  1. Download the CloudClient.msi installation package from the Fabasoft Cloud or Fabasoft Private Cloud.
    https://at.cloud.fabasoft.com/folio/fscasp/content/lib/CloudClient.msi
    https://<host private cloud>/cloud/fscasp/content/lib/CloudClient.msi
  2. 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

To install the Fabasoft Cloud Enterprise Client (into the per-machine installation context), perform the following steps:

  1. Download the CloudClientEnterprise.msi installation package from the Fabasoft Cloud or Fabasoft Private Cloud.
    https://at.cloud.fabasoft.com/folio/fscasp/content/lib/CloudClientEnterprise.msi
    https://<host private cloud>/cloud/fscasp/content/lib/CloudClientEnterprise.msi
  2. Make sure that you have administrative rights.
  3. 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 (x86)\Fabasoft\Cloud\Client\.
In case of a 32 bit operating system the base folder is Program Files.

Note: The installation of the Fabasoft Cloud Client and the Fabasoft Cloud Enterprise Client on the same computer is not supported.

Advanced ConfigurationPermanent link for this heading

On Microsoft Windows 10 Pro workstations that are joined to a Microsoft Active Directory domain, the Fabasoft Cloud Enterprise Client setup automatically installs the web browser extensions for all supported web browsers (security feature of the web browsers).

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

Fabasoft Private Cloud Installation

If you have an on-premise Fabasoft Private Cloud installation that does not run under *.fabasoft.com, then the Fabasoft Client extension for the respective web browser is needed. This extension can be installed with the following MSI package parameter:

msiexec /i <msipath> CHROMEEXTENTERPRISE=1 EDGEEXTENTERPRISE=1 FIREFOXEXTENTERPRISE=1

UpdatePermanent link for this heading

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.

If a downgrade is necessary, please uninstall the package itself first and then install the older package.

Deployment via Active DirectoryPermanent link for this heading

The deployment of per-machine installation packages (MSI) via Active Directory is described in the white paper “Deployment of Microsoft Installer Packages via Microsoft Windows Active Directory”.

Deployment of the Microsoft Edge ExtensionPermanent link for this heading

On Microsoft Windows 10 Pro workstations that are joined to a Microsoft Active Directory domain, the Microsoft Edge Extension is automatically deployed when running the Fabasoft Cloud Client Enterprise setup. Otherwise 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

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"

Deployment of the Google Chrome ExtensionPermanent link for this heading

On Microsoft Windows 10 Pro workstations that are joined to a Microsoft Active Directory domain, the Google Chrome Extension is automatically deployed when running the Fabasoft Cloud Client Enterprise setup. Otherwise the deployment of the Google Chrome Extension is described in the official Chromium documentation: https://chromeenterprise.google/policies/#ExtensionInstallForcelist

If you want to use the Google Chrome web store 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"

Deployment of the Mozilla Firefox ExtensionPermanent link for this heading

The Mozilla Firefox Extension is automatically deployed when running the Fabasoft Cloud Client Enterprise 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

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 (x86)\\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

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.

Trusted Sites for Fabasoft app.telemetryPermanent link for this heading

To allow that Fabasoft app.telemetry get more information about the client configuration and taking a screenshot, when pressing the app.telemetry feedback button you have to manually set a trusted site registry key for your web service URL.
Key: HKEY_CURRENT_USER\Software\Fabasoft\WebClient\TrustedSites\Cloud\<web service URL e.g. at.cloud.fabasoft.com>

Note: For the Fabasoft Cloud/Fabasoft Private Cloud this key will be set automatically after a successful log-in.

General SettingsPermanent link for this heading

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).
    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.

Predefined Settings for UsersPermanent link for this heading

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.

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

  • 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 LAN Synchronization
    Value name: SYNC_FS_LAN
    Type: REG_DWORD
    Value data (disabled): 0
    Value data (enabled): 1
  • Restrict Path Length for Synchronization
    Value name: SYNC_FS_LONGPATH
    Type: REG_DWORD
    Value data (disabled): 0
    Value data (enabled): 1
  • 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 LocationsPermanent link for this heading

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 (x86)\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>