Skip to main content

Release Notes

Match Studio

Release Notes

Release 2.5.0

June 2025

New

  • Match Studio Limited: We've introduced a limited version of Match Studio which allows you to try a Name Match for free. This version is available for download from babelstreet.com.

    • Supported languages are Chinese, Japanese, Korean, Arabic, Russian, and English.

    • Usage is restricted to 5 days.

    • Searches are limited to 500 per day.

    • Only 3 indices can be created, including the OFAC person list index, which is included with the product.

    • Name and date matching are supported; address matching is not supported.

    • You can view parameter configurations, stop words, and overrides. They cannot be edited in the limited edition.

    • File types supported for ingest are .tsv and .csv.

  • Guided tours: Match Studio now includes guided tours to walk you through different tasks, helping new users quickly understand how to use Match Studio.

    • Click on the light bulb menu in the lower left corner of the application to access the guided tours at any time.

    • There are tours for Search, Batch Search, Compare, and Configure tasks.

  • New Dashboard: You'll now see a landing page to guide you when entering the application.

  • OFAC list included: During installation, Match Studio now adds an index with the OFAC person name list.

  • Mapping is now easier: When importing data into Match Studio, the mapping step automatically guesses and suggests data types from Elasticsearch to be mapped to the fields in the data file. Importing data now requires fewer manual steps.

  • Improved Elasticsearch security: The local instance of Elasticsearch installed by Match Studio can now be set up with username and password along with a secured SSL connection. This is configurable in the full release. The limited edition release installs it by default.

  • UI improvements: We've improved the look and feel of the Create Index wizard, Indices, and search results pages.

  • Evaluate improvements: We've improved the Evaluate pages, adding more tooltips, improved design, and user-friendly error messages.

  • Java requirement improvement: The installer now downloads and uses the Adoptium JRE binaries to run Match Studio, eliminating the need for users to download and set up JRE.

  • Match release: This release supports Match version 7.49.0.c77.0 and includes Elasticsearch 8.17.3.

Bug Fixes

  • We fixed a bug where some parameter updates were not correctly reflected in scores when using parameter configurations. (RMS-1649, SUPPO-2208)

  • Escape sequences are no longer accepted during ingest as field names. This resolves multiple errors. (RMS-737)

  • Batch file will no longer be stuck in the In Progress state when setup is cancelled. (RMS-1413)

  • Fixed several stop word and override bugs by improving pagination. Most notably, new entries are now immediately reflected on the UI. (RMS-1424)

  • The Index Mapping column names are now consistent. (RMS-1594)

  • We fixed a bug where clicking Clear Search after pinning results caused an error. (RMS-1834)

  • Multi-valued fields are now searchable for every value. Previously, only the first value was searched. (RMS-1767)

  • You can now edit parameter values within newly added parameter profiles. Previously, if the entity type was not present in the default profile's language pairs, it would generate an error. (RMS-1723)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • The Docker build is not supported on machines with an ARM chip, such as the "Apple Silicon" (M1/M2/...) Macs.

Release 2.4.0

January 2025

New

  • Reduced footprint: Both ActiveMQ and the Ingest service were removed, allowing for a simpler deployment and configuration. (RMS-1482)

  • Docker Compose installation: The Docker Compose installation has been added back in and made available for use. (RMS-1484)

  • Helm Chart installation: A Match Studio Helm chart is now provided as part of the Docker assembly, allowing users to deploy Match Studio on a Kubernetes cluster. (RMS-1486, RMS-1488)

  • Expanded delimiter support: Additional delimiters have been made available during index creation. When uploading a delimited file, users can either choose one of the predefined delimiters (comma, tab, space, semicolon, pipe) or provide a custom delimiter. (RMS-1483)

  • Support Updated RNI-ES plugin name: Updates were added to support renaming the RNI plugin to the Babel Street Match for Elasticsearch plugin. Additionally, the rosette/rni-elasticsearch docker image was renamed to rosette/match-elasticsearch (RMS-1541)

  • Batch search mapping improvements: Field types are now displayed when mapping the columns of a batch search file to the fields on the index. (RMS-1473)

Bug Fixes

  • Parameter universes were not being properly refreshed when deleting the active Elasticsearch instance from Match Studio. (RMS-1524)

  • Failed parameter universe imports are now properly removed from /tmp/ingest. (RMS-1530)

  • Switching between the "Multi-Field" and "Extended" address inputs on the Compare page no longer clears the entered values. (RMS-1543)

  • Server credentials can be properly updated from the Server Details modal. (RMS-1545)

  • When creating an index, if the user configures a grouped field and then navigates back to the first page to change their uploaded file, the grouped field is no longer incorrectly shown in the "verify" step. (RMS-1552)

  • Index name uniqueness is now enforced per Elasticsearch instance rather than per Match Studio instance. (RMS-1554)

  • When configuring a grouped field on an index, the data type is now displayed with user-friendly text rather than internal codes. (RMS-1614)

  • When setting outOfOrderDeletionScore on the parameter test page, any setting below the minimum value will be set to the minimum value. (RMS-1615)

  • Sorting search results by the "Total Score" column is no longer reversed for ascending and descending. (RMS-1617)

  • Updated vulnerable third-party dependencies for improved security. (RMS-1588, RMS-1550, RMS-1556)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • The Docker build is not supported on machines with an ARM chip, such as the "Apple Silicon" (M1/M2/...) Macs.

Release 2.3.0

October 2024

New

  • RNI-OS support: You can now connect to an external OpenSearch server with RNI-OS 2.11.1.3. (RMS-1389, RMS-1376)

  • Parameter test: This new feature allows you to experiment with the most common parameters on the Compare page to optimize their parameter configuration. By adjusting a specific parameter, you can see how the match score is affected by that parameter’s value. (RMS-1260)

  • Search improvements: You can now pin specific search results to the top of the results list to keep track of them more easily. Pinned results can be compared side by side. Single search results, batch search overview results, and batch search details results can now be exported in both .csv and .xlsx formats. Additionally, you now can modify and rerun an existing batch search. (RMS-1388, RMS-1456, RMS-1464)

  • Alternative transliterations: The Compare page summary table now displays any alternative transliterations produced during a comparison. (RMS-1369)

Bug Fixes

  • Fixed a bug in which, in configuration locked mode, the displayed index names were inconsistently matching the final index names chosen during index creation. (RMS-1471)

  • Fixed a bug in which an index could be created without importing any fields from the data file. Now at least one field must be imported and used for matching. (RMS-1405)

  • Choosing a name general field now requires also choosing a name type field in batch search mapping. (RMS-1425)

  • Fixed a bug in which empty rows weren’t always being detected during index creation. (RMS-1457)

  • Various UI and updates were made throughout the application. (RMS-1359, RMS-1400, RMS-1445, RMS-1447)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • Docker installers are unavailable in this release.

Release 2.2.0

July 2024

New

  • Search Page Redesign: Our Search and Batch Search pages were redesigned to be easier to use and enable us to add additional capabilities in the near future. To keep the search page more focused, index creation was moved from "Search" to a new option in the "Configure" menu. (ROAD-541)

  • Branding Updates: Match Studio has been updated to better fit Babel Street's brand. This includes updating the name of the product, renaming installation files, and redesigning the application's main nav bar. (RMS-1346)

Bug Fixes

  • Nested fields in JSON/XML files were being flattened using periods, resulting in some strange behaviors with Elasticsearch. Fields are now joined together using "%" to avoid symbol conflicts. Additionally, index field names can no longer contain periods. (RMS-1352)

  • The left and right fields names on the Compare page were sometimes being reversed. (SUPPO-2105, RMS-1377, RMS-1390)

  • The list of available Match Configurations wasn't being refreshed when the current Elasticsearch instance was deleted. (RMS-1351)

  • Pressing "enter" on any Compare page text box submits the compare request. (RMS-1370)

  • Various UI tweaks and wording updates were made throughout the application. (RMS-1395, RMS-1360, RMS-1404)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • Docker installers are unavailable in this release.

Release 2.1.8

May 2024

New

  • RMS Lite: During installation, users are prompted whether to install in RMS Lite mode. This mode does not install Elasticsearch, and reduces the features exposed through RMS, allowing for improved security and performance. When running in RMS Lite mode, users cannot create or add data to Elasticsearch indices through RMS Lite, but are able to link existing Elasticsearch indices for search and analysis. Additionally, stop words and overrides are not accessible within RMS Lite as the dynamic configuration endpoints no longer need to be enabled in RNI-ES, which allows for improved RNI performance. (RMS-1215)

  • Index linking: When in RMS Lite mode, users can link pre-existing Elasticsearch indices, allowing them to be searched and analyzed through Match Studio. (RMS-1205)

  • Add server improvements: The menu for adding new Elasticsearch servers to RMS has been reworked, resolving several bugs and providing a friendlier user experience. (RMS-1253)

