Skip to main content

DocUMove Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provides 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.

LICENSE DETAILS​

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

DocUMove v3.x and below

Previous installations of DocUMove v3 and below must be uninstalled prior to the installation of v4.

DocUMove v4.0.x Licensing

A new .NET Core license must be generated for DocUMove v4. You can request one by reaching out to membershub@fyb.com.au

INSTALLATION COMPONENTS​

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

  • FYB DocUMove web application - This is a server-side installation.

INSTALLING FYB DOCUMOVE​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server

  2. Place the license file in this folder

    Note

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

TRUSTED USER ACCOUNT​

Add the account that will run the application pool as a Trusted User Account in Enterprise Studio.

Please refer to your Enterprise Studio help file on adding trusted accounts.

If using a system account (application pool identity, network service, etc), you will be required to enter the details as DOMAIN\ServerName$.

If using a dedicated Windows service account, you will be required to enter the details as DOMAIN\username.

INSTALLATION​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .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

    NET SDK 8.png

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

    NET Hosting Bundle 8.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
    info

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

The documove MSI will:

  • Deploy the installation files
  • Set up the application pool and application in IIS
  • Set up the temp folder
  • Configure the application settings as specified by the user

Installation can be completed by running the MSI or using command-line arguments to prefill most data.

To install DocUMove, follow these steps:

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

  2. Click on the Next button

    image.png

  3. On the Web Application Settings screen, select a Site to host the application and enter a name for the Virtual Directory

    2025-04-08_16-30-01.png

    Recommendation

    We recommend that DocUMove be installed under an HTTPS site with a valid SSL certificate.

  4. On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity

    Windows Authentication

    If you are using Windows Authentication, then these fields must be filled in. Do Not enable the Use Default Application Pool Identity checkbox.

    2022-09-08_10-26-47.png

    Application Pool Identity

    If you are enabling the Use Default Application Pool Identity checkbox, ensure the account has write access to the Registry, as this is required for updating the Authentication Settings.

    To update the permissions, navigate to Computer\HKEY_LOCAL_MACHINE\SOFTWARE\FYB\DocUMoveService in the Registry after DocUMove is installed.

    image.png

  5. On the Configuration Settings screen, enter the required settings (please refer to the table below for configuration settings details)

    2025-04-08_16-31-33.png

    FIELDDESCRIPTION
    Database IdContent Manager two-character dataset identifier
    CM Service API URLThe Content Manager Service API URL
    DomainThe Host URL that DocUMove will be installed under (e.g. https://example.com.au)
    License PathLocal path to DocUMove 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\DocUMove\
  6. Select your preferred Open ID Provider

    DocUMove Auth Method.png

    OPTIONDESCRIPTION
    MicrosoftConfigures DocUMove to use EntraID. This option is selected by Default
    NoneChoose this option if you would not like to use Open ID to secure DocUMove, using Windows Authentication instead. Leave all other fields on this screen blank and proceed to Step 8
    Note

    If None is selected, the IIS authentication for the Content Manager Service API must be set to Basic Authentication. No other authentication method can be set.

  7. Complete the Entra ID Settings screen using the values gathered as part of the respective Open ID guides. These can be found within the VALUES REQUIRED FOR INSTALLATION header of the respective Open ID guide.

    2025-04-08_16-32-49.png

    FIELDDESCRIPTION
    Content Manager Entra Client IDThe Client ID of the Entra application used to secure DocUMove
    Tenant IDThe Tenant ID of the Entra application used to secure DocUMove
    Authority URLThe Authority URL of the Entra application in the format https://login.microsoftonline.com/\{Tenant Id}
    Redirect URLThe DocUMove URL. This value must be in all lowercase
    App Id URIThe App Id URI of the Entra application used to secure DocUMove
  8. On the Email Settings screen, enter the required settings

    2025-04-08_16-33-55.png

    NAMEDESCRIPTION
    License ContactsThe email addresses of users who will receive an email notification when the DocUMove license is due to expire. Emails are separated by a semi-colon ';'
    From AddressThe email address that all email notifications will be sent from
    Mail HostThe mailing host to send notifications
    Mail PortThe mail port to send notifications
    SMTP username (optional)The username used to authenticate with your SMTP server
    SMTP password (optional)The password used to authenticate with your SMTP server
  9. On the Custom Setup screen, select the install location and click on the Next button

    image.png

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

    image.png

  11. The installation process will commence

    image.png

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

    image.png

COMMAND-LINE ARGUMENTS​

Note

Use "" around values that contain special characters (non-alphanumeric characters)

ARGUMENTPURPOSE
WEB_APP_POOL_IDENTITY_DOMAINSets the App Pool domain for the application pool
WEB_APP_POOL_IDENTITY_NAMESets the App Pool username for the account running the application pool
WEB_APP_POOL_IDENTITY_PWDSets the App Pool password for the account running the application pool
DBIDSets the Database ID that connects to the given Content Manager dataset
WORKGROUP_SERVERSets the Content Manager Workgroup Server name
WORKGROUP_SERVER_URLSets the Content Manager Workgroup Server URL
LICENSE_PATHPath to the license file
TEMP_PATHTemporary data directory for the application
CLIENT_IDThe Client ID of the Entra application used to secure DocUMove
TENANT_IDThe Tenant ID of the Entra application used to secure DocUMove
AUTHORITY_URLThe Authority URL of the Entra application in the format https://login.microsoftonline.com/\{Tenant Id}
REDIRECT_URLThe DocUMove URL. This value must be in all lowercase
APP_ID_URIThe App ID URI of the Entra application used to secure DocUMove
LIC_CONTACTSThe email addresses of users who will receive an email notification when the DocUMove license is due to expire. Emails are separated by a semi-colon ';'
FROM_ADDRESSThe email address that all email notifications will be sent from
MAIL_HOSTThe mailing host to send notifications
MAIL_PORTThe mail port to send notifications
SMTP_USERNAMEThe username used to authenticate with your SMTP server
SMTP_PASSWORDThe password used to authenticate with your SMTP server

CONFIGURATION​

After the installation process is complete, you will be able to locate the application installed within the site selected during installation.

image.png

  1. From the Features View, go to Authentication

    image.png

  2. Ensure the relevant Authentication option is enabled, based on the Open ID Provider selected during the install

    • If Microsoft was chosen as the OpenId Provider, ensure only Anonymous Authentication is enabled.
    • If None was chosen as the OpenId Provider, ensure only Windows Authentication is enabled.
    Note

    If None is selected during the DocUMove install, the IIS authentication for the Content Manager Service API must be set to Basic Authentication. No other authentication method can be set.

UPDATING THE CONTENT MANAGER SERVICE API CONFIG​

When using Windows Authentication, the hptrim.The config file for the Content Manager Service API needs to be updated.

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

OPENID AUTH CONFIGURATION​

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

    Authentication Element.png

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

Service API 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.

WINDOWS/BASIC AUTH CONFIGURATION​

  1. Add the following to the hptrim element: trustedToImpersonate="service account domain\\service account username" Replace service account domain and service account username with the Domain and Username of the Service Account used for DocUMove.

2025-08-13_9-24-19.png

  1. Save the changes.

UNINSTALLING THE FYB DOCUMOVE​

To uninstall the DocUMove manually, please follow the steps below:

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

  2. Click Next

    2025-08-28_15-41-54.png

  3. Click Remove

    2025-08-28_15-44-41.png

  4. Click Remove

    2025-08-28_15-47-25.png

  5. Click Finish once the uninstallation process has completed

    2025-08-28_15-50-55.png