Secondary Details Pop-up @ HPS

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:
student list secondary details pop-up

Even more important is the ability for our teachers to access a template-based pop-up from the Gradebook score grid, as seen here:
2014-06-11_1635

How to set it up?

Follow a few simple steps:

  1. Make sure you have Secondary Detail as an enabled User Field Data Type
  2. Select or enable a User Defined field to act as the link to the pop-up
  3. 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.
secondary-details-data-type

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.
2014-06-13_0948

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.

mass-update

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:
template1Notice 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:
2014-06-11_1633Finally, 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).

Please note, to get the “Info” field in the Gradebook, you might want to alter the default Field Set. Here is a screenshot to remind you how to do that:
score info

9 thoughts on “Secondary Details Pop-up @ HPS

  1. Katie Farrell

    Matt:

    I have implemented almost all of what you have demonstrated. But I have one question. When I tried to put my secondary detail field “Info” on the grade book score grid and I looked at the template I saw it was mostly JSP. I do not know how to get the “Info” field on the Grade book score grid.

    Thanks a lot!!!
    Katie

    1. Brian Ciccolo

      To get the “Info” field as a column on the score grid, click the “…” button next to the Student Fields dropdown. That will open the standard “Manage Field Sets” popup.

  2. gvargasdc

    Two questions:

    – Is the Popup always ReadOnly=true, or can it be opened with ReadOnly=false so the fields in the popup can be updated?
    – Is it possible to have more than one popup per context? That is two “Info” Fields? One launch a popup with a template and the other launching another template with different fields from Student List?

    1. Matthew Plummer Post author

      Question 1:
      Is the Popup always ReadOnly=true, or can it be opened with ReadOnly=false so the fields in the popup can be updated?

      Answer 1:
      It is always read only. Notice there is no “save” button. It would require Follett to enhance the feature to allow editing and saving from a secondary details pop-up.

      Question 2:
      Is it possible to have more than one popup per context? That is two “Info” Fields? One launch a popup with a template and the other launching another template with different fields from Student List?

      Answer 2:
      No. You can only have one secondary details pop-up for each context.

Leave a Reply