Supervisor 2.3

Owned by Tony Luzar (Deactivated)
Nov 03, 2020
4 min read

Build Number

2.3.451.0

Release Date

October 18th 2019

New Installations

Please contact sales@ayfie.com for the Supervisor installer. Run the installer on the Locator server. For help installing Supervisor, please see the Supervisor Installation Guide.

Note that a local Supervisor admin user will be created when installing Supervisor for the first time. 

Note: To benefit from the new Lingo extractions and GDPR fields, Locator content requires a full re-index which must be performed after upgrading from Supervisor 2.2

License Compatibility

Please contact sales@ayfie.com for Supervisor installer and license information.

Supervisor requires an installation of the Locator platform with connectors to the source systems you want to report on.

Supervisor 2.3 requires the new Authority Service which is included in Locator 2.11 SR1. The Active Directory authentication system need to be configured upon install/upgrade to Locator 2.11 SR1.

Limitations

  • Internet Explorer is not supported
  • Although upgrades are supported the updated Lingo extractors included in Supervisor 2.3 will not trigger a reindex. If you upgrade and want to populate data in the new Lingo fields, a reindex must be manually initiated. 

Hardware Requirements

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

Major Updates

Stand-alone MongoDB database migration to Locator database

Supervisor 2.3 will now use the same database as the Locator platform. Both PostgreSQL and Microsoft SQL are supported. Existing data will be migrated from the current MongoDB database during the upgrade. Note that there will be an increase in database size on the Locator database.


Authentication System now only Active Directory

Supervisor now supports only Active Directory as an authentication system. Azure AD or SAM can be configured manually.


Authentication now uses the ayfie Authority Service

The ayfie Authority Service is using the OpenId Connect workflow. 


User Service removed

With the Authority Service addition, the User Service is deprecated and has been removed in 2.3.


Supervisor Admin user introduced

With the Authority Service, Supervisor no longer gives local administrators on the Locator server administration permissions in Supervisor. A new Supervisor administrator user is introduced as the initial user, to provider other users with permissions. Note that some actions, like opening and downloading documents, are not supported for the Supervisor admin.


New procedure for adding users

Since Supervisor now shares authentication with Locator, all Locator users have the possibility to log in to Supervisor. When doing so the first time they will not have any permissions and will be met with a prompt to contact an administrator to provide them access. In this initial login process a user record will be added to the ayfie Authority Service after which the administrator can log into the User Settings menu in Supervisor and add the appropriate Permissions for the user (Create/View/Export report etc.). 

Steps

  1. User attempts first log in
    1. A record of the user will be created in the ayfie Authority Service but with no permissions
  2. User is prompted to contact an administrator for access to use Supervisor
  3. The administrator can now log in and assign permissions

Note: For existing users, no change is required as these will be migrated automatically, including their permissions.


New permission level

A new permission level 'Notification' is introduced. Users will need to permission to configure notifications.


User Management search feature

It is no longer to possible to search for users in AD or Azure AD. Users must be added using the process described above. 


Customizations

Custom overrides not supported by installer will need to be manually ported to new override files for Supervisor 2.3. See /wiki/spaces/PLATFORM/pages/904135209.


New PII fields

New Lingo package with 150+ new PII fields. See /wiki/spaces/PLATFORM/pages/433750192. Note that due to the large number of new PII fields, the time required to identify and extract the data from a given document has increased approximately 2.5x. This will increase the amount of time needed for Locator indexing.


Service name

The Supervisor services display name are renamed to ayfie Notification Service, ayfie Resource Service, ayfie Report Engine Service and ayfie Scheduler Service.

New Features

  • Add Report Name to subject in report notification
  • Increase report size limit (extend from 16MB to around 600MB)

Bugs Fixed

  • Fixed an issue where the Dashboard Manager back button returned to the incorrect screen
  • Fixed an issue where some exports created corrupt Excel spreadsheets
  • Fixed an issue where Danish CPR numbers were not recognized 
  • Fixed an issue when Supervisor Installer failed when ViaWorksVersion was set to 2.10 in RestService.config
  • Fixed an issue which required a reboot in order to see the Supervisor Main Page shortcut
  • Fixed an issue where Supervisor Windows Metro icons were not visible until a reboot of the server
  • Fixed an issue with scheduled reports not running and email notifications not being sent after upgrade 

Improvements

  • Migrate Supervisor + dependent services to Locator database both PostgreSQL and Microsoft SQL
  • All services migrated from .NET Framework to .NET Core
  • Introduce new Authority Service (common component with Locator)
  • Convert Supervisor admin user to local authority user
  • Add user prompt to inform users they need to have administrator set rights
  • Add new Lingo fields and a file 'schema_overrides_for_lingo.xml' containing the default Lingo Solr fields. 
  • Update CultureConfigSection and PiiConfigSection in appsettings.json
  • Supervisor search will now only match strings from the start of the string (e.g. 'en' will no longer return a match for 'generic')


ayfie