Bug Fixes

  • Fixed a bug in which, when importing JSON/XML indices, non-enabled fields could cause validations to fail. (RMS-1261)

  • Previously, when importing indices, fields named "id" were always assigned the "KEYWORD" data type. Now, data types for any fields named "id", "date", or "address" default to their appropriate types, while still allowing users to change the values. (RMS-1269)

  • Fixed a bug in which, when opening certain pages and tabs throughout the app, the screen would flicker and scroll to the top of the page. (RMS-1321)

  • Fixed a bug in which, when comparing two names that result in a score of "0," the final score was not being displayed. (RMS-1264)

  • Various UI tweaks and wording updates throughout the app (RMS-1286, RMS-1328)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • Docker installers are unavailable in this release.

  • When performing a batch search in RMS Lite on a "Name - General" field, the entity type will always be "person", which may cause unexpected results.

  • When deleting the active Elasticsearch server from RMS, a page refresh may be required to view the newly-selected server's match configurations.

Release 2.1.7

April 2024

New

  • RNI-ES 8.12.2.0 support: The local Elasticsearch server that RMS will be shipped with has been updated to RNI-ES 8.12.2.0. RMS can only be connected to a server running RNI-ES 8.12.2.0. (RMS-1239)

  • Compare page updated: The Compare page has been redesigned and reimplemented with more accessible details and improved explainability. This new presentation was designed to showcase the powerful matching capabilities of Rosette Name Indexer and provide users with detail on normalization, tokenization, match phenomena, and parameters utilized. (RMS-971)

  • Advanced match configurations added: The new advanced option for match configurations allows users to view all the parameters available in RNI and update them for evaluations and searches within RMS. The UI groups the parameters based on match phenomena and match type for ease of understanding and usage. (RMS-950)

  • Stop words updated: The stop words page has been redesigned and updated for better explainability and use.  It is now much easier to create new stop words and search for existing ones. (RMS-987)

  • Overrides updated: The overrides page has been updated and redesigned for better explainability and use. Related overrides are now grouped together, and improvements have been made to the creation and update process to make them quicker and easier to use.  (RMS-989)

  • Vault replaced with Spring Boot Security: Vault support has been removed and  replaced with Spring Boot Security for encryption and decryption of sensitive information stored in Match Studio. This includes updates to the installer. (RMS-1191)

  • Elasticsearch credentials can now be configured to use operating system environment variables in addition to supplied user names and passwords and API keys. (RMS-1196)

  • Users can now opt to connect to an Elasticsearch instance with "RED"-health nodes as long as RMS's system indices are in good health. (RMS-1188)

Bug Fixes

  • Exporting batch search results to a CSV file has been fixed. (RMS-1171)

  • When running a search against "Name - General" fields, "Compare" buttons in the search results now properly bring the user to the Compare page. (RMS-1231)

  • The ingest working directory is now automatically created when uploading a file, preventing errors caused as a result of system-configured cleanup scripts removing the directory. (RMS-1155)

  • Fixed a bug in which default match configurations for external Elasticsearch instances were editable. They are now displayed as read-only, as intended. (RMS-1232)

  • Removed the blank step that could show up during index creation when specific conditions were met. (RMS-1105)

Known Issues

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • Docker installers are unavailable in this release.

Release 2.1.6

November 2023

