Skip to main content

FYB Connect 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 Connect does not support Windows Authentication, requiring the use of OpenID Connect.

FYB Connect officially supports Microsoft Entra ID and has not been tested against any other Authentication provider.

FYB CONNECT SQL DATABASE​

An SQL database is required to host all of FYB Connect's configuration, see the Prerequisites for more details If an FYB Connect 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.

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. Update the httpRuntime element to the following:
<httpruntime requestValidationMode="2.0" targetFramework="4.7.2" maxQueryStringLength="8192" maxRequestLength="2147483647" executionTimeout="7200" />

This value will allow for document uploads up to 50MB. Increase this value as required.

2025-05-28_14-38-26.png

  1. Update the requestLimits element as such
<requestlimits maxAllowedContentLength="2147483647" maxQueryString="8192" />

2025-05-21_11-39-01.png 6. Save the changes.

HPTRIM.CONFIG UPDATE​

  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"
requireAntiForgeryToken="false"

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

  1. Within the hptrim element, add the following:
ignorePropertyErrors = "true"

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

  1. Create a new authentication element between the workgroupServer and fileTypes elements (if not already present) using the below:
<authentication allowAnonymous="false" slidingSessionMinutes="60">

Authentication Element.png

  1. 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
\<openidconnect\>
<add
name="fybconnect"
clientID="\{\{appID\}\}"
issuerURI="https://login.microsoftonline.com/\{\{tenantID\}\}/v2.0/.well-known/openid-configuration"
identityClaims="email upn preferred_username oid"
appIdURI="\{\{appIdURI\}\}"
/>
</openidconnect>

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:

Multiple Apps - 1 API.png

  1. Save the changes.

INSTALLATION COMPONENTS​

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

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

INSTALLING THE FYB CONNECT 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 10 SDK and Hosting Bundle.

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

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

    Image

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

    Image

  3. Once both executables have been installed, complete a full server restart to allow for .NET 10 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

    Image

IIS URL REWRITE​

IIS URL Rewrite is required for the routing in the frontend of FYB Connect 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 Connect will be installed on and run the IIS Rewrite MSI.

FYB CONNECT INSTALLATION​

