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

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
Asset IdString, Maximum Length: 255Stores the Asset IdDocument
Bay IdString, Maximum Length: 255Stores the Bay IdDocument
Channel NameString, Maximum Length: 255Used to store the name of the Team Channel that the document was checked out toDocument
CommentsString, Maximum Length: 255Stores the CommentsDocument
Date ApprovedDateThe Date the Drawing was approved for update/reviewDocument
Date RequestedDateThe Date the Drawing was requested for update/reviewDocument
Drawing ApproverString, Maximum Length: 255Stores the Drawing ApproverDocument
Drawing GroupString, Lookup SetStores the Drawing GroupDocument
Drawing LocationLocationStores the Drawing LocationDocument
Drawing NumberString, Maximum Length: 255Stores the Drawing NumberDocument
Drawing ReviewerString, Maximum Length: 255Stores the Drawing ReviewerDocument
Drawing Review StatusString, Maximum Length: 255Stores the Drawing Review StatusDocument
Drawing StatusString, Lookup SetStores the Drawing StatusDocument
Drawing TypeString, Lookup SetStores the Drawing TypeDocument
Expected Return DateDateThe Date that the Record is expected to return from TeamsDocument
Project IdString, Maximum Length: 255Stores the Project IdDocument
SiteString, Maximum Length: 255The Site NameDocument
Team NameString, Maximum Length: 255Used to store the name of the Microsoft Team that the document was checked out toDocument
Transmittal DateDateThe Date that the Record was sent to TeamsDocument

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 THE POWER AUTOMATE FLOWS​

Note

A per-user or per-flow Power Automate license is required to run and save the provided flows.

Note

The provided flows are examples of what you can do with the Power Automate platform and Drawings2CM. You can use these as a basis to design workflows that suit your organization.

INSTALLATION​

  1. In the browser of your choice, sign in to Power Automate

  2. Click on My Flows

    2023-01-18_15-35-54.png

  3. Click on Import, and click on the drop down option of Import Package (Legacy)

    2023-01-18_15-39-10.png

  4. Click on the Upload button

    2023-01-18_15-41-50.png

  5. Locate the Drawings2CM Update Flow.zip file and click on the Open button

    2023-01-18_15-44-56.png

  6. Once the zip file has finished uploading, you will be navigated to the page below

    2023-01-18_15-46-26.png

  7. For Approvals click on the Select during import button

    2023-01-18_15-52-33.png

  8. Select an existing Approval connection or click on the Create New button

    2023-01-18_15-53-17.png

If a new connection is required, create a new Microsoft Approval connection after clicking Create New

2023-01-18_15-54-54.png

  1. Click on the Save button

    2023-01-18_15-58-10.png

  2. For the Office Outlook Connection, click Select during Import

    2023-01-18_16-03-06.png

  3. Select an Office 365 Connection and click Save

    2023-01-18_16-06-39.png

  4. Click Import

    2023-01-18_16-08-12.png

  5. Once the flow has been imported, click Open flow

    2023-01-18_16-11-16.png

  6. Ensure to turn on the flow

    2023-01-18_16-12-51.png

  7. Repeat the steps above for the Drawings2CM Review flow and Drawings2CM Project Closure flow using the Drawings2CM Review Flow.zip and Drawings2CM Project Closure Flow.zip

CONFIGURATION​

Note

These steps are required for all three flows imported above.

  1. In the My Flows section of Power Automate, click the pencil icon for the Drawings2CM Review Flow flow

    2023-01-18_16-23-48.png

  2. Expand the Condition action, then expand the HTTP action

    2023-01-18_16-27-09.png

  3. In the URI section, replace example.com.au with the domain of the site that Drawings2CM is installed under

    2023-01-18_16-32-03.png

  4. Click Show advanced options

    2023-01-18_16-36-11.png

  5. Update all fields with the Azure App registration details

    2023-01-18_16-37-34.png

    NameDescription
    {Tenant ID}The Azure Tenant ID
    {Client ID}The Client ID of the Drawings2CM Azure App
    {Client Secret}The Client Secret of the Drawings2CM Azure App
  6. On the HTTP action, click the ellipsis

    2023-01-18_16-43-19.png

  7. Click on the Settings options

    2023-01-18_16-47-13.png

  8. Ensure that Secure Inputs and Secure Outputs are both turned on. This is to protect sensitive data such as the Client Secret

    2023-01-18_16-51-09.png

Once enabled your action will look like the below.

2023-01-18_16-54-37.png

  1. Click on the Save bottom

    2023-01-18_16-52-23.png

  2. Click on the Back button

    2023-02-23_11-37-07.png

  3. Click on the Turn On button to turn on the flow

    2023-02-23_11-38-02.png

  4. Repeat the above steps for the Drawings2CM Update Flow and Drawings2CM Project Closure Flow

    Warning

    These flows should be considered sensitive information as they contain the Drawings2CM Azure Client Secret - do not give control of the flow to unauthorized staff.

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