Skip to main content

Explorezel 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-premises or in the cloud systems will be general advice only. This means that the advice is of a general nature and will not consider 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 are yet to obtain one for your Add-In.

INSTALLATION COMPONENTS​

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

  • FYB Explorezel web application, this is a server-side installation.

AUTHENTICATION​

The Explorezel application uses Azure AD authentication to validate the user’s credentials. Users will be required to enter their Microsoft 365 login details to sign into the application. The user's Office 365 login will need to be populated on their Content Manager profile so that the authenticated user can connect to Content Manager, this is done using the alternate login field.

CM Location

INSTALLING FYB EXPLOREZEL​

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\Server Name$

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

The FYB Explorezel MSI will:

  • Deploy the installation files.
  • Setup the application pool and application in IIS
  • Setup the temp folder
  • Configure the FYB Explorezel as specified by the user

Installation can be completed by running the MSI or using the command line arguments to prefill most data. To install the FYB Explorezel Application, follow these steps:

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

  2. Click on the Next button

    2021-08-02_15-34-04.png

  3. On the Web Application Settings screen select the HTTPS protected dedicated site (see the site section in the Explorezel Prerequisites for more information) to host the application and enter Explorezel for the Virtual Directory

    Note

    The virtual directory name must remain as Explorezel. It cannot be renamed.

    IIS Directory

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

    image.png

  4. Click on the Next button

    2021-08-02_15-35-15.png

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

  6. Click on the Next button

    2021-08-02_15-39-45.png

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

    Note

    Please refer to the AZURE APP REGISTRATION guide for more information on:

    • Application ID
    • Redirect URL
    • Tenant ID

    2024-05-07_17-09-15.png

    FIELDDESCRIPTION
    Dataset IDContent Manager two-character dataset identifier
    Workgroup ServerContent Manager workgroup server name. This should generally be set to local
    Workgroup Server URLContent Manager workgroup server URL.
    License PathLocal path to Explorezel license file
    Temp PathLocal temporary directory used by the application to cache documents
    Client IDThe Client (application) ID for the registered app on AzureAD
    Tenant IDThe organization tenant's unique identifier on AzureAD
    Redirect URLThe configured redirect URL on AzureAD
  8. On the Custom Setup screen, click on the Next button

    2021-08-02_15-47-14.png

  9. Confirm the installation by clicking on the Install button

    2021-08-02_15-47-41.png

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

    2021-08-02_15-48-28.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 Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to the Content Manager dataset to run the application
LICENSE_PATHSets the license for the application
TEMP_PATHSets the temp path that connects to the application
CLIENT_IDThe Client (application) ID for the registered app on AzureAD
TENANTThe organization tenant's unique identifier on AzureAD
REDIRECT_URIThe URL where Azure will send the authentication payload upon successful authentication.

CONFIGURATION​

IIS CONFIGURATION​

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

  2. From the Features View double click on Authentication and ensure that only Windows Authentication is enabled

    2021-08-02_17-07-23.png

    2021-08-02_17-05-40.png

  3. Right-click the application in IIS and select explore

    app.jpg

  4. Right-click the app data folder and select properties

    prop.jpg

  5. Navigate to the security tab and ensure users have read, write and modify permissions

    permiss.jpg

EMBEDDING EXPLOREZEL​

To allow for a site to embed Explorezel:

If Microsoft IIS CORS Module has not been installed onto the web server, this will need to be installed prior to embedding Explorezel.

The IIS Core Module can be found here

  1. Navigate to the Explorezel install directory and open the web.config file as an Administrator in the text editor of your choice

    2023-02-17_11-23-04.png

  2. Locate the Content-Security-Policy line highlighted below

    2023-02-17_11-24-45.png

  3. After 'self', add 'data:' followed by the domain of the site that Explorezel is installed under and the domain(s) of the sites that Explorezel will be embedded in (separated by a space)

    2023-02-17_11-28-34.png

  4. Save your changes and complete an App Pool stop/start

INSTALLING THE CM LAUNCHER​

The FYB CM Launcher needs to be installed on each user's machine. The CM Launcher is required to perform native functions on the user’s machine such as editing documents in their native application.

Please refer to the dedicated CMLauncher Install Guide for further details.

Note

CMLauncher is required to have a separate Azure App registration for use with Explorezel. Please refer to the CMLauncher Azure App Registration guide for further details.