Skip to content
Mint Service Desk Documentation centre

Dictionaries Integrations

Import dictionary values, ordering and patterns from a CSV file into an existing dictionary.

Import simple dictionaries or dictionaries with patterns from a CSV file.

The process requires that a created dictionary exists in the system. To create a new dictionary, go to Field Settings -> Dictionaries.

The integration process starts by navigating to the Field Settings tab and then to the Dictionary Integration submenu. The main view presents a configuration table with the following columns:

  • Name - the name of the configuration
  • Definition Name - a short name for the type of configuration selected from the list during creation
  • Definition Type - a description of the selected type of configuration
  • Action - a column with and buttons

To create a new configuration, click the button in the upper right corner of the page.

This opens the Create Integration page, where we name our configuration in the Name field and select the type of configuration in the Definition field.

After completing and saving the data, we are redirected to the configuration settings.

We start with Section dictionary configuration.

The first step is to select a dictionary - in the Dictionary to update field, we select an existing dictionary in the system that we want to update.

After selecting the dictionary, we proceed to the following fields:

  • Dictionary key type: Here, we select the database column that will be the primary key for the imported data (the database column used to identify whether values already exist). The available options are: DictionaryValueId, Value, or Pattern.
  • Key column name: Here, we enter the name of the key column from the file. The data from this column will correspond to the database column selected in the Dictionary key type field.
  • Value column name: Here, we enter the name of the column from the file whose data will correspond to the Value column in the database.
  • Value position order column name: Here, we enter the name of the column from the file whose data will correspond to the PositionOrder column in the database.

If the dictionary does not have patterns, the message ‘The selected dictionary does not have patterns’ will appear in the ‘Section Dictionary Pattern Configuration’.

Example: importing dictionary values

In Mint Service Desk there is a HARDWARE dictionary without any entries.

Import computer, laptop and smartphone in that order. Use Value as the key because the values are unique.

First we need to create an appropriate CSV file. In the first row, we define the names:

  • Key column name: the name of the key column. The data in this column will refer to the database column selected in the Dictionary key type field.
  • Value column name: the name of a column whose data will refer to the ‘value’ column in the database.
  • Value Position Order Column Name: the name of the column whose data will refer to the ‘PositionOrder’ column in the database.

The names must be separated by a defined delimiter. In this example, we use a semicolon.

A sample first row of the file would be:

key;value;positionOrder

In the second and subsequent rows, we enter the data that will be placed in the columns defined in the first line.

For the HARDWARE dictionary, the file would look as follows:

  • Row 1: key;value;positionOrder
  • Row 2: computer;computer;1
  • Row 3: laptop;laptop;2
  • Row 4: smartphone;smartphone;3

The resulting CSV file is shown below.

Once the file is prepared, we proceed to the dictionary configuration section and select:

  • Dictionary key type - the column serving as the key for our dictionary (we select Value because we know these values will be unique and not duplicated).

Then we fill in the names according to the first row:

  • Key column name: key
  • Value column name: value
  • Value position order column name: positionOrder

In the File delimiter section, we set the CSV data separator (by default, this is a semicolon).

After completing the above steps, we click the Update button - the configuration data is updated.

The next step in the process is to import data from the file. Click the ‘Select file’ button, attach the relevant file and the synchronization will start automatically.

This action starts the process of retrieving dictionary values, which you can track in real time. Clicking on a selected synchronization takes you to the details, where you can also view the retrieval process and any potential errors.

After synchronization succeeds, the dictionary contains the values from the CSV file.

PATTERNS

If the dictionary contains patterns, the Section dictionary pattern configuration displays button.

Clicking the button adds a row with Pattern key and PatternValueColumnName fields. In the Pattern key field, we select the pattern name from the dictionary, and in the PatternValueColumnName field, we enter the name of the column from the file that contains the values to be imported into the pattern.

For example, we add a pattern named TEST PATTERN to our HARDWARE dictionary.

The CSV file must include this column so we need to update it. A sample first row of the file would be:

key;value;positionOrder;columnPattern1

In the second and subsequent rows, we enter data analogously to the previous example, with the addition of the columnPattern1 data. The file might look as follows:

  • Row 1: key;value;positionOrder;columnPattern1
  • Row 2: computer;computer;1;Pattern 1
  • Row 3: laptop;laptop;2;Pattern 2
  • Row 4: smartphone;smartphone;3;Pattern 3

The updated CSV file is shown below.

Configure the pattern mapping as shown below.

Now in the File delimiter section, we set the semicolon as data separator and click the Update button - the configuration data is updated.

The next step in the process is to import data from the file. Click the ‘Select file’ button, attach the relevant file and the synchronization will start automatically.

This action starts the process of retrieving dictionary values, which you can track in real time. Clicking on a selected synchronization takes you to the details, where you can also view the retrieval process and any potential errors.

After synchronization succeeds, the dictionary’s pattern fields contain the values from the CSV file.