Skip to main content

Email Tagger 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-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.

INSTALLING THE EMAIL TAGGER ADD-IN​

INSTALLATION​

  1. Create an FYB Add-ins folder on the appropriate server that contains Content Manager For Example: ‘X:\FYB Addins\

  2. Right-click on the FYB Addins folder > Properties > click on the Sharing tab

  3. If the Network Path is set to ‘Not Shared’

    image.png

  4. Click on the Advanced Sharing button

    image.png

  5. In the Advanced Sharing window, tick ‘Share this folder’ and remove the space between FYB and Addins, then add a ‘$’ sign which will keep the folder hidden

    image.png

  6. Click on the Permissions button

  7. Give ‘Everyone’ the ‘Read’ permission

    image.png

  8. A Network Path will now be available (this path is needed during the settings setup)

  9. Right-click the FYB Add-ins folder and select Security > Users > Edit and ensure the Write permission is enabled

    image.png

  10. Inside the FYB Add-ins folder create an appropriate folder to house the license file (.lic). For Example: \server\FYBAddins$\License You will be asked to enter this location when configuring the license for the add-in

  11. Move the license file into the license folder

  12. Launch the EmailTagger-110-x86/64.msi from an elevated command prompt

  13. Click Next

    2021-02-05_10-31-30.png

  14. On the Configuration Settings screen, enter the dataset ID, license path, and email tag prefix

    image.png

    NAMEDESCRIPTION
    Dataset IDThe two alphanumeric character dataset identifier
    Workgroup Server NameThe workgroup server name used to connect to the Content Manager dataset. Connection to the dataset can be completed with either the workgroup server name or URL
    Workgroup Server URLThe workgroup server URL used to connect to the Content Manager dataset. Connection to the dataset can be completed with either the workgroup server name or URL
    License PathShared network path of the license
    Email Tag PrefixThe prefix to generate email tags.
    This should be in the following format:
    <inmailx Firm ID>-<dbid>.URI
    For Example: FYB-XX.URI
  15. Click Next

  16. On the External Link screen, allows for the set up of the External Link via Email Tagger. This is optional and can be skipped.

image.png

NAMEDESCRIPTION
Link NameThe name used for the external link within Content Manager
Folder PathThe shared path to your installation path
Record Type URIsThe record type URIs used within the external link, separated by commas ','
  1. On the Destination Folder Setup screen select the install location.

    Note

    The installation location must be inside the FYB Add-ins folder you created earlier in this guide.

    2021-02-05_10-50-16.png

  2. Click Next

  3. On the Confirm Installation window click Install

    2021-02-05_10-51-42.png

  4. The installation will commence

  5. Once the installation is complete click Finish

    image(1091).png

CONFIGURATION​

info

If the external links was created by the MSI, this step can be skipped

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

    image.png

  2. Right Click and select New executable

    image.png

  3. Enter the Link Name as FYB Email Tagger

    image.png

  4. Under ‘Folder or Subfolder’, enter the Network Location of the FYB Addins\ Email Tagger\ folder obtained in step 9 of the installation section

image.png

NOTE

Please use the fully qualified domain name (FQDN) when adding the external links. For Example: If the share has been set up as \\Server\fybaddins\EmailTagger
The FQDN is \\Server.domain.local\fybaddins\EmailTagger
You can obtain the FQDN from the server you are installing on by navigating to Computer > Properties

  1. Under Executable File Name browse to the FYB Email Tagger folder and select EmailTagger.exe

    image.png

  2. Click OK

  3. Right click on the FYB Email Tagger external link > Properties

    image.png  

  4. Click the “Used By” tab.

    image.png

  5. Select all the appropriate record types For each selected record type, enter the parameter field %URI%.

image.png

  1. Click OK

  2. Right Click and select New executable

    image.png

  3. Enter the Link Name as FYB Email Tagger Config

    2021-02-05_11-21-38 2

  4. Under ‘Folder or Subfolder’, enter the Network Location of the FYB Addins\ Email Tagger\ folder obtained in step 9 of the installation section

image.png

NOTE

Please use the fully qualified domain name (FQDN) when adding the external links. For Example: If the share has been set up as \\Server\fybaddins\EmailTagger
The FQDN is \\Server.domain.local\fybaddins\EmailTagger
You can obtain the FQDN from the server you are installing on by navigating to Computer > Properties

  1. Under Executable File Name browse to the FYB Email Tagger folder and select EmailTaggerConfig.exe

    2021-02-05_11-21-38.png

  2. Click OK

  3. Right click on the FYB Email Tagger Config external link > Properties

    2021-02-05_11-34-30.png  

  4. Click the “Used By” tab

    2021-02-05_11-36-37.png

  5. Select all the same record types as selected for Email Tagger. No command line parameters are required

    2021-02-05_11-45-05.png

  6. Click OK

  7. The external link will now be accessible via the right click menu. It can also be optionally added to the Content Manager ribbon if required

UNINSTALLATION​

MANUAL UNINSTALL​

  1. Open Content Manager and click on Tools > Administration > External Links

  2. Right click the FYB Email Tagger external link > Properties

    image.png

  3. Copy the Folder path from the Folder or Subfolder field

    image.png

  4. Paste that into the file explorer to find where Email Tagger is currently installed

    image.png

  5. Delete the Email Tagger Folder including its contents

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

  7. Right click the FYB Email Tagger external link > Remove > OK

    image.png

The external link will be removed from Content Manager

MSI UNINSTALL​

To uninstall FYB Email Tagger using the MSI please follow the steps below:

  1. Double click on EmailTagger-110-x86/64 MSI.

    image.png

  2. The Email Tagger uninstallation window should appear, click the Next button.

    image.png  

  3. Click the remove button

    image.png

  4. On the next window click the Remove button.

    image.png
     

  5. If a security alert appears, click Yes

    2021-02-05_10-55-28.png

  6. The application uninstallation process will commence

  7. Click the Finish button, the application is now removed from the system.

    image(1091).png

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

  9. Right click the FYB Email Tagger external link > Remove > OK

    image.png