Microsoft Windows

This chapter refers to a Microsoft Windows operating system.

Installing

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

Download the FolioClient.msi installation package from the Fabasoft Folio installation.
https://<host>/<vdir>/fscasp/content/lib/FolioClient.msi
Alternatively, you find the MSI file in the Setup\ComponentsBase\Client folder of the Fabasoft Folio distribution media.
Make sure that you have administrative rights.
Run the FolioClient.msi installation package and follow the installation wizard.

The Fabasoft Folio Client is installed in the following folder:
C:\Program Files\Fabasoft\Folio 2024\Client\
In case of a 32 bit operating system the base folder is Program Files.

Advanced Configuration

By default, the 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 Folio 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 policy or the ExtensionSettings policy are rolled out centrally as JSON format, no automatic registration and configuration of the browser extensions happens via the Fabasoft Folio Client setup. This is because our modified JSON string would be overwritten by the central deployment tool.

To prevent 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 FolioClient.msi CHROMEEXT=0

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 Folio 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 an own policy for automatic deployment, the following key has to be deployed:

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallForcelist

"1"="fabncpfbjhdplfapghonnbhnenohncpp"

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), it should be considered to allow the functionality for the Microsoft Edge Extension.

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\ExtensionInstallAllowlist
"1"="fabncpfbjhdplfapghonnbhnenohncpp"

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Microsoft\Edge\NativeMessagingAllowlist
"1"="com.fabasoft.nmhostpm24"

Deployment of the Google Chrome Extension

The Google Chrome Extension is automatically deployed when running the Fabasoft Folio 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: new window

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"="alcgpfgkdjbabelklflpfkooadcfgoao;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), it should be considered to allow the functionality for the Google Chrome extension.

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\ExtensionInstallAllowlist
"1"="alcgpfgkdjbabelklflpfkooadcfgoao"

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Google\Chrome\NativeMessagingAllowlist
"1"="com.fabasoft.nmhostpm24"

Deployment of the Mozilla Firefox Extension

The Mozilla Firefox Extension is automatically deployed, when running the Fabasoft Folio Client setup. If you deactivate the installation of the extension you can install it manually. 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 have to be deployed:

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Mozilla\Firefox\Extensions\Install]

"1"="file://C:\\Program Files\\Fabasoft\\Folio 2024\\Client\\x64\\FolioFirefoxExtension.xpi"

[HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Mozilla\Firefox\Extensions\Locked]

"1"="nmextmozpm21@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 Folio Client 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 Folio 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.

Automatic Update

To be able to use the automatic update feature the following prerequisites must be met:

The Fabasoft Folio Client has to be installed including the update service:
msiexec /i FolioClient.msi INSTALLUPDATESERVICE=1
The automatic update URL has to be configured from where the update package will be downloaded:

HKEY_LOCAL_MACHINE\SOFTWARE\Policies\Fabasoft\NativeClient\Folio

Automatic Update URL
Value name: AUTOUPDATE_URL
Type: REG_SZ
Value data: <web server>/<vdir>
Enable Automatic Update
Value name: AUTOUPDATE
Type: REG_DWORD
Value data (disabled): 0
Value data (enabled, default): 1

Note: The automatic update can be disabled by removing the URL or by deactivating it using the AUTOUPDATE setting. If the update service is to be installed with the version that is already installed, the client must first be uninstalled. After that, the setup can be installed with the INSTALLUPDATESERVICE=1 parameter.

Uninstalling

For uninstalling the Fabasoft Folio Client manually use the “Apps and Features” dialog provided by Microsoft Windows.

For uninstalling the Fabasoft Folio 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.

%PROGRAMFILES%\Fabasoft\Folio 2024\Client\uninstall.ps1

Trusted Sites for Fabasoft app.telemetry

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
Value name: <web service URL e.g. folio.example.com>
Type: REG_SZ
Value data: 1

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: