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 the complete functionality of FYB DocULink:
- FYB DocULink External Link - This is a server-side installation
The DocuLink MSI will need to be run on the client's machines to allow for uploading documents via DocULink.
INSTALLING THE FYB DOCULINK EXTERNAL LINK (SERVER SIDE)
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 on 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 on the Next button

-
On the Configuration Settings screen, enter the path for the license, temp path and the dataset ID
-
Click on 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\ Default Record Type URI (Optional) Specify The default record type URI when uploading new documents -
On the External Link Setup screen, fill in the details below. This step is optional and can be skipped. Filling in the fields will allow the MSI to create the DocULink External Link in Content Manager.

NAME DESCRIPTION Link Name The name of the external link Folder Path The Fully Qualified Domain Name of the folder that will contain the DocULink executable. The path must be inside the FYB Add-ins folder you created earlier in this guide. -
On the Destination Folder screen, select the install location and click on the 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 on the Install button

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

COMMAND-LINE ARGUMENTS (OPTIONAL)
The following command-line arguments can be passed to the MSI if required.
| ARGUMENT | PURPOSE |
|---|---|
| DBID | Sets the Database ID that connects to Content Manager dataset to run the application |
| WORKGROUP_SERVER | Sets the Workgroup Server Name that connects to Content Manager dataset to run the application. |
| LICENSE_PATH | Sets the license that connects to the application |
| TEMP_PATH | Sets the temp path that connects to the application |
CONFIGURATION
ADDING THE EXTERNAL LINK
This section can be skipped if the MSI has been configured to create the DocULink external link.
-
In Content Manager click on Tools > Administration > External Links

-
Right click in the Content Manager external links window and select New External Link

-
Click on the External Executable option

-
Enter the Link Name as DocULink
-
Under ‘Folder or Subfolder’, enter the Shared Path of the folder DocULink was installed into.
NotePlease use the fully qualified domain name (FQDN) when adding the External Link. 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
-
Enable** Link supports tagged processing**
-
Enter ^!Urilist^ into the Command line parameters field

-
Enable Use tagged command line format for single section
-
On the Usage(Record) tab, select the appropriate Record Types then click Ok

RELATIONSHIP CONFIGURATION (CM10.X)
DocULink will require a custom record relationship to be created.
-
On the Administration ribbon of Content Manager, click on the Edit Captions button
-
Select Objects > Record and Search

-
Within the Search Bar find Record Relationship
-
Under Record Relationship select a Custom relationship and ensure that the value states Not Customized
-
Select one of the Custom Record Relationships and update them to Linked Document
-
Click on the Ok button

RELATIONSHIP CONFIGURATION (CM23.X)
DocULink will require a custom record relationship to be created.
-
On the Administration ribbon of Content Manager, click on the Edit Captions button
-
Select Objects > Record and click Search

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

-
Specify Linked Document for both the caption and reverse caption.
-
Click Ok

INSTALLING DOCULINK (CLIENT SIDE)
The same MSI is used to install DocULink on the client's machines. This is to allow clients to access the Upload Page of DocULink.
The MSI must be run via an elevated command prompt
UNINSTALLING THE FYB DOCULINK
To uninstall the DocULink manually please follow the steps below:
-
Navigate to Control panel
-
Click on the Uninstall a program option
-
Locate FYB DocULink in the list of Programs and Features
-
Right click on FYB DocULink and click on Uninstall option

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

-
Click on the Yes button
-
The uninstallation process will commence

-
Open IIS once the uninstallation process is completed
-
Locate DocULink within IIS
-
Right click and click on the Remove option

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