Creating the mapping for adding custodians if the descriptor is set to a special person attribute

When you add existing custodians to a hold notice, an interview, a data box, or a data request, which is an action that you complete from the GUI, the default import mapping is used. This mapping provides attribute mappings for the signin ID, the email address, and the person ID. If the descriptor, which is the person attribute that is used to identify a person in person selection lists, is set to a different person attribute, you must create a custom mapping. Otherwise, the descriptor is not displayed in the GUI. The following target entities are affected: databox_custodians, datarequest_custodians, interview_custodians, and notice_custodians.

Before you begin

The descriptor is set to an attribute other than the signin ID, the email address, or the person ID. For more information, see Customizing attributes.

Procedure

Complete these steps:

  1. If a custom mapping does not exist yet, copy the default import mapping of each affected target entity and save the copy under a unique name.
  2. In the custom mapping, add the following attribute mapping to the mappings section:
    {
      "attributename": "descriptor-attribute-name",
      "columnname": "corresponding-csv-columnname",
      "mappingtype": "COLUMN_NAME"
    }

    Where corresponding-csv-columnname stands for the name of the corresponding column in the CSV file.

    Assume, for example, that the job title is used as descriptor. The internal name of that person attribute is jobtitle. Also, assume that the name of the CSV column that contains the job title of each custodian is Descriptor. Your specification would then look as follows:
    {
      "attributename": "jobtitle",
      "columnname": "Descriptor",
      "mappingtype": "COLUMN_NAME"
    }
  3. Set the status in the custom mapping to ACTIVE and then save your changes.
  4. Make the changes available for use.
    If you created a custom mapping, use the siq4l importmapping define command. See step 4. If you updated an existing custom mapping, use the siq4l importmapping update command.

What to do next

In the CSV file, add a column with the descriptor values.