Dictionaries

In Eccentex AppBase, dictionaries are typically used to represent objects or records in a database. Each key in the dictionary corresponds to a field or attribute of the object, and the value associated with that key represents the value of that field for a particular instance of the object. By using dictionaries to represent objects, we can easily manipulate and store data in a structured way within Eccentex AppBase.

In addition to the large range of standard fields that the DCM provides for Case, Task, and Party Types, there is also the ability to add new fields of many types. These ‘Custom Fields’ allow a DCM solution to be customized for the unique requirements of each business. For fields that behave as drop-down lists, the Dictionary feature lets you quickly define the various lists of values that a caseworker can use for drop-down field selection.

To add a custom field (or Word) to the DCM solution, a category for that field/word must be created first.

Add a Category

1. On the top right, navigate to 

   

    → <<your solution>>
2. On the left, navigate to 

   

    → Setup
3. Navigate to Lists → Dictionaries (1).
4. Click on the green plus button (

   

   ) to add a New Category(2)
   

   

5. Select the parent category from the Belongs to dropdown list. In our example, the root category, All Categories.
6. Insert the Name for the Category. In our example, ‘Employment Types’.

7. The Permanent Code field will be auto-populated using the Name field, subtracting dash (-) and any spaces or special characters; it also changes to uppercase.

   You can override Code Value (ensuring no spaces or special characters are used). The code Value cannot be changed after saving.

8. Select an Icon to represent the Category. In our example, ‘group users.'
9. Optionally, modify the Color.
10. Insert a brief Description.
    

    

11. Save it.

Add a Word

1. Select a category to add Words.
2. Select the parent category from the Belongs to dropdown list. In our example, the root category, Employment Types.
3. Insert the Name for the Word. In our example, Full Time.

4. The Permanent Code field will be auto-populated using the Name field, subtracting dash (-) and any spaces or special characters; it also changes to uppercase.

   You can override Code Value (ensuring no spaces or special characters are used). The code Value cannot be changed after saving.

5. Optionally, enter the Word Value for the entry. In our example, Full Time. This can be different from the Name.
6. Insert a brief Description.
   

   

7. Save the new Word or Save and New to create a new word without closing the popup window.
   

   

Migrating Dictionaries

1. On the source solution, select the Category (1) to be exported, then click the Download Excel Template button (2).
   

   

2. The MS Excel file will be downloaded to the local disc using a name pattern like DICTIONARY_CATEGORY.xlsx. In this example, the file name will be Dictionary_COUNTRY_LIST.xlsx.
   

   

3. On the destination solution, create the category to be imported, or select an existing one where the values will be added.

4. Click the Import Excel button (2), select the file, and after a couple of seconds, the category content will be updated, showing the newly added values. In our example, we selected the category Country_List.
   

   

   

   This action can not be undone. Be careful when selecting the right category before starting to import the values.

Limitations

1. Export works for the category that is selected in the source solution. So, you can only migrate one data category at a time from the source to the destination solution.
2. Import doesn't delete or update any records in a target solution.
3. Import doesn't create the category. You must manually add the category to the destination solution before running the import.

Related Articles

• Text Lists