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 the complete functionality of FYB DocULink:

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

The DocuLink MSI will need to be run on the client's machines to allow for uploading documents via DocULink.

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 on 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 on 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 on the Next button

    Note

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

    2023-10-12_12-17-31.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\
    Default Record Type URI (Optional)Specify The default record type URI when uploading new documents
  16. 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.

    2023-09-19_17-12-51.png

    NAMEDESCRIPTION
    Link NameThe name of the external link
    Folder PathThe 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.
  17. On the Destination Folder screen, select the install location and click on the 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

  18. On the Confirm Installation window, click on the Install button

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

  19. The installation will commence

  20. Click on the Finish button once the installation is complete

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

COMMAND-LINE ARGUMENTS (OPTIONAL)​

The following command-line arguments can be passed to the MSI if required.

ARGUMENTPURPOSE
DBIDSets the Database ID that connects to Content Manager dataset to run the application
WORKGROUP_SERVERSets the Workgroup Server Name that connects to Content Manager dataset to run the application.
LICENSE_PATHSets the license that connects to the application
TEMP_PATHSets the temp path that connects to the application

CONFIGURATION​

Note

This section can be skipped if the MSI has been configured to create the DocULink external link.

  1. In Content Manager click on Tools > Administration > External Links

    image.png

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

    2023-09-11_16-50-07.png

  3. Click on the External Executable option

    2023-09-11_16-51-47.png

  4. Enter the Link Name as DocULink

  5. Under ‘Folder or Subfolder’, enter the Shared Path of the folder DocULink was installed into.

    Note

    Please 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

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

    2023-09-18_11-48-25.png

  7. Enable** Link supports tagged processing**

  8. Enter ^!Urilist^ into the Command line parameters field

    2023-09-18_15-12-29.png

  9. Enable Use tagged command line format for single section

  10. On the Usage(Record) tab, select the appropriate Record Types then click Ok

    2023-09-18_11-52-30.png

RELATIONSHIP CONFIGURATION (CM10.X)​

DocULink will require a custom record relationship to be created.

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

    Picture4.svg

  2. Select Objects > Record and Search

    2023-10-12_12-25-16.png

  3. Within the Search Bar find Record Relationship

    Picture6.svg

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

  5. Select one of the Custom Record Relationships and update them to Linked Document

  6. Click on the Ok button

    2023-10-12_12-26-31.png

RELATIONSHIP CONFIGURATION (CM23.X)​

DocULink will require a custom record relationship to be created.

  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 Linked Document for both the caption and reverse caption.

  5. Click Ok

    2023-12-11_16-27-04.png

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.

Note

The MSI must be run via an elevated command prompt

To uninstall the DocULink manually please follow the steps below:

  1. Navigate to Control panel

    image.png

  2. Click on the Uninstall a program option

    image.png

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

  4. Right click on FYB DocULink and click on Uninstall option

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

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

    image.png

  6. Click on 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 on the Remove option

    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