Skip to main content

PDF Generator Installation Guide

Raise a support ticket

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 Connector.

INSTALLATION COMPONENTS​

The following installation components are required to ensure full functionality of the FYB PDF Generator:

  • FYB PDF Generator Add-In - this is a server-side deployment.

INSTALLING THE PDF GENERATOR ADD-IN​

INSTALLATION​

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

    image.png

  2. Right click on the FYB Add-ins folder > Properties and click on the Sharing tab

    image.png

  3. Click on the Advanced Sharing button

    image.png

  4. 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

    image.png

  5. Click on the Permissions button

  6. Give Everyone the Full Control permission

    image.png

  7. A Network Path will now be available

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

    image.png

  9. Place the license file in this folder. You will be asked to enter the shared path of this file during the installation

  10. Launch the fybpdfgenerator-xxx-32bit/64bit.msi

  11. Click on the Next button

    image.png

  12. On the Configuration Settings screen, enter the license path, temp path and select the PDF Format. To enable inMailX tags to be included in email subjects, enter the email tag prefix.

  13. Click on the Next button

2021-10-19_11-45-56.jpg

NAMEDESCRIPTION
Database IdSets the Database ID that connects to Content Manager dataset to run the application
LicenseShared network path of the license file
Temp PathShared network path of the temp path
PDF FormatThe format of PDF files that will be generated
Email Tag PrefixThis is optional for users that have inMailX. This tag will be added to any email subject lines when using the send pdf via email option. This should be in the following format: INMAILX FIRM ID-DBID.URI (without spaces). For Example: FYB-FT.URI
  1. On the Configuration Settings (Continued) screen, set the finalisation settings and click on the Next button

    image.png

    NAMEDESCRIPTION
    Finalise record for PDF revisionRecord will be finalised after using the Generate PDF Revision option
    Finalise record for PDF renditionRecord will be finalised after using the Generate PDF Rendition option
    Finalise record for PDF emailRecord will be finalised after using the Send PDF via Email option
  2. On the Destination Folder screen, make sure that you update the installation path to the FYB Add-ins folder created in Step 1, and click on the Next button

    image.png

    Note

    Ensure that the User group has read and write permission on the installation directory chosen above (PDF Generator folder).

  3. On the Confirm Installation window click on the Install button

    image.png

  4. Once the installation is complete, click on the Finish button

    image.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
LICENSE_PATHSets the license that connects to the application. This needs to be the shared network path of the license file
TEMP_PATHShared network path of the temp folder location.
FORMATSets the format of PDF files that will be generated
PREFIXThis is optional for users that have inMailX. This tag will be added to any email subject lines when using the send pdf via email option. This should be in the following format: INMAILX FIRM ID-DBID.URI (without spaces). For Example: FYB-FT.URI

CONFIGURATION​

PDF Generator will require the setup of five individual external links. Please repeat the below steps for all external links listed in the table below.

LINK NAMEEXECUTABLE NAMECOMMAND LINE PARAMETERS
Generate PDF RenditionFYBPDFGeneratorRendition.exe%URI%
Generate PDF RevisionFYBPDFGeneratorRevision.exe%URI%
Send PDF via EmailFYBPDFGeneratorEmail.exe%URI%
Merge Documents to PDFFYBPDFGeneratorMerge.exe%URI%
PDF Generator ConfigFYBPDFGeneratorConfig.exe%URI%
  1. In Content Manager (Context) navigate to the Administration Ribbon and click on the External Links button

    image.png

  2. Within the External Links window perform a right-click and select New External Link from the drop-down menu

    image.png

  3. From the external link type list, select External Executable and click on the OK button

    2021-10-06_11-27-34.jpg

  4. Under Link name, enter the link name from the table above.

  5. Under Folder or Subfolder enter the Network Location of the FYB Addins > PDF Generator folder

  6. Under Executable file name browse to the PDF Generator folder and select the executable name from the table above.

    image.png

  7. Check the Link Supports tagged processing

    2021-10-19_12-05-04.jpg

  8. Select the Used By tab

  9. Select all the appropriate record types

    2021-10-19_12-05-56.jpg

  10. Enter the Command Line Parameters from the table above

  11. Click on the OK button

  12. Repeat the process for all five external links using the table above

    image.png

PDF Generator will require the setup of five individual external links. Please repeat the below steps for all external links listed in the table below.

LINK NAMEEXECUTABLE NAMECOMMAND LINE PARAMETERS
Generate PDF RenditionFYBPDFGeneratorRendition.exe^!Urilist^
Generate PDF RevisionFYBPDFGeneratorRevision.exe^!Urilist^
Send PDF via EmailFYBPDFGeneratorEmail.exe^!Urilist^
Merge Documents to PDFFYBPDFGeneratorMerge.exe^!Urilist^
PDF Generator ConfigFYBPDFGeneratorConfig.exe^!Urilist^
  1. In Content Manager (Context) navigate to the Administration Ribbon and click on the External Links button

    image.png

  2. Within the External Links window perform a right-click and select New External Link from the drop-down menu

    image.png

  3. From the external link type list, select External Executable and click on the OK button

    2021-10-06_11-27-34.jpg

  4. Under Link name, enter the link name from the table above

  5. Under Folder or Subfolder enter the Network Location of the FYB Addins > PDF Generator folder

  6. Under Executable file name browse to the PDF Generator folder and select the executable name from the table above

    image.png

  7. Check the Link Supports tagged processing

  8. Enter the Command Line Parameters from the table above

  9. Check Use tagged command line format for single selection

    2021-10-12_16-20-05.jpg

  10. Select the Usage (Record) tab

  11. Select all the appropriate record types

    2021-10-06_11-52-41.jpg

  12. Click on the OK button

  13. Repeat the process for all five external links using the table above

    image.png

UNINSTALLING FYB PDF GENERATOR​

PDF GENERATOR MSI​

To uninstall FYB PDF Generator using the MSI please follow the steps below:

  1. Double click on the fybpdfgenerator-31x-32bit/64bit.msi

  2. The PDF Generator uninstallation window will appear

  3. Click on the Next button

    image.png

  4. Click on the Remove button

    image.png

  5. Click on the Remove button again in the next window displayed

    image.png

  6. If a security prompt appears, click the Yes button

    image.png

  7. The application uninstallation process will commence

    image.png

  8. Click on the Finish button to remove the application from the system

    image.png

  1. Open Content Manager and navigate to the Administration Ribbon

  2. Click on the External Links button

  3. Right click the FYB PDF Generator external click > Remove > OK

    image.png

  4. Repeat the process for all five external links