Skip to main content

Folder Template Creator 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 consider 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.

Folder Template Reader License Update

If migrating from a previous version of Folder Template Creator, please contact Accounts to receive your new Folder Template Reader license.

Folder Template Creator will now require 2 separate licenses, one for Folder Template Creator web application, and a Folder Template Reader license for the dll.

INSTALLATION COMPONENTS​

The following installation components are required to ensure full functionality of the FYB Folder Template Creator:

  • Folder Template Creator Web Application
    • This is a server-side installation
  • Folder Template Creator Reader
    • This is a server-side installation
Note

The Folder Template Creator Web Application must be installed first.

INSTALLING FOLDER TEMPLATE CREATOR WEB APPLICATION​

LICENSE​

  1. Create a folder to house the license file (.lic) on the IIS Server

  2. Place the license file in this folder

    Note

    You 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 FYB Folder Template Creator MSI will:

  • Deploy the installation files
  • Setup the application pool and application in IIS
  • Setup the temporary folder
  • Configure the application settings as specified by the user

To install Folder Template Creator, follow these steps:

  1. Run command prompt as an administrator and launch the foldertemplatecreator-2.3.x.msi

  2. Click on the Next button

    image.png

  3. On the Web Application Settings screen, select a Site to host the application and enter a name for the virtual directory

    Note

    You can use an existing virtual directory or create a new one with the installer.

    IIS Directory

    The application must be installed under the dedicated site as an application. It cannot be installed at the site level

    image.png

  4. Click on the Next button

    2020-10-01_16-13-58.jpg

  5. On the Application Pool Settings screen, enter the domain, username, and password for the Application Pool identity

  6. Click on the Next button

image.png

  1. Enter your Configuration Settings below and click Next

    image.png

    NAMEDESCRIPTION
    Dataset IDThe two alphanumeric character dataset identifier.
    Workgroup ServerContent Manager workgroup server name. This should generally be set to local
    Workgroup Server URLContent Manager workgroup server URL.
    License PathThe path to your license including the .lic file.
    Temp PathA temporary location to application files when Folder Template Creator web service connects to Content Manager.
  2. 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:

    image.png

  3. Click OK to navigate to the Open Id settings screen and enter the required values.

    image.png

    Note

    A designated CM Location is required to be nominated as the Trusted User.

    No specific permissions are required to be provided.

    NAMEDESCRIPTION
    Client IdThe 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 SecretThe 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 UserThe Network Login value of the Content Manager Confidential Client app location. For ADFS authentication, this will be the username of the Confidential Client app.
  4. Open ID Settings (Optional). The values of the required fields can be found in the respective Open ID guides.

    image.png

    NAMEDESCRIPTION
    Open ID ProviderChoose an Open ID Provider or select none.
    Client IDThe Client ID of the selected Open ID provider
    Authority URLThe Authority URL of the Open ID provider
    Redirect URLthe Folder Template Creator URL
  5. On the Email Settings Screen, enter the configuration settings below and click on the Next button

    2020-10-01_16-29-11.jpg

    NAMEDESCRIPTION
    License ContactsThe list of email addresses that will receive a notification when the Folder Template Creator License is about to expire.
    From AddressThe email address that all emails are sent from.
    Mail HostThe email host system that will send all email notifications.
    Mail PortThe Simple Mail Transfer Protocol port that will assist the host mail system send all emails.
  6. On the Custom Setup screen select the install location and click on the Next button

image.png

  1. From the Confirm Installation window click on the Install button

    image.png

  2. The installation process will commence

    image.png

  3. 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
WEB_APP_POOL_IDENTITY_DOMAINSets the App Pool domain for the application pool
WEB_APP_POOL_IDENTITY_NAMESets 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_PWDSets the App Pool password for the account running the application pool. Use "" around the username if there are any special characters
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 temporary path that connects to the application
LIC_CONTACTSSets the email address of who will be contacted regarding the expiring license
FROM_ADDRESSSets the email address all emails are sent from
MAIL_HOSTSets the mail host
MAIL_PORTSets the mail port

CONFIGURATION​