New

  • Added RNI-ES 8.9.2.0 support: The local Elasticsearch server that RMS will be shipped with has been updated to RNI-ES 8.9.2.0-RMS. RMS can now be connected to the following RNI-ES versions: 8.4.1.x, 8.5.3.x, 8.6.2.x, 8.8.1.x and 8.9.2.x. (RMS-1001)

  • Windows MSI installer: A new windows MSI installer has been added which lets users install RMS using a click through UI on windows. It’s a first version of the installer, we also have the existing installer of Windows so users can use either of the two.

  • Improved index creation: The index creation wizard has been updated for ease of use. (RMS-732)

  • Added multi-value field support: We have added support for multi-value fields. For .csv, .tsv and .txt files, the multi valued fields should be separated by a delimiter. For .json and .xml, RMS identifies the multi-value fields automatically. (RMS-923)

  • Added general field support: We have added support for data sets that contain names used for both PERSON and ORGANIZATION data types along with a field for mapping each record to its type.

  • Added grouped fields: We have added support for data sets where a single data element (such as a date of birth) is spread across multiple fields in the index input file (a month field, a day field, and a year field). This works for any matching data type.

  • Added OFAC SDN XML file support: We now support input of the OFAC SDN XML file directly without any modifications to the file.

  • Improved match configuration UI: We have updated the match configuration UI with a new design which is easier to understand at a glance and use.

  • Security updates: Updated dependencies in the frontend and backend to eliminate security vulnerabilities. We have also updated the Spring Boot and Elasticsearch Java API versions. (RMS-1017)

  • New installation guides: All platforms now have separate installation guides.

  • Removed Docker installer: We have temporarily removed the Docker installer for this release. It will be added back in a future release.

Bug Fixes

  • Fixed an issue in which incorrect parameters being sent to the server with a pairwise request. (SUPPO-2030, RMS-1015)

  • Added fuzzy matching logic to Elasticsearch fields along with a parameter called enableExactMatch in the Spring Boot application.yml file to turn off this behavior and fall back to exact matching. (RMS-966)

  • Fixed an issue with cleaning up the tmp folder for ingest jobs. (RMS-967, RMS-978)

  • Fixed a bug related to naming indexes. Users now get a clear message when creating a new index (RMS-551, RMS-727, RMS-782)

Known Issues

  • We recommend using a single entity type per evaluation file to perform accuracy evaluations.

  • We recommend using Vault to encrypt and decrypt the authentication data being used to connect to external Elasticsearch. Note that if using the basic dev mode of Vault, the external servers with authentication or APIs will need to be re-added when you restart Vault.

  • The new Windows installer does not support Vault or SSL currently.

  • There is a known issue with page navigation on the Batch Search, Overrides and Stopwords pages. (RMS-1034)

Release 2.1.5.1

July 2023

Bug Fixes

  • Updated the download link for Apache Artemis. The link had been updated by Apache, which broke the RMS installer. This release not has the correct link. We have also published the workaround for impacted previous versions of RMS. (RMS-940)

Known Issues

  • The Docker build is not supported on machines with the Apple M1, M2 chip. This is a well-known Docker issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • We recommend using Vault to encrypt and decrypt the authentication data being used to connect to external Elasticsearch. Note that if using the basic dev mode of Vault, the external servers with authentication or APIs will need to be re-added when you restart Vault.

  • The docker installation has two high vulnerabilities associated with the base image of docker being used. We will address this in a future release.

  • We recommend using the native version of Match Studio instead of the Docker version unless required.

Release 2.1.5

July 2023

Note

The download link for Apache Artemis was recently updated. As a result, during affected installations, the install script won't be able to download Apache Artemis and RMS won't start. This only impacts non-Docker installations. Impacted versions include: 2.1.4, 2.1.4.1, 2.1.4.2, 2.1.4.3, and 2.1.5. The upcoming version 2.1.5.1 will fix this issue, but for the older versions please use the appropriate workaround below.

MacOS and Linux:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>/installers folder.

  3. Run the install_rms.sh file as usual.

Windows:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>\installers folder.

  3. Run the install_rms.sh file as usual.

New

  • RNI-ES 8.8.1.0 support: The local Elasticsearch server that RMS will be shipped with is updated to RNI-ES 8.8.1.0. RMS can now be connected to the following RNI-ES versions: 8.4.1.x, 8.5.3.x, 8.6.2.x and 8.8.1.x. (RMS-852)

  • SSL support: During installation, users can now set up SSL between server and client for encrypted communication using their own certificates. (RMS-739)

  • Spring Boot server elimination: We have removed a redundant server. RMS now works with two spring boot servers instead of three. (RMS-307)

  • .tsv and delimited .txt support for ingest: Expanding on our support for files that can be used to add data to the system, we have added support for .tsv and delimited .txt files (tab or comma separated) for ingesting data into Match Studio. We have removed support for .yaml files. (RMS-733)

  • Security updates: Updated more dependencies in the frontend and the backend to eliminate security vulnerabilities. (RMS-831)

