Definition:
The dictionary in OpenRIMS can be accessed by;
- Log in as an administrator into the system
- Go to the configurations
- Select the dictionary option from the drop-down
A dictionary is a data structure that stores pre-defined data items in a way that allows efficient retrieval of the data.
Dictionaries on OpenRIMS are utilized to;
- Define new workflow items
- Define the placeholders for uploads and downloads
- Define the checklist items
- Define the administrative unit’s reference
- Define the system parameters
An example of a dictionary is the dictionary.guest.applications This is a system dictionary that allows the configuration of the new application workflow.
How to create a new dictionary?
The dictionary can only be created by the superuser with access to the admin panel in OpenRIMS.
Keep in mind that access to the system admin should be restricted to a few. It would be best if other users of the system are not provided with admin privileges.
TO create a new dictionary in the system;
- Log in as an administrator into the system
- Go to the configurations
- Select the dictionary option from the drop-down
- Click on add button, this will open a new option on the right side of the screen.
As marked in the picture;
- URL: This URL is the dictionary URL
- Name: The name for the dictionary URL to retrieve and search for the dictionary in the system.
- Additional information: to add extra information to explain the purpose of the dictionary library
Note: Adding levels within a single level of the dictionary is possible. Some system dictionaries are not modifiable.
Special consideration for naming a new dictionary:
The naming convention for the dictionaries mandates that the URL should start with a dictionary. The URL should start with the word “dictionary”
dictionary.xxxx.xxxxxxx
Let’s fill in the URL, Name and additional information to define a new dictionary in the dictionary library.
| Particulars | Value in definition |
|---|---|
| URL | dictionary.test |
| Name | test |
| Additional information | Test dictionary |
Click on save to save the newly created dictionary.
Once saved the created dictionary will be available for modification if required in future.
Finding an existing dictionary from the dictionary library
To find an existing library, It is important to know which dictionary are we trying to search for.
As like the creation of the dictionary, we start by logging in to the admin panel.
Once logged into the admin panel, we can start with the same approach by
- Log in as an administrator into the system
- Go to the configurations
- Select the dictionary option from the drop-down
From here, type in the dictionary name in the search box. Once the search is complete the dictionary being searched will be shown.
Modifying the dictionary
Find an existing dictionary from the dictionary library.
Click on the name of the dictionary.
The edit option will be enabled.
The URL of the dictionary or the additional message can be changed. Changing the URL will cause a malfunction in the system where the previous URL was used.
Depending on the type of the dictionary it may or may not be available for editing. For example, system dictionaries are not available for editing or modification.
Deleting a dictionary
Deleting a dictionary in OpenRIMS is not possible currently.
The section will be updated once the functionality has been introduced.
How to create multi-level dictionaries.
Multilevel dictionaries are those that have multiple levels within the dictionary. For example, the address may start with the province and then be followed by other lower administrative divisions.
Multilevel dictionaries can also be used to define categorical values by sorting them into a category.
First of all, create a dictionary or find a dictionary that you would like to create levels for.
Get into the dictionary by clicking on the checklist icon.
Then you will see new options as shown in the picture.
Adding first level
Adding second level
Adding items in the dictionary
Once you have created a new dictionary.
Click on add button
A new form will open which will allow you to.
- Name: Put the name of the item
- Additional information: to add extra information to explain the purpose of the dictionary library
- URL: To link the dictionary item to a website or a link
- Click on save to save the element.
How to export a dictionary?
Find an existing dictionary from the dictionary library.
Click on the name of the dictionary.
The options will be enabled as shown,
- Click on the Export button.
- This will download the dictionary in Excel file format.
How to Import a dictionary?
Find an existing dictionary from the dictionary library.
Click on the name of the dictionary.
The options will be enabled as shown,
-
Click on import
-
A file upload field will appear
-
Click on the browse button
-
Choose your dictionary file in XLS
-
Upload the file
-
Your dictionary will be updated