Skip to main content

FYB Explore Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provide in relation to setting up any FYB App, FYB Add-in, FYB Connector and or advice in relation to opening access to your on-premise or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not take into account your network setup, network infrastructure or any security requirements that you may have or in fact need. It is highly advised that you seek advice from internal or external providers to ensure that they are comfortable with what is required prior to going ahead with any deployment, setup or configuration for external access.

AUTHENTICATION​

FYB Explore does not support Windows Authentication.

OpenID Connect Authentication must be used for both FYB Explore and the Content Manager ServiceAPI, with matching providers.

FYB Explore officially supports EntraID and has not been tested against any other Authentication provider.

FYB EXPLORE SQL DATABASE​

An SQL database is required to host all of FYB Explore's configuration, see the Prerequisites for more details If an FYB Explore Database already exists, this step can be skipped.

LICENSE DETAILS​

Please contact FYB for a valid license if you have yet to obtain one for your Connector.

CONTENT MANAGER SERVICE API CONFIGURATION​

  1. Navigate to the C:\Program Files\Micro Focus\Content Manager\Service_API folder

  2. Open the hptrim.config file.

  3. Ensure the following is set with the openIdConnect section:

    1. identityClaims is set to email upn preferred_username oid
    2. appIdURI is set to api://{clientID}

    2024-07-26_14-15-46.png

INSTALLING IN NON-CM SERVERS​

When installing FYB Explore onto a server that does not have Content Manager installed, the following steps will need to be done.

  1. Navigate to a Content Manager server and copy the following files from C:\Program Files\Micro Focus\Content Manager\Service_API:

    • ServiceStack.Client.dll
    • ServiceStack.Interfaces.dll
    • ServiceStack.Text.dll
    • TRIMServiceAPIClient.dll
    • TRIMServiceAPIModel.dll
  2. Copy the following files from C:\Program Files\Micro Focus\Content Manager\bin

    • TRIM.Framework.dll
  3. Navigate to the server that FYB Explore is installed on

  4. Paste the files copied in steps 1 and 2 into a folder that has the FYBExplore MSI

    2024-07-26_15-34-31.png

INSTALLATION COMPONENTS​

The following installation components are required to ensure the full functionality of FYB Explore:

  • FYB Explore web application - this is a server-side installation

INSTALLING THE FYB EXPLORE WEB SERVICE​

LICENSE​

  1. Create a folder to house the license file (.lic) on the required web server

  2. Place the license file in this folder

    Note

    You will be asked to enter this location during the installation.

PREREQUISITES INSTALLATION​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle and installing IIS URL Rewrite.

.NET 8 SDK AND HOSTING BUNDLE​

To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:

  1. Install the latest .NET 8 SDK (x64) found here

    2024-06-21_15-04-14.png

  2. Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

    2024-06-21_15-05-11.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 8 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.

    • net stop was /y
    • net start w3svc
    • iisreset
    Note

    To check that the SDK has been attached to the hosting bundle, open Command Prompt and type dotnet --info

    2024-06-21_15-06-23.png

IIS URL REWRITE​

IIS URL Rewrite is required for the routing in the frontend of FYB Explore to work properly.

  1. Navigate to IIS URL Rewrite Download Page

  2. Scroll down and download the latest x64 version

    2024-06-21_15-10-57.png

  3. Navigate to the server that FYB Explore will be installed on and run the IIS Rewrite MSI.

FYB EXPLORE INSTALLATION​

