Melissa Seccariccia
posted this on August 10, 2011 16:48
While LIMS-plus strives to provide many fields to capture relevant data to a specific entity in the application, we can never anticipate the needs of all customers. Thus we have built in the flexibility for each organization to create additional fields as well as entire forms that are custom to the environment of the organization. A dynamic user interface, or DUI, is the implementation of this functionality. DUIs are created for specific entities in the application (like evidence, examination results, activities, etc). The reason they are called "Dynamic" is because they can be displayed depending on rules that are created in the DUI Designer. An example of a DUI that can be created for evidence items is detailed below. This is not a comprehensive document on how to create all types of DUIs, but rather an introduction into the DUI design process.
Access Dynamic User Interface Design by selecting User Interface, then Designer from the Admin Menu.
Depending on the entity for which you are interested in creating a DUI, select the appropriate Main Menu item from the first drop down list. This list will then filter the second drop down list to display the specific areas for which DUIs can be created. The following few steps show each of the selections in the drop down lists.
When Case is selected from the drop down, the specific areas that DUIs can be created correspond to:
When Activity is selected from the drop down, the specific DUIs that can be created correspond to:
When Examination Result is selected from the drop down, the specific DUIs that can be created correspond to the list of results entry forms for the root Examination Type. These Examination Types are specific to the Analytical Modules in which they will be used. The list that you see here will not correspond to the list in your organization, but is merely an example of what you might see. Examination Result DUIs are not specific to the Items related to an examination, but an overall result of an examination.
If we were to take the example of a Biology Screening Examination, your organization may choose to create an Analytical Module to use for all Biology Screening Requests. The results entry form that is named in the Analytical Module setup may also be Biology Screening (as you see in the list). The DUI associated with this Examination might include fields to record narrative results, conclusions of analysis, etc.
When Sample Result is selected from the drop down, the specific DUIs that can be created correspond to the list of results entry forms for Items related to Examination Types. These Examination Types are specific to the Analytical Modules in which they will be used. The list that you see here will not correspond to the list in your organization, but is merely an example of what you might see. Sample Result DUIs are specific to the Items related to an examination.
If we were to take the example of a Biology Screening Examination further, the results entry form that is named in the Analytical Module setup may be named Item Screening Result. On this DUI, we may choose to include fields for the entry of Preliminary Blood Screen Results (e.g. KM positive or negative or inconclusive); Preliminary Semen Screening Results (AP positive, negative, inconclusive, Spermatozoa identified, No Spermatozoa present, PSA positive, negative or inconclusive), etc. Because these results are specific to the samples being tested, this would be an example of a DUI for a Sample Result.
When Agency is selected from the drop down, the specific DUIs that can be created correspond to:
As an example, if some of your agencies are considered within your lab's jurisdiction, and therefore you have a different fee schedule for them as opposed to outside agencies, you may wish to create a DUI to capture the agency's "location" (e.g. within jurisdiction, outside of jurisdiction). This can then allow you to separate these agencies by their "location" to determine which fee schedule to apply when billing them.
When Staff is selected from the drop down, the only DUI will correspond to Staff. An example of additional staff data you may wish to capture is their proficiency test schedule (annually, bi-annually, etc.), their pay grade/rate, etc.
The functionality for Tests has not yet been fully implemented. This document will be updated to reflect the changes once it is complete.
Any entity chosen for which you wish to make a DUI will present you with the same screen once you select Start New Design (1). Alternatively, you may also choose to edit an existing template for that entity. Existing templates will appear once the specific entity is chosen. To edit an existing template, check the box next to the template and select the edit button. In this example, we are creating a Template for Case Evidence. There are two templates in process, and I've chosen to add a third one called "Shoes". You can see from the Design Grid that there are no fields created yet, but the grid consists of 4 Rows and 4 Columns (3). Rules for the display of the template will be added later (4).
Check the box next to "Shoes" and select the Edit button (1).
There are two tabs next to the Design Grid. Select the one that says "Toolbox" and use the pin in the top left corner to "pin" it open. The toolbox contains all of the field types that may be added to a DUI. To select a field type, simply drag it from the toolbox onto a section of the grid. Only one entity can be added one grid square. The entities are:
Each field type has a list of properties associated with it that will differ depending on the type. These can include the properties seen above (textbox). For the textbox, its properties include:
Rules can be added to display the DUI in the section pictured above. This is the "dynamic" portion of the DUI. For example, using the Shoes DUI we have been creating, we may only wish to display the fields when the evidence description contains the word "shoe". If the evidence is described as a knife, it doesn't make sense to ask the user to define shoe type, color, manufacturer, etc.
The DUI can have permissions associated with it, such that only specific user roles are able to access the fields, even if the rules conditions are met. Click the permissions icon (1) next to the Shoes template.
The User Roles will be displayed. Select the checkbox next to each of the user roles that you wish to access the DUI you have designed.