Bug Fixes

  • Files with BOM characters are now handled by RMS correctly. (RMS-891)

  • Fixed the issue with batch search exports. The batch search results can now be exported correctly with all the data correctly present. (RMS-843)

  • Incorrect Apache Artemis download link in documents has been corrected. (RMS-826)Incorrect Apache Artemis download link in documents has been corrected. (RMS-826)

  • Fixed a bug in which the Compare Dates page did not send the correct request when selecting a Match Configuration. (RMS-825)

  • Match configurations with invalid values cannot be imported now. (RMS-822)

  • Users cannot run RMS install file as Sudo users anymore. (RMS-157)

  • Pagination now works correctly for overrides. (RMS-779)

  • Errors when installing and running Apache Artemis on Windows Server have been fixed. (RMS-838)

  • Match configuration display errors have been addressed. (RMS-857, RMS-858, RMS-859)

  • A duplicate of the default parameter profiles file from RNI can now be exported into RMS without failing. (RMS-874)

  • Invalid evaluation files are now displayed correctly in the list of evaluations. (RMS-817)

  • When selecting a specific threshold to evaluate accuracy, the user cannot set the values as decimals. This will prevent users from getting unnecessary exceptions. (RMS-824)

Known Issues

  • The Docker build is not supported on machines with the Apple M1, M2 chip. This is a well-known Docker issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • We recommend using Vault to encrypt and decrypt the authentication data being used to connect to external Elasticsearch. Note that if using the basic dev mode of Vault, the external servers with authentication or APIs will need to be re-added when you restart Vault.

  • The docker installation has two high vulnerabilities associated with the base image of docker being used, we will address this in the next release.

  • We recommend using the native version of Match Studio instead of the Docker version unless required.

Release 2.1.4.3

April 2023

Note

The download link for Apache Artemis was recently updated. As a result, during affected installations, the install script won't be able to download Apache Artemis and RMS won't start. This only impacts non-Docker installations. Impacted versions include: 2.1.4, 2.1.4.1, 2.1.4.2, 2.1.4.3, and 2.1.5. The upcoming version 2.1.5.1 will fix this issue, but for the older versions please use the appropriate workaround below.

MacOS and Linux:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>/installers folder.

  3. Run the install_rms.sh file as usual.

Windows:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>\installers folder.

  3. Run the install_rms.sh file as usual.

New

  • The Help guide has been removed from this release due to a vulnerability in the Help files.

Release 2.1.4.2

April 2023

Note

The download link for Apache Artemis was recently updated. As a result, during affected installations, the install script won't be able to download Apache Artemis and RMS won't start. This only impacts non-Docker installations. Impacted versions include: 2.1.4, 2.1.4.1, 2.1.4.2, 2.1.4.3, and 2.1.5. The upcoming version 2.1.5.1 will fix this issue, but for the older versions please use the appropriate workaround below.

MacOS and Linux:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>/installers folder.

  3. Run the install_rms.sh file as usual.

Windows:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>\installers folder.

  3. Run the install_rms.sh file as usual.

Bug Fixes

  • Fixed a bug in which users were unable to add data to an existing index. (RMS-778)

  • Restored the ability to delete overrides. (RMS-723)

Known Issues

  • The Docker build is not supported on machines with the Apple M1, M2 chip. This is a known Docker issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • We recommend using Vault to encrypt and decrypt the authentication data being used to connect to external Elasticsearch.

  • There are 3 medium vulnerabilities caused by spring Boot 3.0.5 version. These will be resolved once the new Spring boot version is released.

  • The Docker install has 3 high vulnerabilities associated with the base image of Docker being used. We will address this in the next release.

Release 2.1.4

April 2023

Note

The download link for Apache Artemis was recently updated. As a result, during affected installations, the install script won't be able to download Apache Artemis and RMS won't start. This only impacts non-Docker installations. Impacted versions include: 2.1.4, 2.1.4.1, 2.1.4.2, 2.1.4.3, and 2.1.5. The upcoming version 2.1.5.1 will fix this issue, but for the older versions please use the appropriate workaround below.

MacOS and Linux:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>/installers folder.

  3. Run the install_rms.sh file as usual.

Windows:

  1. Download Apache Artemis here.

  2. Unzip the Match Studio installer and place the Apache Artemis install file in the match-studio-<version>\installers folder.

  3. Run the install_rms.sh file as usual.

