Skip to main content

Locations Manager 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 application.

Locations Manager License Update

If migrating from v2 of Locations Manager, please contact Accounts to receive your new Locations Manager license. The previous license will not work with v3 of Locations Manager.

INSTALLING THE NEW VERSION

A full uninstall of Locations Manager v2.x needs to be completed PRIOR to installing v3.x

INSTALLING FYB LOCATIONS MANAGER​

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​

Warning

Before running the MSI ensure that all prerequisites are complete. Including deploying the .NET 8 SDK and Hosting Bundle.

To deploy the Net Core SDK and Hosting Bundle to the server, follow these steps:

  1. Install the latest .NET 8 SDK (x64) found here

    NET SDK 8.png

  2. Install the latest ASP.NET Core 8 Runtime Hosting Bundle found here

    NET Hosting Bundle 8.png

  3. Once both executables have been installed, complete a full server restart to allow for .NET 6 to bind to IIS. If a server restart is not possible an IIS reset can be completed with the following CMDs from an elevated command prompt.

    • net stop was /y
    • net start w3svc
    • iisreset
    Note

    To check that the SDK has been attached to the hosting bundle, open Command Prompt, and type dotnet --info

    image.png

The FYB Locations Manager MSI will:

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

To install the Locations Manager, follow these steps:

  1. Run command prompt as an administrator and launch the locationsmanager-3.0.x.msi and click on the Next button

    image.png

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

  3. Click on the Next button

    image.png

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

  5. Click on the Next button

    image.png  

  6. Enter your Configuration Settings as per below

    image.png

    NAMEDESCRIPTION
    Dataset IDThe two-digit dataset identifier of the Content Manager dataset you wish to connect to.
    Workgroup serverName of the Content Manager workgroup server you wish to connect to.
    Workgroup URLURL of the Content Manager workgroup server you wish to connect to.
    License PathLocal path of the license file including the ".lic" filename.
    TempTemp data directory for the application.
  7. 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

  1. 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.
  2. 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.

c

  1. On the Custom Setup screen select the install location and Click the Next button

image.png

  1. From the Confirm Installation window click the Install button

    image.png

  2. The installation process will commence

    image.png

  3. Once the installation is complete click the Finish button

    image.png

COMMAND LINE ARGUMENTS (OPTIONAL)​

The follow 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
WORKGROUP_SERVER_URLSets the Workgroup Server URL 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
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
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.
CM_CLIENT_IDThe Content Manager Client Id used to establish a connection to Content Manager using Open Id
CLIENT_SECRETThe Content Manager Client secret value used to establish a connection to Content Manager using Open Id
TRUSTED_USERThe Content Manager Confidential Client location name used to establish a connection to Content Manager using Open Id
CLIENT_IDThe Locations Manager Open Id Client Id
AUTHORITY_URLThe Locations Manager Open Id Authority URL
REDIRECT_URLThe Locations Manager URL

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 Authentication

    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 the explore option

    image.png

  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 Locations Manager 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

    image.png

  9. Click on the OK button

  10. Select the Locations Manager application in IIS and navigate to its Advanced Settings

    image.png

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

    image.png

ENABLING LOCATIONS MANAGER FOR A HTTPS SITE​

By default, Locations Manager 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

    image.png

  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.

SETUP DATABASE CONNECTION STRING​

Locations Manager will require read-only access to the Content Manager database. This is due to some of the very large location searches it has to complete are much faster at the database layer.

The connection string for the database will need to be set via the Admin Console on the web interface. Navigate to Locations Manager in a browser and press the Admin button in the top right.

Navigate to the Maintenance tab and input the database connection string into the Connection String field.

2021-07-29_12-10-03.jpg

The account used for the connection will require read access to the TSLOCATION and TSLOCEADDR tables. If you have specified Integrated Security=true in the connection string then the account running the Locations Manager app pool will be used for the connection. Alternatively, you can specify the credentials in the connection string.

UNINSTALLATION​

To uninstall the Locations Manager manually please follow the steps below:

  1. Navigate to the Control Panel

    image.png

  2. Click on uninstall a program

    image.png

  3. Right click FYB Locations Manager in the list of programs and features and select Uninstall

    image.png

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

    image.png

  5. Click the Yes button

    image.png

  6. The uninstallation process will commence.

  7. Open IIS once the uninstallation process is completed.

  8. Locate Locations Manager in IIS

  9. Right click and click the Remove button

    image.png

  10. When the prompt appears, click the Yes button

    image.png