4.1.0

Release Date: 15/Feb/22

Highlights

4.1.0 is a new major release of the new Saga platform. Supervisor is now part of the Saga platform.

A new Report Engine (Supervisor) service.
A new Authority Service based on Keycloak.
A new Notification and Scheduler service.
A new Licensing service.
Connector Auto-Upgrade feature.
New UI workflow for timelines and tags.
Changed logging framework to Serilog.

See below for exhaustive list.

If upgrading from previous major version, please consult the Install Guide for upgrade steps.

Features

Key	Components	Summary	Change Log
SAGA-2337	ConnectorBroker	Connector Auto-Upgrade	Connectors Connector image will be automatically upgraded to the latest official version within the major version after restarting connector container.
SAGA-2887	DataDog	Upgrade Datadog to version 7.32.3	Datadog Upgraded Datadog to version 7.32.3. Notes This fixes critical security issue CVE-2021-44228.
SAGA-2868	Documentation	Add Supervisor documentation to README.md	README Added documentation about the new Report Engine services.
SAGA-3081	Documentation	Add upgrade to 4.x instructions to README.md	README Added information about migration for major version Updated Installation section
SAGA-2201	Keycloak	Introduce new Modern Authentication Services	Authority Introducing new authority services based on Keycloak.
SAGA-2491	Keycloak	Document Modern Authentication	README Added documentation about the new Authority Service.
SAGA-2875	Keycloak	Add Linux support for Keycloak image	Authority Service Adds Linux image of Authority Service Notes Linux Authority Service image is built using jboss Keycloak image (https://hub.docker.com/r/jboss/keycloak/) . It’s based on Keycloak 14.0.0 version.
SAGA-1180	Licensing	Containerize Licensing Service	Licensing Licensing service has been containerized. WCF communication replaced with REST API. Multiplatform support. Swapped log4net to Serilog for logging.
SAGA-2837	Lingo	Add license capability for all Lingo extractors	Lingo Introduced 2 new license capabilities: Lingo Standard and Lingo GDPR. All Lingo languages can now be configured if you have a valid capability in the license. Notes The 3.x license will continue to work when upgrading to 4.x, but a new license is required to configure any language outside English and Norwegian or to configure GDPR/PII for Lingo. Lingo Standard allows you to configure any language based extractor. Lingo GDPR allows you to configure any GPDR/PII based extractor.
SAGA-508	Locator	Remove legacy Authority Service	Authority Service Removed the legacy Authority Service from Locator. Notes The new Authority Service is based on Keycloak. Any Supervisor permissions set in 2.x need to be re-assigned in the new Authority Service.
SAGA-2621	Locator	Consolidate logging across all services	Logging Using Serilog for all logs. Standardizing log files. Removed DocFilter_monitoring.log.
SAGA-2773	Locator, Saga Installer	Remove support for installing legacy connectors inside Locator	Connectors Removed support for installing legacy connectors inside Locator. Only containerized connectors are supported.
SAGA-2927	Locator	Add Linux support for Postgres image	PostgreSQL Adds Linux image of PostgreSQL database server Notes Linux PostgreSQL image is built using official image maintained by PostgreSQL docker cummunity (https://hub.docker.com/_/postgres ). It’s based on PostgreSQL 12.8 apline image.
SAGA-2019	Locator UI	Add "Start new search" button	Result view Button for cleaning filters has been added.
SAGA-2224	Locator UI	Improve workflow for persisting timeline and tags	Tags: Every added/removed tag is automatically saved right away. Removed “Save” button from tags dialog. Added “Add” button next to tag name input. New tag can be now confirmed with enter key. Timelines: Every added/removed tag is automatically saved right away. Removed “Save” button from tags dialog. Added “Add” button next to tag name input. New timeline can be now confirmed with enter key. Results view: Added refresh button for reloading changes in results.
SAGA-203	Notification	Containerize Notification Service	Notification The Notification service is now added to the Saga platform.
SAGA-2180	Report Engine, Resource	Remove Resource Service	Resource Service The resource service has been removed. The resources are now stored in the Report Engine UI.
SAGA-2654	Report Engine	Containerize Report Engine Service (Supervisor)	Report Engine The Report Engine is now added to the Saga platform.
SAGA-2636	Saga Installer	Verify gMSA during startup	Installer Runs gMSA validation during startup of Saga. SSO validation is now added to gMSA validation. Notes Single sign-on isn’t mandatory if Saga isn’t configured to run with it so only warning is risen during startup.
SAGA-652	Scheduler	Containerize Scheduler Service	Scheduler The Scheduler service is now added to the Saga platform.
SAGA-2782	SmartRefiner	Create Smart Refiner service	Smart Refiner Introducing Smart Refiner service with limited functionality. Adding support for calling Smart Refiner service from Rules Engine using custom formatter. Notes The Smart Refiner service is an early version with limited functionality. It’s not started by default. The Smart Refiner formatter is not loaded by default. To load the Smart Refiner formatter add environment variable `AYFIE_LOCATOR_RULE_SMART_REFINER_FORMATTER=true`. A custom formatter with name `SmartRefinerFormatter` will then be available in the Rules Engine.

Bugs

Key	Components	Summary	Change Log
SAGA-2735	Converter	Files in Converter temp folder are not deleted after conversion	Converter Corrected retry mechanism responsible for removing converter working directory. Corrected asynchronous workflow of Converter service.
SAGA-3089	Converter	Converter client timeout is shorter than Converter API timeout	Converter: Converter timeout is now configurable using Saga environment variables instead of converter configuration file. Converter service client now has the same timeout as the service.
SAGA-2067	Locator, Saga Installer	Saga reports successful start when Locator didn't start	Health The Locator health endpoint, supports/status, now validates that the RestService has a valid connection to the database and the index.
SAGA-2484	Locator	IndexBuilder stuck in loop	IndexBuilder SQL Server queries now take DateTime2 type values as query parameters instead of DateTime.
SAGA-2228	Locator UI	Refiner values added to search bar on refresh	Url Split search phrase, selected refiners and selected timelines into 3 different url parameters: q, refiners and timelines (it all used to be stored in q param). Fixed url params encoding so it handles national and special characters in search phrase and refiner values. Notes This change will break old urls that users saved before it (saved for example in favorite pages).
SAGA-2287	Locator UI	UI does not provide feedback when secondary source credentials are successfully stored	Result view: Removed information about success or failure save user credential. Information was moved to head popup information
SAGA-2318	Saga Installer	Installer fails when default PSRepository is missing	Installer The installer now registers PsGallery PSRepository, if not already registered.
SAGA-2320	Saga Installer	Installer fails when NuGet package provider is missing	Installer The installer now installs NuGet package repository, if not already installed.
SAGA-2740	Saga Installer	Plugin Watcher fails to start from start-saga.ps1	Installer Added check for elevated permissions in the start and stop plugins script.
SAGA-2742	Saga Installer	Env file in plugins folder can get corrupted	Installer Made starting and stopping plugins more robust.
SAGA-2893	Saga Installer	Download of docker-compose failed on server that relies on documented firewall openings	README Changing github-releases.githubusercontent.com to *.githubusercontent.com in Firewall Openings section in README.md.