Skip to main content

365|2CM 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.

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 required to ensure full functionality of 365|2CM:

  • 365|2CM web application - this is a server-side installation

AUTHENTICATION​

The 365|2CM application uses Azure AD authentication to validate the user’s credentials. Users will be required to enter their M365 login details to sign into the application. The user's M365 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 THE 365|2CM 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

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. The account running the app pool will need to have a valid Content Manager login.

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

    2024-10-23_13-58-47.png

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

    2024-10-23_13-59-45.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

To install the 365|2CM web service, follow these steps:

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

  2. Click on the Next button

    image.png

  3. 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 name must remain as 3652CM and it cannot be renamed. The virtual directory must match the redirect URI setup for the application on Azure AD

    IIS Directory

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

    image.png

    image.png

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

  5. Click on the Next button

    2023-12-04_16-50-53.png

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

    2024-05-08_17-32-47.png

    FIELDDESCRIPTION
    Dataset IDContent Manager two-character dataset identifier
    Dataset NameThe name of your Content Manager Dataset
    Workgroup ServerContent Manager workgroup server name. This should generally be set to local
    Workgroup ServerContent Manager workgroup server URL.
    License PathLocal path to 3652CM 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\3652CM\
    Redirect URLThe URL where Azure will send the authentication payload upon successful authentication.
    Application IDThe application ID for the registered app on AzureAD
    Tenant IDThe organization tenant's unique identifier on AzureAD
    Certificate NameThe friendly name of the nominated certificate (.pfx) installed on the machine.
    Note

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

    • Application ID
    • Redirect URL
    • Tenant ID
    • Certificate Name
  7. On the Email Settings screen, enter the following fields

    2021-05-17_10-52-28.jpg

    FIELDDESCRIPTION
    License ContactsContacts that will receive a notification when the 3652CM license is about to expire. Multiple email addresses can be added if separated with a ;
    From AddressThe email address that all email notifications are sent from.
    Mail HostThe mail host that is used to send all email notifications from.
    Mail PortThe mail port
  8. On the Custom Setup screen select the install location and click on Next button

    image.png

  9. Confirm the installation by clicking on the Install button

    image.png

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

    image.png

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 and ensure that only Anonymous Authentication is enabled

    image.png Anonymous

  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

  6. Click on Application Pools

    image.png

  7. Locate 3652CM and click Advanced Settings

    image.png

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

    image.png

  9. 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. Right click on the 3652CM app > Manage Application > Advanced Settings

    image.png

  3. Ensure that Preload Enabled is true

    image.png

CONTENT MANAGER CONFIGURATION​

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

NameData FormatDescriptionRecord Types
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
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
3652CM SourceString, Maximum Length: 255Used to store the source location of the document to be displayed on the Activities pageDocument
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

CLIENTLESS CONFIGURATION (OPTIONAL)​

If FYB 365|2CM was installed in an environment that does not have the Content Manager client installed, please follow the steps below:

  1. You will need to obtain the following files from an environment where a 64 bit version of Content Manager has been installed by navigating to the install directory of Content Manager (e.g. C:\Program Files\Micro Focus\Content Manager):

    image.png

  2. Copy the files listed above and paste them into the bin folder in the installation directory of 365|2CM (e.g. C:\Program Files\FYB Pty Ltd\3652CM\bin)

  3. Right-Click the 365|2CM app in IIS and click Explore

    2022-02-07_14-38-50.png

  4. Open the appsettings.json file in the text editor of your choice

    2022-03-10_13-50-37.png

  5. Update the value of the TrimAssembliesPath to the folder specified in step 2

    image.png

  6. Complete an app pool restart

    Warning!

    Ensure the Microsoft Visual C++ Redistributables are installed if using this feature.

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 365|2CM. 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. 365|2CM 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 TEAMS CHAT CAPTURE (OPTIONAL)​

For Teams Chats to be automatically archived, 365|2CM must be created as a Teams Personal Tab App and uploaded to Teams. This is because the user's access token is required to archive their chats without user interaction and without 365|2CM needing to be open in a browser.

Note

The chat capture app is user-specific and every user that wishes to use it must upload it to their own instance of teams. The steps below are for the IT Team/Admin to create an app package that can then be distributed to end-users. Steps for uploading the app package into Teams can be found in the user guide.

CREATING A PERSONAL TEAMS TAB APP​

  1. Navigate to the Teams Developer Portal

  2. Click on the New App button

    2023-02-06_16-03-11.png

  3. Supply a name and click App

    d.png

  4. Click on the Domains section and click on Create your first domain

    2023-02-06_16-08-12.png

  5. Enter the domain of the site that 365|2CM is installed under and click on the Add button

    2023-02-06_16-10-59.png

  6. Click Add a Domain

    2023-02-06_16-12-56.png

  7. Enter login.microsoftonline.com and click on the Add button

    2023-02-06_16-11-56.png

  8. Repeat steps 6 and 7 and add teams.microsoft.com as a domain

    2023-02-06_16-13-49.png

  9. Click on App Features then click Personal App

    2023-02-06_16-14-50.png

  10. Click Create your first personal app tab

    2023-02-06_16-16-53.png

  11. Add the information below and click on the Confirm button

    2023-02-06_16-17-53.png

    NAMEDESCRIPTION
    Name3652CM Chat Capture
    Entity IdUse the supplied default value
    Content URLThe URL of 3652CM followed by /TeamsChat. For example: https://example.com.au/3652CM/TeamsChat
    Website URLThe same value as the Content URL
  12. Click on the Save button

    2023-02-06_16-19-16.png

  13. Click on Basic Information then fill in the information below, then click on the Save button

    2023-02-06_16-33-03.png

    NAMEVALUE
    Developer or company nameFYB
    Website (must be a valid HTTPS URL)https://fyb.com.au
    Privacy policyhttps://fyb.com.au/privacy
    Terms of usehttps://fyb.com.au/end-user-license-agreement
  14. Click on Apps

    2023-02-06_16-20-11.png

  15. Next to your app click the ellipsis and then click Download App Package. This zip file will be required when uploading the Chat Capture app to Teams

    2023-02-06_16-20-46.png

    Note

    Please refer to the user guide for details on uploading the app package to your instance of Teams (user-specific). It is recommended that you store the app package somewhere your end-users can access it as each user has to upload it themselves if they wish to make use of it.

INSTALLING CM LAUNCHER (OPTIONAL)​

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

UNINSTALLING 365|2CM WEB SERVICE​

To uninstall FYB 365|2CM manually please follow the steps below:

  1. Navigate to Control Panel

    image.png

  2. Click on Uninstall a program

    image.png

  3. Locate FYB 365|2CM in the list of Programs and feature

    image.png

  4. Right click on FYB 365|2CM and click on the Uninstall option

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

    image.png

  8. Open IIS once the uninstallation process is completed

  9. Locate 365|2CM in IIS, right click and click on the Remove button

    image.png

  10. When the prompt appears click on the Yes button

    image.png