Skip to main content

DocULink 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-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 Add-in.

INSTALLATION COMPONENTS​

The following installation components are required to ensure complete functionality of FYB DocULink:

  • FYB DocULink Web Application - This is a server-side installation
  • FYB DocULink External Link - This is a server-side installation

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS 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.

INSTALLATION​

The fybdoculink MSI will:

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

To install the DocULink, follow these steps:

  1. Run command prompt as an administrator and launch the DocULink MSI

  2. Click the Next button

    2021-06-21_16-20-03.png

  3. On the Web Application Settings screen, select a site to host the application and enter a name for the Virtual Directory

    2021-06-21_16-21-02.png

    Note

    We recommend DocULink is installed under an HTTPS protected site.

  4. Click the Next button

  5. On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity

    2021-06-21_16-22-54.png

    Note

    The account running the app pool will need access to Content Manager. At a minimum it can be set to a Knowledge Worker account.

  6. Click the Next button

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

2021-06-21_16-24-39.png

NAMEDESCRIPTION
Dataset IDThe two alphanumeric character dataset identifier, for example: XX
Workgroup ServerThis must be set to local for CM impersonation to function correctly
Licence PathThe path to your license file including the .lic file
Temp PathA location for DocULink to write and store temp data. Please include the trailing slash, for example: D:\DocULink\Temp\
Record TypeList of available document record types for use with DocULink. Input the unique identifier of each document record type you wish to be available. If inputting more than one identifier they should be comma separated, for example: 135, 2, 14
Folder TypeList of available folder record types for use with DocULink. Input the unique identifier of each folder record type you wish to be available. If inputting more than one identifier they should be comma separated, for example: 135, 2, 14
Important

The workgroup server value should always be set to local.

  1. On the Custom Setup screen select the install location and click the Next button

    2021-06-21_16-28-27.png

  2. From the Confirm Installation window click the Install button

    2021-06-21_16-29-26.png

  3. The installation process will commence

    2021-06-21_16-30-14.png

  4. Once the installation is complete click the Finish button

    2021-06-21_16-30-35.png

CONFIGURATION​

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

2021-06-21_16-56-05.png

  1. Navigate from the Features View to Authentication and ensure Windows Authentication and ASP.NET Impersonation are the only authentication types enabled

    2021-06-21_16-31-29.png

  2. Right click the application in IIS and select explore

    app.jpg

  3. Right click the app data folder and select properties

    prop.jpg

  4. Navigate to the security tab and ensure users have read, write and modify permissions

    permiss.jpg

  5. Repeat the same steps above for the Logo folder

CONTENT MANAGER CONFIGURATION​

DocULink will require a custom record relationship to be created.

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

    Picture4.svg

  2. Locate and expand Record

    Picture5.png

  3. Navigate to -> Child Object -> Related Record -> Enumerated List -> Record Relationship

    Picture6.svg

  4. Under Record Relationship select a Custom relationship and ensure that the value states Not Customized

    Picture7.svg)

  5. Enter Linked Document for both the Caption and Caption – When Relationship is Reversed

  6. Click the OK button

    Picture8.svg

INSTALLATION​

  1. Create an FYB Add-ins folder on the appropriate Content Manager workgroup server

    image.png

  2. Right click on the FYB Addins folder and navigate to the Properties tab

  3. Click the Sharing tab

    image.png

  4. Click on the Advanced Sharing button

    image.png

  5. In the Advanced Sharing window, enable Share this folder and remove the space between FYB and Add-ins

  6. Within the Share Name field add a ‘$’ sign which will keep the folder hidden

    image.png

  7. Click on the Permissions button

  8. Give Everyone the Full Control permission

    image.png

  9. A Network Path will now be available

  10. Create a folder inside the FYB Add-ins folder to house the license file (.lic) on the server

    image.png

  11. Place the license file in this folder

    Note

    You will be asked to enter the shared path of this file during the installation

  12. Launch the doculink-xxx-32bit/64bit.msi

  13. Click the Next button

    2021-06-22_10-40-50.png

  14. On the Configuration Settings screen, enter the path for the license, temp path and the dataset ID

  15. Click the Next button

    Note

    License and Temp paths should be network shared paths. For example, \server\fybaddins$\doculink\

    2021-06-22_10-42-40.png

    NAMEDESCRIPTION
    Dataset IDThe two-character dataset identifier
    License PathThe shared path to your license file, including the ".lic"
    Temp PathThe shared path for the DocULink temp path. Ensure there is a trailing backslash "", E.g. \server\fybaddins$\DocULink\
  16. On the Destination Folder screen, select the install location and the click Next button

    Note

    The installation location must be inside the FYB Add-ins folder you created earlier in this guide.

    2021-07-16_10-42-27.jpg

  17. On the Confirm Installation window, click the Install button

    2021-06-22_10-47-00.png

  18. The installation will commence

  19. Click the Finish button once the installation is complete

    2021-06-22_10-49-23.png

CONFIGURATION​

  1. Open Content Manager and navigate it to the Administration Ribbon

  2. Click the External Links button

  3. Within the External Links window click on the New Executable button

  4. Enter the Link Name as FYB DocULink

  5. Under ‘Folder or Subfolder’, enter the Network Location of the FYB Addins\DocULink folder obtained in the INSTALLATION section

    NOTE

    Please use the fully qualified domain name (FQDN) when adding the External Links to stop security prompts For Example: If the share has been set up as \server\FYBAddIns$\DocULink
    The FQDN is \server.domain.local\FYBAddIns$\DocULink
    You can obtain the FQDN from the Server you are installing at Computer > Properties

  6. Under Executable File Name browse to the DocULink folder and select the executable file

    2021-06-22_11-31-14.png

  7. Enable the Link supports tagged processing option

    2021-06-22_11-37-03.png

  8. Click the OK button

  9. Navigate into the Properties of the DocULink Add-In that now appears and click on the Used By tab

  10. Tag all Document Record Types and enter the Parameter “%URI%” for each one

    externallink2.png

  11. The Add-In has now been deployed

CM10 CONFIGURATION​

Note

If you are on Content Manager version 10 and above there is a slight difference to the above configuration process.

  1. Tick the Use tagged command line format for single section option

  2. Into the command line parameters field add ^!Urilist^

    2021-11-04_12-18-48.jpg

To uninstall the DocULink manually please follow the steps below:

  1. Navigate to control panel

    image.png

  2. Click on uninstall a program

    image.png

  3. Locate FYB DocULink in the list of Programs and Features

  4. Right click on FYB DocULink and click on Uninstall

    2021-06-21_16-34-17.png

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

    image.png

  6. Click the Yes button

    image.png

  7. The uninstallation process will commence

    2021-06-21_16-36-16.png

  8. Open IIS once the uninstallation process is completed

  9. Locate DocULink within IIS,

  10. Right click and click the Remove button.

    2021-06-21_16-36-44.png

  11. When the prompt appears, click on the Yes button

    image.png

    Note

    Repeat steps 1 - 7 for the FYB DocULink External Link