Cluster Report

When you want to view how applicants compare to their peers, you are able to use a cluster report that is viewed within the Slate Reader. Many times, the comparison is done among applicants who are attending the same school, often containing GPA, class rank, and test score information. There is a cluster report that can be added from the Slate Template Library that you can use to get started.

Add the STL Cluster Report
  1. Click Database in the top navigation bar and select Slate Template Library.
  2. Type cluster report in the search box to quickly find the Cluster Report object under Queries.
  3. Click the Add link.
  4. Click the Add button in the popup window. 
  5. Click Queries / Reports in the top navigation bar
  6. Select the Cluster Report query under the Shared / Library folder
  7. Open the Cluster Report.
  8. Click the Edit Query button.
  9. Click the Save Copy button.
  10. Update the name and folder, then click Copy.
    • The folder name must be set to Reader-Reports to be used within the Reader.
    • It is best practice to provide a clear, concise name.
    • Keep the Share query with other users with the query and query base permissions checkbox checked.

  Why copy the query first?

Each query can only be added from the Slate Template Library one time. It is best practice to keep the query in its original form in the Shared / Library folder for two reasons:

  • You are able to view the query as it was when you originally added it from the Slate Template Library for reference.
  • You are able to make additional versions of the cluster report by continuing to copy the standard version.
Customizing the Cluster Report Query

You are able to customize the query to include any data points that you want displayed. You are also able to adjust the title, orientation, and set the widths for each data point.

Important!

Do not remove the Students at Current Applicant's School #1 filter. This filter is what will allow the Reader to display the results for just the applicants who attended the same school as the current applicant.

  1. Remove unwanted data points from the query.
  2. Add additional data points that you would like to include, such as test scores. A number of test score exports are available in the Slate Template Library, including calculated superscores.
  3. Double click on each export to customize the settings.
    • The Name of the export will appear as the column header in the cluster report.
    • The same configuration options that you are able to use in normal queries are available in cluster reports, including the ability to configure export values and translation codes.
    • Drag the exports to reorder them.
    • Add additional filters to further restrict the population, if desired. For example, you may wish to only show other current applicants using the 'Application Period Active' filter.
    • Add, remove, update, or re-order the Sort Keys. With the Sort Keys below, the order will first be determined by the Round (in ascending order), then the Application Status (in ascending order), followed by the applicant's Name (in ascending order). Each Sort Key after the first is used only in the case of a tie. This means that two applications in the 2017 EA Round will then be ordered based on their Application Status (if the statuses are different), and in the case of a tie, the Name will be used to determine the order.
Testing the Query

The Students at Current Applicant's School #1 filter relies on a parameter value in order to filter results. Values for parameters can be passed to the query at the time it runs. Since the parameter value will determine the results of the query, the Estimated Rows functionality is not available.

The cluster report uses the Person GUID (a 36-character unique ID) that the Reader automatically passes to it as the @person parameter.  The @person parameter is defined in the Edit Web Service popup, and it should not be changed.

  • In order to test the query, you must provide it with a parameter value to use. On the landing page for the cluster report, you are able to enter the parameter value before clicking the Run Query button.
  • You are able to find the Person GUID for any record by navigating to the Dashboard tab of that record. The last portion of the URL in the address bar is the Person GUID. For example: https://slate-demo.technolutions.net/manage/lookup-duo/record?id=6bb2c3fd-218f-452b-a435-838babc7b01d
  • Copy the Person GUID of the record with which you would like to test the query, paste it into the @person parameter box, and then click Run Query.

On the Query Results page, confirm that the values you want displayed on the cluster report are appearing in the desired format and order. Make any adjustments to the query until you are seeing the results as you want them to appear. 

Edit the Report Options

All queries in the Reader-Reports folder have an additional action button Edit Report Options.

The Report Options that can be adjusted include: 

Option Description
Title Specify the title that displays on the top of the cluster report
Orientation Landscape or Portrait
Column Widths

Configure the widths of each column (measured in inches) in a comma-delimited list. This setting is optional. If left blank, the width of the page will be evenly divided among each data point. You may wish to configure column widths if you have some data points that do not need the full column width provided while others could use the extra space. If you configure the widths, there must be one width entered for each data point that you wish to display. The first export in your query will use the first column width entered, and it follows in order for all other exports.

Example:

  • Column Widths - 0.2,0.9,.5,.5,.25,.85,.56,.63,.35,.25
  • Margin - 0.2
Margin Configure the margin (in inches). The single value entered as the margin will be used for both the top and left margins.

Since you will have to make some adjustments once you see the report within the Reader, it is recommended that you leave the Column Widths blank for now. Once you see how the data appears by default, you will be able to make more educated adjustments to the Column Widths.

Was this article helpful?
0 out of 1 found this helpful