Link Generator Installation Guide
DISCLAIMER
Any advice FYB provide 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.
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 full functionality of the FYB Link Generator:
- FYB Link Generator API allows web links to be generated. This is a server-side installation.
- FYB Link Generator Add-In allows the interface to be accessed by users and the Admin Console to be accessed by Administrators. This is a server-side configuration.
- FYB CM Launcher allows desktop links to be generated. This is a client-side installation.
The FYB Link Generator API needs to be installed first.
INSTALLING FYB LINK GENERATOR API
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 fyblinkgeneratorapi MSI will:
- Deploy the installation files
- Setup the application pool and application in IIS
- Setup the temp folder
- Configure the Link Generator API as specified by the user
To install the Link Generator API, follow these steps:
-
Run command prompt as an administrator and launch the linkgeneratorapi-xxx.msi
NOTEYou must run the linkgeneratorapi-xxx.msi as a user that has permission to validate user credentials
-
Click on the Next button

-
On the Web Application Settings screen, select a Site to host the application and enter a name for the Virtual Directory
-
Click on the Next button
NoteYou can use an existing virtual directory or create a new one with the installer.
-
On the Application Pool Settings screen, enter the domain, username and password for the Application Pool identity
-
Click on the Next button

NAME DESCRIPTION Domain for Application Pool The domain name for the application pool identity Username for Application Pool The Username for the application pool identity Password for Application Pool The Password for the application pool identity Use Default Application Pool Identity Utilize the default application pool identity -
On the Configuration Settings screen, enter the dataset ID, workgroup server, license path and temp path
-
Click the Next button
Note• You can use an existing folder for the Temp Path or create a new one with the installer • The workgroup server name should always be set to local if using the name.
NAME DESCRIPTION Dataset ID The two-character dataset identifier Workgroup Server Name The Content Manager Workgroup Server Name used for the connection to the dataset. Database connection can be made using the workgroup server name or URL. Workgroup Server URL The Content Manager Workgroup URL used for the connection to the dataset. Database connection can be made using the workgroup server name or url. License Path The local path of the Link Generator license file, including ".lic" Temp Path The local path of the folder that the Link Generator API is to use for temporary file storage. Add Notes to Action Executed Enable for notes to be added to a record when link is executed Public Restriction Enable check to ensure only Public records are being displayed by Link Generator Public Field URI The URI of the Public Additional Field (Boolean) in Content Manager -
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:
-
Click OK to navigate to the Open Id settings screen and enter the required values.
NoteA designated CM Location is required to be nominated as the Trusted User.
No specific permissions are required to be provided.
NAME DESCRIPTION Client Id The 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 Secret The 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 User The Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app. -
If you require Explicit Windows Authentication, the Authentication Settings screen (Optional) will display. Select the Explicit Authentication checkbox and input the authentication credentials to be used by Link Generator API, then click Next. If not required, Click Next without filling out the credentials.

-
On the Destination Folder screen select the install location and click the Next button

-
From the Confirm Installation window click on the Install button

-
The installation will commence

-
Once the installation is complete click on the Finish button

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 |
| WORKGROUP_SERVER_URL | Sets the Workgroup Server URL 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 |
| WEB_APP_POOL_IDENTITY_DOMAIN | Sets the App Pool domain for the application pool |
| WEB_APP_POOL_IDENTITY_NAME | Sets the App Pool username for the account running the application pool. Use "" around the username if there are any special characters |
| WEB_APP_POOL_IDENTITY_PWD | Sets the App Pool password for the account running the application pool. Use "" around the username if there are any special characters |
CONFIGURATION
-
After the installation process is complete, you will be able to locate the application installed within the site selected during installation
-
From the Features View go to Authentication and ensure that Windows Authentication and ASP.NET Impersonation are the only authentication types enabled

INSTALLING THE LINK GENERATOR ADD-IN
INSTALLATION
-
Create an FYB Add-ins folder on the Content Manager workgroup server
-
Right click on the FYB Add-ins folder > Properties > click on the Sharing tab

-
Click on the Advanced Sharing button

-
In the Advanced Sharing window, tick ‘Share this folder’ and remove the space between FYB and Add-ins, then 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 subfolder inside the FYB Add-ins folder to house the license file (.lic) on the server.
NoteIf there is a pre-existing license folder use that instead.
-
Place the license file in this folder
NoteNote down the path to the license file, you will be asked to enter it later during the install.
-
Run command prompt as an administrator and launch the linkgenerator-xxx-32bit/64bit.msi
-
Click the Next button

-
On the Configuration Settings screen, enter the shared path for the license (including file name), shared path for the temp path and the dataset ID.
-
Click on the Next button

