Secondary Details Pop-up — what in the world is that?
Beginning in version 5.0, Aspen unveiled the ability to put a customizable pop-up on list screens. In Hanover, we have utilized it in several places. Principals and secretaries access a template-based pop-up on the Student list, as seen here:
How to set it up?
Follow a few simple steps:
- Make sure you have Secondary Detail as an enabled User Field Data Type
- Select or enable a User Defined field to act as the link to the pop-up
- Create the template containing the desired data that will be displayed in the pop-up
1. Enable Secondary Detail
Make sure “Secondary Detail” is an enabled user field data type.
To do this, go to the District view, Admin > Data Dictionary > Reference list, find the “User Field Data Types” reference table, and view the codes. Ultimately, what you want is an enabled user-defined data type of “Secondary Detail”. If it is there and enabled, move on to step 2. However, you might have to change the filter to view all records. If “Secondary Detail” is there and not enabled, simply enable it. If “Secondary Detail” is not there at all, add it by using Options > Add. See screenshot containing the completed record.
2. Enable a User Defined Field to act as the link for the pop-up window
In Hanover, we chose to enable an “information” field on the Student table with the short name of Info so that the column would not be wide and take up unnecessary space on the list. We also set the default value to “[+]” so that when new students are registered they will automatically have the value in the field.
Next, mass update the field to contain a value — in Hanover, we use a value of [+] which provides a simple way for users to click and view the pop-up window.
Once the mass update finishes, go back to the Data Dictionary and make the field read-only to prevent unwanted edits.
3. Create the template containing the desired data
The most important part of creating the template is the context. The context must be a continuation of the context of the parent list screen. The context of a list screen can be seen in the URL directly after the word “navkey”. Notice on the Student list, the context seen in the URL is “student.std.list” — therefore to access a Secondary Details template from the Student list, the pop-up template must have context “student.std.list.detail.popup”, as seen here:
Notice on the Gradebook scores gird, the context as seen in the URL is “gradebook.classes.list.input” — therefore, to access a Secondary Details template from the Student list, the pop-up template must have context “gradebook.classes.list.input.popup”, as seen here:
Finally, the pop-up template needs XML defined with the desired data. Here is the XML that we use in both templates: secondary-details-template.xml (right-click and choose “Save Link As…” or similar option depending upon your browser).