Skip to main content

CM2WebShare 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 needed 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 Connector.

INSTALLATION COMPONENTS​

The following installation components are needed to ensure full functionality of the FYB CM2WebShare:

  • FYB CM2WebShare Web Application - This is a server-side installation
  • FYB CM Launcher - This is a client-side installation

INSTALLING FYB CM2WEBSHARE WEB APPLICATION​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server
  2. Place the license file in this folder. 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
    Note

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

    2022-06-03_17-02-10.png

To install the CM2WebShare, follow these steps:

  1. Run command prompt as an administrator and launch the CM2WebShare-xxx.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

  4. Click on the Next button

    image.png

    Note

    We recommend CM2WebShare is installed under an HTTPS protected site.

    IIS Directory

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

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

    2020-09-15_12-06-13.png

    External Exposure

    If you are planning to make CM2WebShare externally accessible, it is strongly recommended that you use a dedicated account or the "Default Application Pool Identity", to restrict the applications access to your server and Content Manager environment.

    FYB assumes no responsibility for misuse or unintended access where recommendations have not been followed.

  7. On the Configuration Settings screen enter the required settings. Please refer to the table below for configuration settings details.

    image.png

    NAMEDESCRIPTION
    Dataset IDThe two alphanumeric character dataset identifier
    Workgroup Server NameThe workgroup server name used for the dataset connection. Connection can be made using either the workgroup server name or workgroup server URL.
    Workgroup Server URLThe workgroup server URL used for the dataset connection. Connection can be made using either the workgroup server name or workgroup server URL
    License PathThe path to your license file including the .lic file
    Temp PathA temporary location to store data for the application
  8. Open ID Settings (Optional). 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.

    2024-01-17_17-01-30.png

    NAMEDESCRIPTION
    Open ID ProviderChoose an Open ID Provider or select none.
    Client IDThe Client ID of the selected Open ID provider
    Authority URLThe Authority URL of the Open ID provider
    Redirect URLThe CM2Webshare URL
  9. On the Email Configuration Settings screen enter the required settings. Please refer to the table below for configuration settings details.

    image.png

    NAMEDESCRIPTION
    License ContactsThe list of email addresses that will receive a notification when the CM2WebShare 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.
  10. On the Custom Setup screen select the install location and click on the Next button

    image.png

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

    image.png

  12. The installation process will commence

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

    image.png

COMMAND LINE ARGUMENTS (OPTIONAL)​

The follow command line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
VIRTUAL_DIR_VALThe virtual directory for installing CM2WebShare
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. Use "" around the username if there are any special characters
WEB_APP_POOL_IDENTITY_PWDSets the App Pool password for the account running the application pool. Use "" around the username if there are any special characters
DBIDSets the Database ID that connects to Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to Content Manager dataset to run the application
WORKGROUP_SERVER_URLSets the Workgroup Server URL that connects to Content Manager dataset to run the application
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the temporary path that connects to the application
OPENID_TYPEThe selected Open ID Provider. 0: None, 1 : Microsoft, 2 : Okta
CLIENT_IDThe Client ID of the selected Open ID provider
AUTHORITY_URLThe Authority URL of the Open ID provider
REDIRECT_URLThe Locations Manager URL
LIC_CONTACTSSets the email address of who will be contacted regarding the expiring license
FROM_ADDRESSSets the email address all emails are sent from
MAIL_HOSTSets the mail host.
MAIL_PORTSets the mail port.

CONFIGURATION​

IIS CONFIGURATION​

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

  2. From the Features View double click on Authentication button and ensure that only Windows Authentication is enabled if you are not using Open ID Authentication

    image.png 2022-12-02_12-11-59.png

    Important

    If you are using Open ID Authentication, ensure only Anonymous Authentication is enabled.

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

    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

  6. Click on Application Pools

    image.png

  7. Within the application pool listing screen, right click on Folder Template Creator application pool and select the Advanced Settings option from the drop-down menu

    image.png

  8. Within the Advanced Settings window, set Start Mode to Always Running, Idle Time-out Action to Suspend and Idle Time-out Action (minutes) to 0

    2021-07-23_14-21-09.jpg

  9. Click on the OK button

  10. Select the CM2WebShare application in IIS and navigate to its Advanced Settings

    image.png

  11. Set Preload Enabled to True and click on the OK button

    image.png

HTTPS SITES​

If CM2WebShare is being installed under a HTTPS site then the following must be completed.

By default, CM2WebShare is set up to connect to a http site. To set up the application for HTTPS connection, please complete the following:

  1. Right click the application in IIS and select the explore option

    app.jpg

  2. Click on the Client App > Build

    image.png

  3. Right Click > Edit the Index.html file

    image.png

  4. Update the Content Security Policy from http to https

    image.png

  5. Save the file.

EMBEDDING CM2WEBSHARE​

To allow for a site to embed CM2WebShare:

  1. Navigate to the CM2WebShare's 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

    image.png

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

    image.png

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

    Note

    All sites added require the http protocol ("http://" or "https://") to be explicitly stated within the Content-Security-Policy

INSTALLING THE CM LAUNCHER​

The FYB CM Launcher needs to be installed on each users’ machine. The CM Launcher is required by CM2WebShare to perform native functions on the user’s machine such as to open a record for editing and viewing. It is specifically needed for the following link functionality:

  • View Document
  • Edit Document
  • Download PDF Rendition
Note

If you are not using any of the above features in your CM2WebShare tables then you do not need to install CM Launcher

Please refer to the CMLauncher Installation Guide to install CM Launcher.