NAME DESCRIPTION Dataset ID The two-character dataset identifier Workgroup Server Name The Content Manager Workgroup Server Name used for the connection to the dataset. Database connection can be made using the workgroup server name or URL. Workgroup Server URL The Content Manager Workgroup URL used for the connection to the dataset. Database connection can be made using the workgroup server name or url. License Path The shared path to your license file, including the ".lic" Temp Path The shared path to the temp path for Link Generator -
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:
-
Click OK to navigate to the Open Id settings screen and enter the required values.
NoteA designated CM Location is required to be nominated as the Trusted User.
No specific permissions are required to be provided.
NAME DESCRIPTION Client Id The 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 Secret The 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 User The Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app. -
On the Configuration Settings (Continued) screen, select the default link format, enter URLs for internal, external, and web client links, and set whether or not to use thumbnail icons
-
Click on the Next button

NAME DESCRIPTION Default Link Format Set the default link format to show when Link Generator opens. This can be set to "URL, "HYPERLINK", or "HTML". Internal FYB Link Generator API URL configured for internal use
Example: https://internal/LinkGeneratorAPI/recordExternal FYB Link Generator API URL configured for external use if applicable.
Example: https://external/LinkGeneratorAPI/record
If externally accessible links are not being used, leave this field empty.Web Client The Content Manager Web client URL
Example: https://server/ContentManager?q=uri:
To disable the Web Client link, leave this field emptyThumbnail Icon To display file type icon thumbnails for Word or email hyperlinks, tick the check box. -
On the External Link Setup (Optional) screen, enter the Link Name, Folder Path and Record Type URIs
-
Click on the Next button

NAME DESCRIPTION Link Name Set the name of the External Link to be configured within CM. This will determine the default name of the button used to launch Link Generator
Example: FYB Link GeneratorFolder Path The network share path from which Link Generator will be accessed
Example: \server\fybaddins$\Link Generator\Record Type URIs Set the Record Types you would like Link Generator to be available to use on. -
On the Destination Folder screen, select the install location, this should be set to the shared FYB Add-ins folder created earlier in this guide

-
On the Confirm Installation window, click on the Install button

-
The installation will commence

-
Click on the Finish button

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 |
| LICENSE_PATH | Sets the license that connects to the application |
| FORMAT | Set the default link format to show when Link Generator opens. Value selected can be HTML, HYPERLINK or URL |
| INTERNALURL | FYB Link Generator API URL configured for internal use |
| EXTERNALURL | FYB Link Generator API URL configured for external use if applicable |
| WEBCLIENTURL | The Content Manager Web client URL |
CONFIGURATION
-
Open Content Manager and click on Tools > Administration > External Links
-
Right Click, and select New External Link
-
From the external link type list, select External executable, click OK
-
Enter the Link Name as FYB Link Generator
-
Under ‘Folder or Subfolder’, enter the Network Location of the FYB Add-ins\Link Generator folder created earlier in the guide
-
Under Executable File Name browse to the Link Generator folder and select
-
Check Link supports tagged processing
-
Under Command line parameters when doing tagged processing enter ^!Urilist^
-
Check Use tagged command line format for single selection

-
Select the Usage (Record) tab
-
Tag each of the appropriate record types.

-
Click on the OK button
-
The Add-In has now been deployed
INSTALLING CM LAUNCHER
The FYB CM Launcher needs to be installed on each users’ machine. CM Launcher is required by the Link Generator to perform native functions on the user’s machine such as open Content Manager or open a record for editing.
To install the CM Launcher, follow the install guide here
UNINSTALLING FYB LINK GENERATOR
LINK GENERATOR API
To uninstall FYB Link Generator API using the MSI please follow the steps below:
-
Launch linkgeneratorapi-xxx.msi.
-
The Link Generator API uninstallation window should appear, click Next.

-
Click on the Remove button

-
On the next screen, click on the Remove button

-
The application uninstallation process will commence

-
Click on the Finish button to remove complete the removal process

LINK GENERATOR ADD-IN
To uninstall FYB Link Generator using the MSI please follow the steps below:
-
Launch the linkgenerator-xxx-32bit/64bit.msi
-
The Link Generator uninstallation window should appear, click Next.

-
Click on the Remove button

-
On the next screen, click on the Remove button

-
The application uninstallation process will commence

-
Click on the Finish button to complete the removal process

LINK GENERATOR EXTERNAL LINK
-
Open Content Manager and click on Tools > Administration > External Links
-
Right click the FYB Link Generator external link and click on the Remove button

-
The external link will be removed from Content Manager