New

  • RNI-ES 8.6.2.0 support: The local Elasticsearch server shipped with RMS has been updated to RNI-ES 8.6.2.0. RMS can now be connected to the following RNI-ES versions: 8.4.1.x, 8.5.3.x and 8.6.2.x.

  • Docker image update: Docker images have all been moved to the Rosette Docker Hub repository. Older versions of Docker RMS installs will be affected once the old basistechnologycorporation repository is shut down. If users delete their images and try downloading them again, they will need to update the docker-compose.yaml file. Reach out to the RMS team for more details.

  • API key support for external Elasticsearch: Users can now connect to an external instance of Elasticsearch using API keys generated with Elasticsearch.

  • Vault support: Rosette Match Studio lets users add their Elasticsearch credentials (Basic Auth and API keys). These credentials are stored in the RMS relational database. Users can now set up Vault during installation to encrypt these credentials so they are not stored in the database as clear text.

  • Elastic Cloud support: Users can now connect to Elastic Cloud using either Basic Auth or API keys.

  • Security improvements: Version upgrades to fix vulnerabilities.

  • Usability enhancements: UI improvements on Compare page and Match Configuration page.

Bug Fixes

  • Fixed a bug in which Evaluation ingest was failing on some files.

  • The Compare page for address matching has been updated and issues with some address fields have been fixed.

  • Fixed a bug in which Batch Search deletion caused a 500 Server error.

  • In some Batch Searches, expanding Batch Search results expanded more than 1 row. This has now been fixed.

  • Spring Boot 2.7.x has now been upgraded to 3.0.x, resolving multiple vulnerabilities.

  • Fixed a bug in which the Match Configuration would fail when switching between servers.

Known Issues

  • The Docker build is not supported on machines with the Apple M1, M2 chip. This is a known Docker issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per Evaluation file to perform accuracy evaluations.

  • We recommend using Vault to encrypt and decrypt the authentication data being used to connect to external Elasticsearch.

  • There are 3 medium vulnerabilities caused by spring Boot 3.0.5 version. These will be resolved once the new Spring boot version is released.

  • The Docker install has 3 high vulnerabilities associated with the base image of Docker being used. We will address this in the next release.

Release 2.1.2

December 2022

Windows Installation

  • Windows installation no longer depends on 7-Zip.  The only software prerequisite is Java 17 (RMS-684).

  • Permissions for the db_data directory are now set explicitly (RMS-682). 

  • Fixed a bug in which startup would fail if the Windows PATH variable contained parentheses (RMS-676).

Bug Fixes

  • Batch Search now properly reads the match threshold from the value set by the user during the batch job creation (RMS-553).

  • Search Details preserve the case of the retrieved name when linking to the Compare Page (RMS-678).

  • Search Details use the correct match configuration when linking to the Compare Page (RMS-691).

  • The user can now see new results immediately when selecting "Specific Threshold" in an evaluation (RMS-647).

  • Several UI fixes and improvements related to overrides and stopwords (RMS-616, RMS-660, RMS-688, RMS-689, RMS-693).

Known Issues

  • The Docker build is not supported on machines with the Apple M1 chip. This is a known Docker issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per evaluation file to perform accuracy evaluations.

Release 2.1.1

November 2022

Note

There is a known issue in which the RMS startup script on Windows will fail if there are parentheses in the PATH variable. Please contact support@rosette.com for a fix.