To install the FYB Explore web service, follow these steps:

  1. Unzip the ffmpeg.zip file and place the extracted file in the same folder as the FYB Explore msi

    2025-07-11_13-09-21.png

  2. Run command prompt as an administrator and launch the fybexplore-xxx.msi

  3. Click on the Next button

    2024-12-16_12-15-55.png

  4. On the Web Application Settings screen select the HTTPS protected dedicated site to host the application. Click on the Next button

    Note

    A HTTPS site must be selected. The virtual directory for the backend of FYB Explore will be called FYBExploreService. The virtual directory for the frontend will be called FYBExploreService. These cannot be renamed.

    IIS Directory

    The FYB Explore application must be installed under the dedicated site as an application. It cannot be installed at the site level

    image.png

    2024-12-16_12-16-13.png

  5. On the Application Pool Settings screen (below), enter the domain, username, and password for the Application Pool identity

  6. Click on the Next button

    2024-12-16_12-16-51.png

  7. On the Configuration Settings screen enter the required information. Further details are in the table below

    2024-12-16_12-21-43.png

    FIELDDESCRIPTION
    Database IdContent Manager two-character dataset identifier
    CM Service API URLThe Content Manager Service API URL
    SQL Server NameThe name of the SQL Server that will host FYB Explore's settings
    Database NameThe name of the SQL Database that will host FYB Explore's settings.
    License PathLocal path to FYB Explore license file
    Temp PathLocal temporary directory used by the application to cache content manager documents. Please include the trailing slash, for example: C:\FYB Add-Ins\FYBExplore\
    DomainThe Host URL that FYBExplore will be installed under (e.g. https://example.com.au)
  8. Open ID Settings. The values of the required fields can be found in the respective Open ID guides. These can be found within the VALUES REQUIRED FOR INSTALLATION header of the respective Open ID guide.

    2025-03-20_17-06-23.png

    FIELDDESCRIPTION
    Content Manager Entra Client IDThe Client ID of the Entra application used to secure Content Manager
    Client IDThe Client ID of the Entra application used to secure FYB Explore
    Tenant IDThe Tenant ID of the Entra application used to secure FYB Explore
    Authority URLThe Authority URL of the Entra application in the format https://login.microsoftonline.com/\{Tenant Id}
    Redirect URLThe FYB Explore URL. This value must be in all lowercase
    Certificate NameThe friendly name of the nominated certificate (.pfx) installed on the machine.
    App Id URIThe App Id Uri of the Entra application used to secure FYB Explore
    Content Manager App Id URIThe App Id Uri of the Entra application used to secure Content Manager
  9. In the Email Configuration Settings screen enter the required settings. Please refer to the table below for configuration settings details.

    2025-03-25_13-09-47.png

    NAMEDESCRIPTION
    License ContactsThe list of email addresses that will receive a notification when the FYB Explore License is about to expire.
    From AddressThe email address that all emails are sent from.
    Mail HostThe email host system that will send all email notifications.
    Mail PortThe Simple Mail Transfer Protocol port that will assist the host mail system send all emails.
    SMTP username (optional)The username used to authenticate with your SMTP server
    SMTP password (optional)The password used to authenticate with your SMTP server
  10. On the Custom Setup screen select the install location and click on the Next button

    2024-12-16_12-24-43.png

  11. From the Confirm Installation window click on the Install button

    2024-12-16_12-25-05.png

  12. The installation process will commence

  13. Once the installation is complete click on the Finish button

    2024-12-16_12-49-44.png

IIS CONFIGURATION​

2024-12-16_13-20-19.png 2024-12-16_13-20-32.png

NameDescription
Explore ServiceThis app is connected to the GatewayService folder in the FYB Explore install directory. It is responsible for rerouting all the api calls from the FYB Explore frontend to the appropriate service
FYBExploreServiceThis app is connected to the FYBExploreService folder within the FYB Eplore install directory. This app provides all the FYB Explore related services.
FYBExploreThis app IIS connected to the wwwroot folder within the GatewayService folder. It is responsible for the frontend for FYB Explore

SERVICE API CONFIGURATION​

Note

The maximum size is 2 GB. See Uploading Large Files to IIS / NET. Core / ASP.NET for more information

The default document size that can be uploaded using the CM Service API is 4MB. To increase this:

WEB.CONFIG UPDATES​

  1. Navigate to the install directory of the CM Service API. (e.g. C:\Program Files\Micro Focus\Content Manager\Service_API)
  2. Open the Web.config file as an Administrator
  3. In the httpRuntime element, add maxRequestLength="51200" This value will allow for document uploads up to 50MB. Increase this value as required.

2024-08-07_17-02-20.png 4. Save the changes

HPTRIM.CONFIG UPDATES​

  1. Navigate to the install directory of the CM Service API. (e.g. C:\Program Files\Micro Focus\Content Manager\Service_API)

  2. Open the hptrim.config file as an Administrator

    2024-10-01_9-29-47.png

  3. Within the hptrim section, add ignorePropertyErrors = "true"

    2025-07-01_9-24-06.png

SERVICE API OPEN ID CONFIGURATION​

  1. Navigate to the C:\Program Files\Micro Focus\Content Manager\Service_API folder

  2. Open the hptrim.config file.

  3. Add the following to the hptrim element: requireAntiForgeryToken="false"

    2025-08-07_14-25-16.png

  4. Within the hptrim element, add ignorePropertyErrors = "true"

    2025-07-01_9-24-06.png

  5. Create a new authentication element between the workgroupServer and fileTypes elements (if not already present) and add allowAnonymous="false" slidingSessionMinutes="60"

    Authentication Element.png

  6. Create a new openIdConnect element within the authentication element (if not already present) and add the below block inserting the relevant details from your app registration

<add
name="fybexplore"
clientID="\{\{appID\}\}"
issuerURI="https://login.microsoftonline.com/\{\{tenantID\}\}/v2.0/.well-known/openid-configuration"
identityClaims="email upn preferred_username oid"
appIdURI="\{\{appIdURI\}\}"
/>

FYB Connect - ServiceAPI Auth Config.png

Multiple App Registrations against a single Service API

For environments where multiple applications are looking to access the Service API using OpenID Authentication, you can add multiple objects within the openIDConnect element.

Below is an example of how this would be configured:

FYB Explore - Service API Config - Multi App.png

  1. Save the changes.

INSTALLING CM LAUNCHER​

The FYB CMLauncher is required to view and edit documents from both Content Manager and Sharepoint via FYB Explore. Please refer to the CMLauncher Installation Guide for further details.

UNINSTALLING FYB EXPLORE WEB SERVICE​

To uninstall FYB Explore manually please follow the steps below:

  1. Navigate to Control Panel

    image.png

  2. Click on Uninstall a program

    image.png

  3. Locate FYB Explore in the list of Programs and feature

    2024-06-24_9-13-43.png

  4. Right click on FYB Explore and click on the Uninstall option

    2024-06-24_9-15-02.png

  5. If a warning Prompt appears, click on the continue button

    image.png  

  6. Click on the Yes button

    image.png

  7. The uninstallation process will commence

  8. Open IIS once the uninstallation process is completed

  9. Locate Explore Service in IIS. Expand it

  10. Right click FYBExploreService and click on the Remove button

    2024-12-16_14-45-56.png

  11. When the prompt appears click on the Yes button

    image.png

  12. Repeat the steps above for the FYBExplore and ExploreService IIS site

  13. Contact your Database Administrator to delete the FYB Explore Database.