Compatible with IV 6.2+
The following outlines the required standard format of the custodian file and custodian configuration, required for custodian-participant matching in IV’s Recording Import Worker.
A custodian file can be optionally configured for a recorder. This file contains custodian details, which are used to match individual custodians and call participants, where each participant is sourced from the call recording's metadata file. Allowed formats for the custodian file are xml, json or csv. If a custodian file is not configured with a recorder, then all recordings will be imported, with no custodian-participant matching taking place.
If the recorder cannot match any of the call participants to any of the custodians in the custodian file, and import_unmatched_recordings is set to False in the recorder config, the recording will not be imported and a job will be added to the recording-failed queue. If import_unmatched_recordings is set to True, then all recordings will be imported, regardless of a successful custodian-participant matching.
A custodian file must contain a number of mandatory fields, these are detailed below. It can also contain any number of custom fields. Any field, custom or mandatory, can be used to match custodians with participants.
Custodian variable | Description |
|---|---|
name | Full name of the custodian. |
email_address_list | A list of email addresses associated with the custodian. |
languages | A collection of language ids, listed in order of preference of the employee. (e.g., 'en' for English, 'fr' for French, 'it' for Italian) |
By default, within the container, the custodian files are located at /usr/app/custodians , which is mapped to {DATA_DIRECTORY}/recording_import_worker/custodians on the host machine. It’s here that all custodian files must be placed.
To configure a custodian file, the following must be added to the config.yaml file:
Config Variable | Description | Required | Default |
|---|---|---|---|
id | Unique identifier for the custodian | yes | - |
file | Path to the custodian file (xml, json or csv) | yes | - |
For example:
custodians:
- id: custodians-1
file: /usr/app/custodians/custodians-1.csv
- id: custodians-2
file: /usr/app/custodians/custodians-2.xml
|
Custodian file CSV Example
name,email_address_list,languages,cloud9_username,redbox_user_id John Doe,"john.doe@example.com; john.doe2@other.com","en; fr",johndoe,72 Jane Smith,"jane.smith@example.com","fr; it; en",janesmith,73 |
Custodian file JSON Example
[
{
"name": "John Doe",
"email_address_list": ["john.doe@example.com", "john.doe2@domain.com"],
"languages": [{ "id": "en" }, { "id": "fr" }],
"cloud9_username": "johndoe",
"redbox_user_id": 72
},
{
"name": "Jane Smith",
"email_address_list": ["jane.smith@example.com"],
"languages": [{ "id": "fr" }, { "id": "it" }, { "id": "en" }],
"cloud9_username": "janesmith",
"redbox_user_id": 73
}
]
|
Custodian file XML Example
<?xml version="1.0" encoding="utf-8"?>
<custodians>
<custodian>
<name>John Doe</name>
<email_address_list>
<email_address>john.doe@example.com</email_address>
<email_address>john.doe2@domain.com</email_address>
</email_address_list>
<languages>
<language>
<language_id>en</language_id>
</language>
<language>
<language_id>fr</language_id>
</language>
</languages>
<cloud9_username>johndoe</cloud9_username>
<redbox_user_id>72</redbox_user_id>
</custodian>
<custodian>
<name>Jane Smith</name>
<email_address_list>
<email_address>jane.smith@example.com</email_address>
</email_address_list>
<languages>
<language>
<language_id>fr</language_id>
</language>
<language>
<language_id>it</language_id>
</language>
<language>
<language_id>en</language_id>
</language>
</languages>
<cloud9_username>janesmith</cloud9_username>
<redbox_user_id>73</redbox_user_id>
</custodian>
</custodians>
|