Skip to main content

DocUControl Installation Guide

Raise a support ticket

DISCLAIMER​

Any advice FYB provides 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 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.

Note

When installing a newer version of DocUControl over an existing install, the DocUControl App Pool settings will need to be updated as per the IIS CONFIGURATION section.

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 the full functionality of the FYB DocUControl:

  • FYB DocUControl web application - This is a server-side installation
  • CM Launcher - This is a client-side installation (Optional)

INSTALLING FYB DOCUCONTROL​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server

  2. Place the license file in this folder

    Note

    Please be aware 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 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

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

The DocUControl MSI will:

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

To install the DocUControl Application, follow these steps:

  1. Run command prompt as an administrator and launch the docucontrol.msi

  2. Click on the Next button

    image.png

  3. On the Web Application Settings screen select the HTTPS protected site to host the application and click on the Next button

    Note

    A HTTPS site must be selected. The virtual directory name must remain as DocUControl and 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

    image.png

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

    2022-10-17_12-00-23.png  

  5. On the Configuration Settings screen enter the required information. Further details are in the table below. Click on the Next button

    2024-05-06_15-03-37.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 DocUControl 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\DocUControl\
  6. If your environment is configured to only allow OpenId authentication (e.g. Azure AD or ADFS) for your Content Manager, you'll receive the following message:

    image.png

  7. Click OK to navigate to the Open Id settings screen and enter the required values.

    2024-07-22_12-24-00.png

    NAMEDESCRIPTION
    Client IdThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the username of the Confidential Client app.
    Client SecretThe Client/App Id of the Open Id application used to secure Content Manager. For ADFS authentication, this will be the password of the Confidential Client app.
    Trusted UserThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app.
  8. On the Record Settings screen, enter the following fields:

    2023-07-14_11-17-50.png

    FIELDDESCRIPTION
    Record Type URIThe Content Manager Record Type URI that the DocUControl will utilise.
    Category Additional FieldThe Category lookup set Additional Field URI
    Topic Additional FieldThe Topic lookup set Additional Field URI
    Controlled Document Types Additional FieldThe Controlled Document Types lookup set Additional Field URI
    Published Additional FieldThe Published Additional Field URI
    Description Additional FieldThe Description Additional Field URI
    Keyword Additional FieldThe Keyword Additional Field URI
  9. On the Document Review Settings screen, enter the following fields:

    2023-12-13_10-39-28.png

    FIELDDESCRIPTION
    Document Control Officer Additional FieldThe Document Control Officer Additional Field URI
    Next Review Date Additional FieldThe Next Review Date Additional Field URI
    Obsolete Additional FieldThe Obsolete Additional Field URI
    Notification Additional FieldThe Notification Additional Field URI
    DocUControl URLThe URL of DocUControl, used to generate CMLauncher Hyperlinks in emails
  10. On the Email Settings screen, enter the following fields

    2025-03-06_15-32-46.png

    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
    SMTP username (optional)The username used to authenticate with your SMTP server
    SMTP password (optional)The password used to authenticate with your SMTP server
  11. On the Custom Setup screen select the install location and click on the Next button

    image.png

  12. From the Confirm Installation window click the Install button

image.png   13. The installation will commence

image.png

  1. Once the installation is complete click 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 button and ensure that only Windows Authentication is enabled

    2022-10-17_13-47-55.png 2022-12-02_12-11-59.png

  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 DocUControl 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 AlwaysRunning, 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 DocUControl application in IIS and navigate to its Advanced Settings

    2021-07-23_14-27-06.jpg

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

    2021-07-23_14-30-29.jpg

CONTENT MANAGER CONFIGURATION​

The following additional fields are mandatory and need to be on the Record Type that you will be using for the document control process.

Note

All names of fields below are examples and can be set to your organisation's desired terminology.

DOCUMENT REVIEW FIELDS​

NAMEDATA FORMATDESCRIPTION
Next Review DateDateDetermines the next review date of the document. This is used by the scheduler service to create new versions and determine when documents are overdue.
Policy OwnerLocationThis is the location that will receive the overdue notification email.
Document Control OfficerLocationThis is the location that will receive the next version notification email.
ObsoleteBooleanIf checked, the record will be skipped by the Document Review scheduler.
Is DraftBooleanThis value is to be marked as True for Draft Document Records. Note: This field is only mandatory and relevant when using the Use Draft Relationship Drafting process option.

INTERFACE FIELDS​

NAMEDESCRIPTIONDATA FORMAT
Category These are the categories that will appear as selectable items in the Top Menu Navigation.
String (lookup set)
TopicThis will be the first browsing tab

String (lookup set)
Controlled Document Type This will be the second browsing tab

String (lookup set)
DescriptionThis will be the description that appears under the title of documents.
Text
KeywordsThis allows users to quickly search for policy documents that match a certain keyword.
Tick Include in the metadata schema when indexing records option when creating this field.
Text
Published?This allows the user to specify that a document is published by enabling the Published field.Boolean
Acknowledgement Required?This allows the user to specify that a document requires acknowledgement by enabling the Acknowledgement Required field.Screenshot 2024-09-20 104608.pngBoolean
Notification SentUsed for marking when a notification has been sent for a newly published Record.Boolean

DRAFT RELATIONSHIP CONFIGURATION (CM23.X)​

Note

This is only required when using the Use Draft Relationship option

  1. On the Administration ribbon of Content Manager, click on the Edit Captions button

    Picture4.svg

  2. Select Objects > Record and click Search

    2023-12-11_16-22-09.png

  3. Type Relation into the search bar, and select a Custom Relation that is not customized.

    2023-12-11_16-25-07.png

  4. Specify Has Draft for both the caption and Draft Of reverse caption.

  5. Click Ok

    2024-04-22_17-28-22.png

INSTALLING CM LAUNCHER (OPTIONAL)​

Note

Installing CMLauncher is optional. To launch documents in Content Manager from DocUControl without CMLauncher, enable the Content Manager Link Type option in the Admin Console

The FYB CM Launcher needs to be installed on each user’s machine. The CMLauncher is required by DocUControl to perform native functions on the user’s machine such as opening links to overdue documents. Please refer to the dedicated CM Launcher installation guide for further details: https://docs.fybsoftware.com.au/docs/cmlauncher-installation-guide-321

UNINSTALLING FYB DOCUCONTROL​

To uninstall FYB DocUControl using the MSI please follow the steps below:

  1. Double-click on DocUControl MSI

    image.png

  2. The DocUControl uninstallation window will appear

  3. Click on the Next button

    image.png

  4. Click on the Remove button

    image.png

  5. On the next window click on the Remove button

    image.png

  6. The application uninstallation process will commence

    image.png

  7. Click on the Finish button, the application is now removed from the system

    image.png