Supervisor Installation Guide

To obtain the Supervisor installer, please contact sales@ayfie.com.

Please refer to the Supervisor Hardware Requirements described here before beginning a new installation or upgrade.  

Supervisor 2.3 and up

Note: In order to install Supervisor, Locator 2.11 SR9 and above must be installed on the same server first. The Active Directory authentication system need to be configured in Locator installation wizard.

Note: In Supervisor 2.3 the database is migrated from a standalone MongoDB database to the Locator database, so the uninstall recommended in previous version will not work going forward. Upgrades are fully supported.

Note: Locator search will be unavailable during Supervisor install/upgrade.

Note: Supervisor supports the Active Directory authentication system. Other authentication system like Azure AD and SAM can be manually configured.

Note: Supervisor supports the following browsers: 

  • Chrome, Firefox, Safari, Edge
  • Limitation: Internet Explorer is not supported

Note: In order to uninstall Supervisor, Supervisor needs to be uinstalled before Locator. This will be fixed in a later service release.

Note: As of mid-2020, some browsers have began introducing changes that make configuring SSL neccessary in order for users to be able to log into Supervisor 

Steps

  1. Double click the Supervisor executable.
  2. Accept the User Account Control prompt to start the Setup Wizard
  3. Accept the End User License terms and conditions by checking the box and click Next.
  4. Confirm the front end URL for the Supervisor application. This URL will be used in the emailed reports. 
  5. Click Next
  6. Confirm the Solr URL and the name of the schema file. 
  7. Check whether to install ayfie Lingo/Extractor or not
  8. If installing Lingo/Extractor, check whether to rebuild the ayfie Locator index after installing. This is needed to populate the new Lingo fields in the index.
  9. Click Verify Connection to test the connection to the index.
  10. If successful, the Next button will become active. Click Next.
  11. Set the password for the Supervisor Administrator. See Password Requirements.
  12. Click Verify Password to set the password.
  13. If successful, the Next button will become active. Click Next.
  14. Only if Locator with Microsoft SQL. Enter credentials for a service user in the same domain as the Locator server to establish a connection to Active Directory
    1. Important: The service user must have their password set to never expire!
  15. Only if Locator with Microsoft SQL. Click Verify Credentials to test the connection. (Note that verification is only supported for Active Directory.)
  16. If successful, the Install button will become active. Click Install.
  17. The installation process will now start. Click Close when complete.

Supervisor 1.0 to 2.2 SR1

In order to install Supervisor , ViaWorks 2.7-2.8 or Locator must be installed on the same server first. 


Note: Supervisor supports the following browsers: 

  • Chrome, Firefox, Safari, Edge
  • Limitation: Internet Explorer is not supported


We recommend to uninstall the old version of Supervisor before running the installer for the new version. The database is retained when uninstalling.

  • Although upgrades are supported, the updated Lingo extractors included in this version (2.0 or older) will not trigger a reindex. So if you want to use the upgrade features, a reindex needs to be started manually after the Supervisor upgrade is complete. 


  1. Double click to Supervisor executable.
  2. Accept the User Account Control prompt to start the Setup Wizard
  3. Accept the End User License terms and conditions by checking the box and click Next.
  4. Confirm the front end URL for the Supervisor application. This URL will be used in the emailed reports. 
    1. If you use HTTP Secure (https) two additional fields will be displayed:
      1. SSL certificate - select your certificate
      2. (Optional) Certificate password - enter your certificate password
  5. Click Next
  6. Confirm the Solr URL and the name of the schema file. 
  7. Check whether to install ayfie Lingo/Extractor or not
  8. If installing Lingo/Extractor, check whether to rebuild the ayfie Locator index after installing. This is needed to populate the new Lingo fields in the index.
  9. Click Verify Connection to test the connection to the index.
  10. If successful, the Next button will become active. Click Next.
  11. Enter credentials for an admin user in the same domain as the Locator server to establish a connection to Active Directory, or alternatively Azure Active Directory
    1. If installed without AD/AAD, and the domain name matched the machine name Security Account Manager can be used
    2. remember that user needs to have their password set to never expire!
  12. Click Verify Credentials to test the connection. (Note that verification is only supported for Active Directory.)
  13. If successful, the Install button will become active. Click Install.
  14. The installation process will now start. Click Close when complete.

ayfie