Skip to main content

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

Breaking Changes

Upgrading from version 1.0.22 will cause a breaking change. To preserve existing settings, a backup of your current version must be taken and existing settings will need to be re-imported via the admin console after installation is complete.

You should complete a full uninstall of the previous version before installing this version. The uninstall steps can be found in the relevant versions installation guide.

LICENSE DETAILS​

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

INSTALLATION COMPONENTS​

The following installation components are required for Drawings2CM:

  • Drawings2CM web application - this is a server-side installation
  • Power Automate Flows - required for the workflow engine

AUTHENTICATION​

The Drawings2CM 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 Microsoft 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 THE DRAWINGS2CM WEB APPLICATION​

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​

  1. 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.
  2. 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 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 8 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

Once the above is completed you can run the Drawings2CM MSI which will complete the following:

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

To install the Drawings2CM web service, follow these steps:

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

  2. Click on the Next button

    2022-06-15_17-18-39.png

  3. On the Web Application Settings screen select the HTTPS protected site to host the application. Click Next

    Note

    The virtual directory name must remain as Drawings2CM and it cannot be renamed. The virtual directory must match the redirect URI setup for the application on Azure AD.

    IIS Directory

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

    image.png

    2022-06-15_17-20-32.png

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

  5. Click Next

    2022-06-27_11-37-31.png

  6. 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
    • Certificate Name

    2024-05-09_17-10-10.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 Drawings2CM license file
    Temp PathLocal temporary directory used by the application to cache content manager documents
    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 server.
  7. On the Email Settings screen, enter the following fields

    2022-06-27_11-41-40.png

    FIELDDESCRIPTION
    License ContactsContacts that will receive a notification when the Drawings2CM 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.
    Mail PortThe mail port
  8. On the Custom Setup screen select the install location and click on the Next button

    2022-06-27_11-42-10.png

  9. Confirm the installation by clicking on the Install button

    2022-06-27_11-42-28.png

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

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

    2022-06-15_17-24-19.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 Drawings2CM and click Advanced Settings

    2022-06-27_11-44-28.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 Drawings2CM app and navigate to Manage Application > Advanced Settings

    2022-06-27_11-45-01.png

  3. Ensure that Preload Enabled is set to true

    2022-06-27_11-45-40.png

CONTENT MANAGER CONFIGURATION​

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

NameData FormatDescriptionRecord Types
365IDString, Maximum Length: 255Stores the document's SharePoint Id. Prevents duplication of Sharepoint documents that have been transferred to CM as RecordsDocument
Asset IdString, Maximum Length: 255Used when searching for Drawings Records as well as a field in the CSV file generated by a TransmittalDocument
Bay IdString, Maximum Length: 255Used when searching for Drawings Records as well as a field in the CSV file generated by a TransmittalDocument
Channel NameString, Maximum Length: 255Used to store the name of the Team Channel that the document was checked out toDocument
Drawing GroupString, Lookup SetUsed as a field when generating the transmittal CSVDocument
Drawing LocationLocationUsed as a field when generating the transmittal CSVDocument
Drawing NumberString, Maximum Length: 255Used when searching for Drawings Records as well as a field in the CSV file generated by a TransmittalDocument
Drawing StatusString, Lookup SetUsed as a field when generating the transmittal CSVDocument
Drawing TypeString, Lookup SetUsed when searching for Drawings Records as well as a field in the CSV file generated by a TransmittalDocument
Project IdString, Maximum Length: 255Stores the Project Id when creating a ProjectDocument
Team NameString, Maximum Length: 255Used to store the name of the Microsoft Team that the document was checked out toDocument

DRAWINGS2CM CONFIGURATION​

  1. Navigate to Drawings2CM in the browser of your choice and click on the Admin button

    2022-08-02_9-34-35.png

  2. Click on the Misc tab

    2022-08-02_10-44-40.png

  3. Specify the Record Type to be used for Drawings2CM and fill in the mandatory fields associated with the record type

    2022-08-02_10-49-09.png

  4. Scroll to the bottom of the page and click on the Save button

    2022-08-02_10-52-45.png

INSTALLING CM LAUNCHER​

The FYB CMLauncher can be installed if required. It allows users to open documents in AutoCAD from Drawings2CM. CMLauncher needs to be deployed to the user's PC.

Please refer to the CMLauncher Installation Guide for further details.

UNINSTALLING DRAWINGS2CM​

To uninstall FYB Drawings2CM manually please follow the steps below:

  1. Navigate to the Control Panel

    image.png

  2. Click on Uninstall a program

    image.png

  3. Locate FYB Drawings2CM in the list of Programs and feature

  4. Right-click on FYB Drawings2CMM and click on Uninstall

    2022-06-27_13-22-00.png

  5. If a warning Prompt appears, click on the continue button

    image.png  

  6. Click on the Yes button

    2022-06-27_13-22-24.png

  7. The uninstallation process will commence

    2022-06-27_11-50-51.png

  8. Open IIS once the uninstallation process is completed

  9. Locate Drawings2CM in IIS, right click and click the Remove button

    2022-06-27_13-24-12.png

  10. When the prompt appears click the “Yes” button

    image.png