Configure

Select the Configure tab from the navigation bar to view the Configure page.

Individual name tokens are scored by a number of algorithms. These algorithms can be optimized by modifying configuration parameters, thus changing the final match score. RMS provides an easy way to compare and test different parameter settings based on your data.

A match configuration contains a set of parameters. Each named match configuration contains parameter values for a specific language pair and entity type. A single named match configuration can contain multiple language pairs and entity types.

The Configure page contains a list of existing match configuration files. You can:

Edit an existing match configuration. You cannot edit a match configuration if an evaluation has already been created using the configuration. For the default match configuration, which cannot be edited, this option is replaced with View.
Copy an existing match configuration, then edit it, making the changes you'd like to test. This is how you modify an existing match configuration that has been used in an evaluation.
Export the match configuration as a .yaml file. This file can be used with RNI-Elasticsearch or re-imported into RMS.

Important

The exported .yaml file contains a comment with the RNI-Elasticsearch plugin version number. Only use this configuration file with the indicated version of RNI-Elasticsearch.
Delete a match configuration. This option is disabled for the default configuration.
Create a New Match Configuration.
Import Configuration from valid .yaml file.

Parameters

While RNI contains over 100 parameters, RMS exposes a few of the most commonly modified parameters that are the most likely to have an impact on your data.

RMS Field Name	Description	Behavior	RNI Parameter Name
Initials Score	The score that is assigned to an initial matching a token	Increasing leads to higher final score when there is a match between an initial and a token.	`initialsScore`
Token Deletion Score	Score applied to an unmatched token when surrounding tokens are matched	Increasing leads to higher final score when there is an unmatched token.	`deletionScore`
Token Reorder Penalty	Penalty applied to matching tokens with different positions	Increasing leads to lower final score when the tokens aren't in the same position.	`reorderPenalty`
Token Conflict Score	The score that is assigned to unmatched conflict tokens	Increasing leads to higher final score	`conflictScore`
Right End Boost	A boost applied to the final score applied to the weights of tokens at the right end of the name.	Increasing leads to a higher score for matches between the surnames in English and other languages where the end of the name is more meaningful. It makes the last token more important.	`boostWeightAtRightEnd`

New Match Configuration

Select the entity type from the top of the window (Person, Organization, or Location).
Select a language pair from the drop-down.
For each parameter you can adjust the score, either by moving the slider or editing the value in the box.
Continue for other language pairs or entity types, as desired.
Save or Save As

Each configuration must have a name. If you are creating a new configuration, only Save As will be available. Once you've saved it, you can modify and save the configuration under the same name.

Import Configuration

You can create a new match configuration by importing a valid import file. A match configuration created in this way will have all parameters defined in the file, including parameters not exposed in the RMS UI.

Note

You must have a valid import file. A valid import file is in .yaml format and follows the structure of a RNI-ES parameter configuration file. You can create a valid import file by exporting the default configuration and editing it by adding or modifying parameters.

Select Configure from the global navigation bar in RMS.
Select Import Configuration.
Name the match configuration.

Note

If the name of an existing configuration is provided and the configuration is editable, its values will be overwritten by the import. If the name of an existing configuration is provided and the configuration is not editable, the import will fail. Otherwise, a new match configuration will be created with values from the imported file.

A match configuration is not editable if an evaluation has already been created using the configuration.
Select OK. The new match configuration appears in the match configuration list.

Export Match Configuration For RNI-Elasticsearch

Important

The exported .yaml file contains a comment with the RNI-Elasticsearch plugin version number. Only use this configuration file with the indicated version of RNI-Elasticsearch.

Select Configure from the global navigation bar in RMS.
Select Export in the Options column for the desired match configuration.
Rename the downloaded file parameter_profiles.yaml.
Navigate to RNI-ES in your file browser.
Replace the existing parameter_profiles.yaml in plugins/rni/bt_root/rlpnc/data/etc with the version exported in step 2.

For more information on RNI-Elasticsearch parameter configuration files, see Optimizing Name Matching with Parameters.

Articles in this section

Important

Parameters

New Match Configuration

Import Configuration

Note

Note

Export Match Configuration For RNI-Elasticsearch

Important

Comments

Articles in this section

Important

Parameters

New Match Configuration

Import Configuration

Note

Note

Export Match Configuration For RNI-Elasticsearch

Important

Related articles