New

  • Overrides: This feature defines token pairs that are considered to be matches regardless of similarity. This can be used for nicknames. For example, if "Margaret" and “Peggy” are a pair on the override list, they will have a high match score even though the strings are not similar. RMS comes with some predefined overrides for various language pairs and entity types. Users can also add new overrides, delete existing overrides, or search for specific overrides.

  • Stopwords: This feature defines words that are ignored during string matching. A stopword can either be a prefix (like “Major”) or a regex (regular expression, like “\bfnu\b”). For example, if RMS is comparing “John Smith” and “Major John Smith,” and "major" is on the overrides list, then the word “major” will be ignored and the strings will have very high match score. RMS comes with some predefined stopwords for various languages and entity types. Users can also add new stopwords, delete existing stopwords, or search for specific stopwords.

  • Add data to existing index: You can now add additional data to an existing index via the the Add Data button (located on the Data tab of the Configure Index page). The source file for the new data must contain all the imported columns from the original index, with identical field headers. Additional columns will be ignored.

  • Configure field width type: You can now configure how RMS handles search results that are too wide to display in that field's column. (RMS-596)

    There are three options:

    • TRUNCATE: Shortens the text at the end so that it fits the field. Hover over the ellipses at the end of truncated results to see the full text.

    • WRAP: Displays long text strings on multiple lines.

    • EXPAND: Increases the width of the field so that it fits the longest displayed search result.

  • Windows 10 and 11 installation prerequisites: The prerequisites for installation of the Windows 10 and 11 version of RMS have changed to make installation easier.

    • Visual C++ and Cygwin are no longer required to run RMS on Windows.

    • The RMS installation process requires 7-zip to be added to the system path.

    See the complete new prerequisites in the Rosette Match Studio installation guide.

  • Exposed score_if_null parameter: The RNI-ES parameter score_if_null is exposed in the rest-module.yml (Docker) and rest-module-nodocker.yml (Windows/MacOS/Linux) configuration files. The default value is -1.0 (disabled). Set this parameter to a value between 0 and 1 to specify the score that should be returned when a field is missing (null). (RMS-658)

  • Updated Docker images: RMS Docker images have been updated to use the Redhat base image. Previous versions of RMS used Openjdk base images, which have been deprecated.

  • Improved installation: The installation process now prompts you for RMS hostname(s) and adds them to the allowed origins for configuring HTTPS. This reduces manual configuration steps. (RMS-622)

Bug Fixes

  • Improved handling of large files for index creation, batch search, and evaluation (RMS-638)

  • Help page can now be opened in a new tab. (RMS-573)

  • Fixed a bug in which the Compare button (in the Action column for search results) was causing a crash with certain configurations. (RMS-581)

  • Restored the spinner on Search page when waiting for results. (RMS-582)

  • The Compare page for organizations now correctly sets detected languages unless the match reason is REAL_WORLD_ID. (RMS-590)

  • Search terms can now contain double quotes. (RMS-617)

  • Evaluation files now accept upper or lower case language codes. (RMS-627)

  • System memory check during Windows installation now works for all locales. (RMS-659)

  • Ports 8081 and 8082, used internally by the application, can now be changed in startup.sh or startup.bat. This allows you to work around local port restrictions. (RMS-602)

  • Upon installation and startup, license check failure now produces a warning rather than an error. This ensures you will not get blocked during installation. (RMS-620)

Known Issues

  • The Docker build is not supported on machines with the Apple M1 chip. This is a known issue which will be addressed in a future release of Docker for Mac.

  • We recommend using a single entity type per evaluation file to perform accuracy evaluations.

Release 2.1.0

October 2022

New

  • Multiple index support: You can now create and manage more than one index in a single RMS installation. Search or batch search any uploaded index directly from the Search Indices page.

  • Delete index: You can now delete any index via the Search Indices page. Deleting an index also deletes all batch search data associated with it.

  • New Index Wizard: We have added a 4-step index wizard to make importing data easier. This includes progress indicators

  • Improved file ingest: RMS now has better exception handling and error messages for the index, batch search, and evaluation file ingest processes. We have also added row-level details for import errors, making it easier to spot and resolve problems with your data files.

  • Configure Index: You can manage each index via the Configure Index page. Configurable settings include index name, query fields, search results display, window size, match configuration, display threshold, and match threshold.

  • Window size and match configuration: These settings can now be changed directly from the search pane. This must be enabled via the Configure Index page.

  • Batch search: We have redesigned batch search for better performance and simplified the file mapping process to make starting a new batch search easier.

  • Batch search export results: Improved the batch search download file format and contents to reflect the index configuration and batch search settings.

  • Progress indicators: We have added more progress indicators to all processes including file ingest, batch search, and evaluation.

  • Import and export match configurations: You can now import any RNI parameter_profiles.yaml configuration file into RMS as a match configuration. You can also export any RMS match configuration for use in any compatible RNI environment.

  • Installation guide: We have added RMS-installation-guide.pdf to all RMS shipments. This document walks you through the process of installing RMS on a single machine.

  • New installer: We have added install_rms.sh to install all the services required to run RMS, check for common issues, and provide useful error messages, making installation easier.

  • Improved Windows installation experience: Windows installation is now easier. We have added more installation details to the README and updated the install script to catch more errors and exceptions.

  • Java support: Java 17 is now supported and required. Support for earlier versions of Java has been deprecated.

  • RNI-ES: RNI-ES has been updated to version 8.4.1.0.