IIS CONFIGURATION​

  1. After the installation process is complete, you will be able to locate the application installed within the site selected during installation

  2. From the Features View double click on Authentication button and ensure that only Windows Authentication is enabled if you are not using Open ID Authenticaion

    image.png 2022-12-02_12-11-59.png

    Important

    If you are using Open ID Authentication, ensure only Anonymous Authentication is enabled

  3. Right click the application in IIS and select theexplore option

    app.jpg

  4. Right click on the app data folder and select properties

    prop.jpg

  5. Navigate to the security tab and ensure users have read, write and modify permissions

    permiss.jpg

  6. Click on Application Pools

    image.png

  7. Within the application pool listing screen, right click on Folder Template Creator application pool and select the Advanced Settings option from the drop-down menu

    image.png

  8. Within the Advanced Settings window, set Start Mode to AlwaysRunning, Idle Time-out Action to Suspend and Idle Time-out Action (minutes) to 0

    2021-07-23_14-21-09.jpg

  9. Click on the OK button

  10. Select the Folder Template Creator application in IIS and navigate to its Advanced Settings

    2021-07-23_14-27-06.jpg

  11. Set Preload Enabled to True and click on the OK button

    image.png

ENABLING FOLDER TEMPLATE CREATOR FOR A HTTPS SITE​

By default, Folder Template Creator is set up to connect to a http site. To set up the application for HTTPS connection, please complete the following:

  1. Right click the application in IIS and select explore

    app.jpg

  2. Click on the Client App > Build

    image.png

  3. Right Click > Edit the Index.html file

    image.png

  4. Update the Content Security Policy from http to https

    image.png

  5. Save the file.

INSTALLING FOLDER TEMPLATE CREATOR READER ADDIN​

INSTALLATION​

Note

During the web application install the Folder Template Creator Reader will have been deployed to the following location: C:\Program Files\FYB Pty Ltd\FolderTemplateCreator\App_Data

Note

Please note the folder template reader contains its own license, which is separate to that of Folder Template Creator web application. Ensure you are using the Folder Template Reader license provided.

  1. Locate the config.xml at the path above and edit it. Update the license path to use the shared license path

    FTR License - Fix.png

  2. For users to run the Folder Template Creator Reader Add-In you will need to set up a hidden share to the folder it is stored in (by default this is the App_Data folder of the web application but this can be relocated if required)

    image.png

  3. Give Everyone Read permission

    image.png

  4. Take note of the shared path (FQDN path) as it will be required

    Note

    Folder Template Creator Reader comes with both a 32bit and 64bit version. Content Manager will only load the applicable version depending on the user’s machine.

CONFIGURATION​

  1. Navigate to Content Manager > Administration > External Links

    image.png

  2. Select New generic add-in (.NET) or right click > New generic add-in (.NET)

    image.png

  3. Enter in the following detail and click the OK button

    PROPERTYVALUE
    Link NameFolder Template Creator (32bit) or Folder Template Creator (64bit).
    .NET Class Namefoldertemplatereader Note: Class name must match exactly as shown.
    Folder or SubfolderThe FQDN shared path created in step 2 of the previous section
    .NET Assembly Namefoldertemplatereader-32bit.dll or foldertemplatereader-64bit.dll.
    Add-In supports a multi-threaded environmentYes.
    Ignore errors when client loads add-inYes. This is important to ensure users do not receive error messages if using both 32bit and 64bit environments.

The following example is for a 32bit version

image.png

  1. Go to the Used by Tab and select the folder record types that you wish to use the add-in with

    Note

    Only parent folder record types need to be ticked, sub folder record types do not

    image.png

  2. Click the OK button to complete the installation of the Record Add In

CM WEB CLIENT CONFIGURATION (OPTIONAL)​

If you wish to use Folder Template Creator with the Content Manager web client then two additional changes are required.

  • The account running the folder template creator application pool will require full control on the license folder network share (e.g., \SERVER-NAME\FYBADDINS$\LICENSE)
  • The account running the folder template creator application pool will require full control on the reader folder network share (e.g., \SERVER-NAME\FTC$)
Note

Any templates you wish to use with the Web Client cannot use the creation pop-up feature.

image.png

UNINSTALLATION​

WEB APPLICATION​

To uninstall the Folder Template Creator please follow the steps below:

  1. Navigate to control panel

    image.png

  2. Click on the uninstall a program option

    image.png

  3. Select FYB Folder Template Creator in the list of Programs and feature, and select Uninstall

    image.png

  4. If a warning Prompt appears, click on the continue button

    image.png

  5. The uninstallation process will commence

    image.png

  6. Open IIS once the uninstallation process is completed

  7. Locate Folder Template Creator in IIS, right click and click Remove.

    image.png

  8. When the prompt appears, click on the Yes button

    image.png

  9. Folder Template Creator is now uninstalled

READER ADD-IN​

To uninstall the Folder Template Creator Reader Add-In please follow the steps below:

  1. Navigate to Content Manager Context > Administration> External Links

    image.png

  2. Right Click on the Folder Template Creator (32 / 64 bit) and click on the Remove option

    image.png

  3. The Folder Template Creator Add In has been removed