DocULink Installation Guide
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
INSTALLING THE FYB DOCULINK WEB APP
LICENSE
-
Create a folder to house the license file (.lic) on the IIS Server
-
Place the license file in this folder
NoteYou 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:
-
Run command prompt as an administrator and launch the DocULink MSI
-
Click the Next button

-
On the Web Application Settings screen, select a site to host the application and enter a name for the Virtual Directory
NoteWe recommend DocULink is installed under an HTTPS protected site.
-
Click the Next button
-
On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity
NoteThe account running the app pool will need access to Content Manager. At a minimum it can be set to a Knowledge Worker account.
-
Click the Next button
-
On the Configuration Settings screen enter the required settings Please refer to the table below for configuration settings details

| NAME | DESCRIPTION |
|---|---|
| Dataset ID | The two alphanumeric character dataset identifier, for example: XX |
| Workgroup Server | This must be set to local for CM impersonation to function correctly |
| Licence Path | The path to your license file including the .lic file |
| Temp Path | A location for DocULink to write and store temp data. Please include the trailing slash, for example: D:\DocULink\Temp\ |
| Record Type | List 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 Type | List 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 |
The workgroup server value should always be set to local.
-
On the Custom Setup screen select the install location and click the Next button

-
From the Confirm Installation window click the Install button

-
The installation process will commence

-
Once the installation is complete click the Finish button

CONFIGURATION
After the installation process is complete, you will be able to locate the application installed within the site selected during installation.
-
Navigate from the Features View to Authentication and ensure Windows Authentication and ASP.NET Impersonation are the only authentication types enabled

-
Right click the application in IIS and select explore

-
Right click the app data folder and select properties

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

-
Repeat the same steps above for the Logo folder
CONTENT MANAGER CONFIGURATION
DocULink will require a custom record relationship to be created.
-
On the Administration ribbon of Content Manager, click the Edit Captions button
-
Locate and expand Record

-
Navigate to -> Child Object -> Related Record -> Enumerated List -> Record Relationship
-
Under Record Relationship select a Custom relationship and ensure that the value states Not Customized
)
-
Enter Linked Document for both the Caption and Caption – When Relationship is Reversed
-
Click the OK button
INSTALLING THE FYB DOCULINK EXTERNAL LINK
INSTALLATION
-
Create an FYB Add-ins folder on the appropriate Content Manager workgroup server
-
Right click on the FYB Addins folder and navigate to the Properties tab
-
Click the Sharing tab

-
Click on the Advanced Sharing button

-
In the Advanced Sharing window, enable Share this folder and remove the space between FYB and Add-ins
-
Within the Share Name field add a ‘$’ sign which will keep the folder hidden

-
Click on the Permissions button
-
Give Everyone the Full Control permission
-
A Network Path will now be available
-
Create a folder inside the FYB Add-ins folder to house the license file (.lic) on the server
-
Place the license file in this folder
NoteYou will be asked to enter the shared path of this file during the installation
-
Launch the doculink-xxx-32bit/64bit.msi
-
Click the Next button

-
On the Configuration Settings screen, enter the path for the license, temp path and the dataset ID
-
Click the Next button
NoteLicense and Temp paths should be network shared paths. For example, \server\fybaddins$\doculink\

NAME DESCRIPTION Dataset ID The two-character dataset identifier License Path The shared path to your license file, including the ".lic" Temp Path The shared path for the DocULink temp path. Ensure there is a trailing backslash "", E.g. \server\fybaddins$\DocULink\ -
On the Destination Folder screen, select the install location and the click Next button
NoteThe installation location must be inside the FYB Add-ins folder you created earlier in this guide.

-
On the Confirm Installation window, click the Install button

-
The installation will commence
-
Click the Finish button once the installation is complete

CONFIGURATION
-
Open Content Manager and navigate it to the Administration Ribbon
-
Click the External Links button
-
Within the External Links window click on the New Executable button
-
Enter the Link Name as FYB DocULink
-
Under ‘Folder or Subfolder’, enter the Network Location of the FYB Addins\DocULink folder obtained in the INSTALLATION section
NOTEPlease 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 -
Under Executable File Name browse to the DocULink folder and select the executable file
-
Enable the Link supports tagged processing option

-
Click the OK button
-
Navigate into the Properties of the DocULink Add-In that now appears and click on the Used By tab
-
Tag all Document Record Types and enter the Parameter “%URI%” for each one

-
The Add-In has now been deployed
CM10 CONFIGURATION
If you are on Content Manager version 10 and above there is a slight difference to the above configuration process.
-
Tick the Use tagged command line format for single section option
-
Into the command line parameters field add ^!Urilist^

UNINSTALLING THE FYB DOCULINK
To uninstall the DocULink manually please follow the steps below:
-
Navigate to control panel
-
Click on uninstall a program
-
Locate FYB DocULink in the list of Programs and Features
-
Right click on FYB DocULink and click on Uninstall

-
If a warning Prompt appears, click on the Continue button

-
Click the Yes button
-
The uninstallation process will commence

-
Open IIS once the uninstallation process is completed
-
Locate DocULink within IIS,
-
Right click and click the Remove button.

-
When the prompt appears, click on the Yes button
NoteRepeat steps 1 - 7 for the FYB DocULink External Link