Bug Fixes

  • Improved performance for evaluations.

  • Fixed inconsistent match scores when using compare.

  • Searches on "Gender" type columns are now working properly.

Known Issues

  • The Docker build is not supported on machines with the Apple M1 chip. This is a known issue that should be addressed in a future release of Docker for Mac.

Release 2.0.0-RC2

May 2022

New

  • Match configurations on Compare page: Added a match configuration selector to the Advanced Settings panel on the Compare page. Users can now select a match configuration when using pairwise match.

  • Compare page advanced settings: Improved the usability of the Advanced Settings panel in Compare page by limiting parameter mix/max values to the “sane” values prescribed in the RNI documentation.

  • Docker: Docker package (in addition to a dockerless version) is now available.

    Note

    The Docker build is not supported on machines with the Apple M1 chip. This is a known issue that should be addressed in a future release of Docker for Mac.

  • Invalid evaluation file: Added error message upon upload of an invalid evaluation data file.

  • Java support: Java 11 is now supported. Java 8 is no longer supported.

  • Node support: Node 16.0.0 is now supported.

  • Spring support: Spring 2.5.14 is now supported.

Bug Fixes

  • Previously, the Compare page displayed only a match score but no "Match Score Computation" matrix for organizations that were matched with REAL_WORLD_ID. The matrix has now been added.

  • Fixed a bug in which Advanced Settings parameters would show up as NaN when navigating to the Compare Page from a search result.

  • Improved performance when running accuracy evaluations on large files.

  • Fixed a bug in which the threshold report did not properly display the name of the match configuration.

  • Fixed a Windows encoding issue which prevented users from using any language other than the default language set up on Windows.

  • Miscellaneous additional bug fixes and usability improvements

Known Issues

  • The time taken to perform evaluations increases as more evaluations are run. This will be improved in a future version.

    • Workaround: delete all existing match configurations and restart RMS.

  • Searches on "Gender" type columns are not working properly.

  • In some cases, running the startup.bat file in the Windows build will result in Elasticsearch failing to start and the parameters_def.yaml file in the RNI-ES plugin being deleted.

  • It is currently possible to upload the same evaluation data file multiple times.

Release 2.0.0-RC1

March 2022

New

  • Match configurations: Parameters can now be updated for a language pair and an entity type and saved as a named Match configuration. This can be used to perform search, batch search, and accuracy evaluations. The first five RNI parameters we support are: initialScore, deletionScore, reorderPenalty, conflictScore and boostWeightAtRightEnd. These parameters can be applied to PER, LOC, and ORG entity types.

  • Select match configuration: We have added a new option to select a match configuration on the the Search Configuration page. The selected match configuration will be used for ad hoc search and batch search.

  • Evaluations: “Gold” data files containing pairs of names can now be uploaded for evaluation. During evaluation, the RNI pairwise score is calculated for each name pair in the data file and compared to the Match column in the evaluation data file (which confirms whether the names are supposed to match) to calculate Precision, Recall and F1. Evaluations can be performed on a single evaluation file with different match configurations.

  • Threshold report: After creating an evaluation, you can view a report of accuracy at each threshold between .5 and 1.0. The threshold and accuracy metrics with the best F1 score are automatically displayed. The underlying match results and summary statistics are available for download.

  • Search tab dropdown: You can now access some features by mousing over the Search tab and selecting them from a dropdown menu.

    • The Advanced tab has moved to Search > Search Configuration.

    • The Upload dataset tab has moved to Search > Import Search Data.

    • The Search tab is also available under Search > Ad Hoc Search.

    • The Batch Search tab has moved to Search > Batch Search.

Known Issues

  • No docker version. A docker version will be added in the future.

  • Evaluation input file only tested to 2000 rows. More rows will be tested in the future.

  • The time taken to perform evaluations increases as more evaluations are run. This will be improved in a future version.

  • Real World ID matches do not properly display the "Match Score Computation" matrix on the Compare page.

  • Once a match configuration is used for an evaluation, it cannot be deleted.

  • The threshold report does not properly display the name of the match configuration.

  • There is a Windows encoding issue which prevents users from using any language other than the default language set up on Windows.