To install the FYBConnect web service, follow these steps:

  1. Run command prompt as an administrator and launch the fybconnect-xxx.msi

  2. Click on the Next button

    2024-06-27_15-38-30.png

  3. Select either Express or Custom

  • Express: Skips the module configurations

  • Custom: Select modules to configure during the install process

    Note

    Modules can be configured via the FYB Connect web interface after install

    2025-08-28_13-30-42.png

  1. If Custom was selected in the previous step, select the modules you want to configure then click Next

    2025-08-28_13-31-52.png

  2. 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 Connect will be called ConnectService. The virtual directory for the frontend will be called FYBConnect. These cannot be renamed.

    IIS Directory

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

    image.png

    2024-06-27_15-39-52.png

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

  4. Click on the Next button

    2024-06-27_15-40-27.png

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

    FYB Connect Install - Config Settings.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 Connect's settings
    Database NameThe name of the SQL Database that will host FYB Connect's settings.
    License PathLocal path to FYB Connect 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\FYBConnect\
    DomainThe domain that FYBConnect will be installed under (e.g. https://example.com.au)
    CM Service API DLLs Path (Optional)Local path of the CM Service API DLLS, used when installing FYB Connect onto a Non-CM Server.
  6. 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-04_9-02-42.png

    FIELDDESCRIPTION
    Open ID ProviderChoose an Open ID Provider. Only Microsoft OpenID is supported.
    Client IDThe Client ID of the Entra application used to secure FYB Connect
    Tenant IDThe Tenant ID of the Entra application used to secure FYB Connect
    Authority URLThe Authority URL of the Entra application in the format https://login.microsoftonline.com/\{Tenant Id}
    Redirect URLThe FYB Connect 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 Connect
  7. 365|2CM Settings (Optional). Only fill in these fields if you have the 365|2CM module

    2025-05-06_13-42-24.png

    FIELDDESCRIPTION
    Client IDThe client ID for the registered 365|2CM app on Entra ID
    Tenant IDThe organization tenant's unique identifier on Entra ID
    Redirect URLThe FYBConnect URL followed by /3652cm/. E.g. https://example.com.au/fybconnect/3652cm/
    Certificate NameThe friendly name of the nominated certificate (.pfx) installed on the machine.
  8. CM2SP Settings (Optional). Only fill in these fields if you have the CM2SP module

    2025-05-06_13-43-10.png

    FIELDDESCRIPTION
    Client IDThe client ID for the registered CM2SP app on Entra ID
    Tenant IDThe organization tenant's unique identifier on Entra ID
    Redirect URLThe FYBConnect URL followed by /cm2sp/. E.g. https://example.com.au/fybconnect/cm2sp/
    Certificate NameThe friendly name of the nominated certificate (.pfx) installed on the machine.
  9. On the Email Configuration Settings screen enter the required settings. Please refer to the table below for configuration settings details.

    2025-05-14_12-49-35.png

    NAMEDESCRIPTION
    License ContactsThe list of email addresses that will receive a notification when the FYB Connect 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 in sending all emails.
  10. On the Proxy Settings screen, fill in the Proxy details. This screen is optional and only required if the server requires the use of a Proxy for internet access.

    2024-08-19_14-36-00.png

  11. On the Custom Setup screen, select the install location and click on the Next button

    2024-06-27_16-27-16.png

  12. From the Confirm Installation window, click on the Install button

    2024-06-27_16-27-46.png

  13. The installation process will commence

  14. Once the installation is complete, click on the Finish button

    2024-06-27_16-30-36.png

IIS CONFIGURATION​

2024-06-21_17-15-20.png 2024-06-21_17-15-43.png

NameDescription
Connect ServiceThis app is connected to the GatewayService folder in the FYB Connect install directory. It is responsible for rerouting all the api calls from the FYB Connect frontend to the appropriate service
FYBConnectServiceThis app is connected to the FYBConnectService folder within the FYB Connect install directory. This app provides all the FYB Connect related services.
3652CMThis app is connected to the 3652CM folder within the FYB Connect install directory. This app provides all the 365|2CM related services.
CM2SPThis app is connected to the CM2SP folder within the FYB Connect install directory. This app provides all the CM2SP related services.
FYBConnectThis app IIS connected to the wwwroot folder within the GatewayService folder. It is responsible for the frontend for FYB Connect

APPLICATION POOL CONFIGURATION​

  1. Click on Application Pools

    image.png

  2. Locate FYBConnect and click Advanced Settings

    2024-06-21_17-26-46.png

  3. Under General ensure that Start Mode is set to Always Running

    image.png

  4. Under Process Model ensure that: • Idle Time-out (minutes) is set to 0 • Idle Time-out Action is set to Suspend

image.png

  1. Click on the OK button
  2. Repeat the above steps for the following application pools:
  • FYBConnect3652CM
  • FYBConnectCM2SP
  • FYBConnectService

CONFIGURING FYB SOFTWARE SCHEDULER SERVICE​

If configuring the FYB Software Scheduler Service for use with FYB Connect, please ensure all modules URLs are included in addition to the base FYB Connect URL

Scheduler Service.png

CONTENT MANAGER CONFIGURATION​

The following additional fields need to be created in Content Manager. Any record type that you wish to use with FYB Connect will need to have these fields attached.

NameData FormatDescriptionRecord Types
3652CM SourceString, Maximum Length: 255Used to store the source location of the document to be displayed on the Activities pageDocument
365IDString, Maximum Length: 255Used to store the unique identifier for the files stored on SharePoint, it is used to establish a one to one relationship for files between the two systems.Container and Document
Drive IDString, Maximum Length: 255Used to store the drive ID of the SharePoint document. This is required for the Edit/View in M365 external links.Document
FYBConnectModuleString, Maximum Length: 255Used to store the FYB Connect module responsible for transferring the Record. This is required for stats and activity capturingContainer and Document
QuickXorHashString, Maximum Length: 255Used to store the hash of a document from SharePoint to determine if records will need to be updated with new revisions.Document
Note

The latest version of CMLauncher is required for this feature.

The Edit/View in M365 External Link allows users to either edit or view documents in Sharepoint that were transferred via the 365|2CM module in FYB Connect. This feature will only work for records that contain valid 365ID and Drive ID additional field values. When the Edit in M365 external link button is clicked, the document is checked out of Sharepoint. Once the user closes the document, the document is checked back into Sharepoint. FYB Connect will update the respective Record with the updated document during the next archiving process.

  1. In Content Manager, under the Administration tab, click External Links

    2023-04-24_14-40-38.png

  2. Right-click anywhere in the External Links view and click New External Link

    2023-04-24_14-45-16.png

  3. Select External Executable then click Ok

    2023-04-24_14-48-18.png

  4. Specify the values below:

    2023-04-24_15-03-52.png

    NAMEDESCRIPTION
    Link NameEdit in M365
    Command line parameterswindow.open(`cmlauncher:^!Uri^&mode=sharepointedit&dbid=XX (where XX is the CM Database ID)
  5. For the Executable File Name click the magnifying glass

    2023-04-24_15-07-08.png

  6. Navigate to the CMLauncher installation path

  7. Select CMLauncher.exe and click Open

    2023-04-24_15-08-45.png

  8. On the Usage (Record) tab, tag the document record types used by 365|2CM

    2023-04-24_15-10-55.png

  9. Click on the Ok button

    2023-04-24_15-12-37.png

Repeat the steps above for configuring the View in M365 External Link except with the below changes.

NAMEDESCRIPTION
Link NameView in M365
Command line parameterswindow.open(`cmlauncher:^!Uri^&mode=sharepointview&dbid=XX (where XX is the CM Database ID)

INSTALLING ON NON-CM SERVERS​

When installing FYB Connect 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 Connect is installed on

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

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

INSTALLING CM LAUNCHER (OPTIONAL)​

The FYB CMLauncher can be installed if required. It allows users to open records in CM from the FYB Connect activities page or utilize the M365 buttons inside CM. Please refer to the CMLauncher Installation Guide for further details.

UNINSTALLING FYB CONNECT​

To uninstall the FYB Connect manually please follow the steps below:

  1. Run command prompt as an administrator and launch the FYB Connect MSI

  2. Click Next

    FYB Connect - Uninstall Splash.png

  3. Click Remove

    FYB Connect - Uninstall Remove.png

  4. Click Remove to confirm you would like to uninstall FYB Connect

    FYB Connect - Uninstall Confirm.png

  5. Click Finish once the uninstallation process has completed

    FYB Connect - Uninstall Complete.png