Custom Reports Bundle Base

About:
The Custom Reports Bundle is a collection of custom html reports and dashboards for PowerSchool. The content in this bundle has been contributed by several members of the PowerSchool customization community.

What's New in Version 4.2.1
Version 4.2.1 fixes an issue with states where state reporting is using a tab called "State Reporting" that they own instead of the built in tab called "State" that they also fully controlled. The method of insertion was causing duplication of some items. 4.2.1 fixes that. This version also introduces the ability to localize report names and descriptions so you can change the name of reports without customizing them. This feature works but will not be rolled into the other reports today (8/25/2016) but will instead be rolled out over time. More on how to use this feature will be coming soon. A basic template for creating a new CRB report has been added to work with Blue Steel CPM (BSCPM). This template may be updated in the future but is meant as a starting point for now.

Directions

  1. Click on the System Reports link on the left side of the homepage
  2. A new tab for Custom Reports will show, click that.
  3. All reports that it has gone and "found" will show. if you've installed more click the "Refresh Reports" link at the bottom and it'll go find the new ones. After a period of time it will automatically go and find them anyways.
  4. If you delete a report (from CPM or custom/web_root) then click the "Refresh Reports" button again to have the system remove that report from the list.
  5. If you prefer the non-dynamic list click on the Static/Dynamic button at the bottom
  6. If you've already click on the static list and want to see the dynamic list then go to the PDS Setup page and change from static to dynamic.

What's Different in 4.0

  • Custom SQL Reports tab has been removed. We are working with Matt Freund who has taken over the SQL Reports project so that we will not overwrite each other. As such maintaining a built in version and a separate stand alone version seemed inefficient. Now if you have the CRB you can still install SQLReports without overwriting anything.
  • Each piece of the CRB is now its own plugin. For users who prefer the custom/web_root method of customizing there isn't anything different for you. But for schools who use Custom Page Management (CPM) you now can install the reports as plugins. This adds a huge benefit in that the plugin can be disabled at any time and completely removed. If you were to remove the old custom reports bundle you'd have to delete hundreds of files one at a time. Plugins adds the same ability to mass delete files that custom/web_root users have always had. If you don't like the reports in a particular tab simply delete the plugin and it's gone.
  • All reports are now in the /admin/reports/CRB folder. If you have the old reports bundle and are using CPM you might know that you'll have to delete all the files first in order to install the same files as a plugin. There were so many files that it was going to be a huge task for any CPM users. Matt Freund from www.sisresources.com had the great idea to put them all in a subfolder so that you didn't have to delete all those files in order to update. It's was a small task for us but hopefully will save you a lot of time.
  • CRB now looks more like PowerSchool. For the last few versions of PowerSchool users have struggled to fix the colors of the tabs. Other visual aspects made it clear to the user that they weren't in PowerSchool anymore. For many schools that's confusing so we've made it look just like PowerSchool. Tabs are now PowerSchool tabs, filters are now PowerSchool filters, popups are now PowerSchool popups. We hope this will help maintain a look that your users are used to and allow us to keep up with changes as Pearson updates the PowerSchool user interface.
  • Submit buttons are now pause. This might be strange to most of you but some of you have seen this already. The submit button allowed you to choose your filters and then submit them for processing. The pause checkbox does that as well, but with the checkbox "un-paused" you can make small changes and the report refreshes instantly. So if you are looking at a single student's information in one of the attendance reports you can switch students on the fly. If you have many changes to make in the filters simply check the box again and the report will hold off on processing until you are done. This is a change that was requested by a few schools for reports we built specifically for them. When testing with other schools they liked it so we through it into all of them.
  • Page fragments are now used instead of customizing a PowerSchool page. This means we can inject our changes into the page (like the reports tabs) without having to modify the file directly allowing you to see any changes that Pearson makes to PowerSchool without having to merge the old to the new. For an example think of the giant white space many of you saw on the home page after a powerschool update. Pearson made a change and now your custom home page looked strange. It was an easy fix but you had to search to find out why it happened. Now with page fragments you can customize that same home page without the worry that a Pearson update will cause your page to look strange. This is a very good thing and we are updating any customized PowerSchool page to a page fragment to make your lives easier.

Temporary Changes

  • Custom Dashboards has been temporarily removed. This will be added back when it can be updated to a more modern look and feel. At this point the only things published are the ones we've updated for the new look.
  • Incidents tab has been removed until those reports are updated
  • Logs tab has been removed until those reports are updated
  • Scheduling tab has been removed until those reports are updated
  • The export to csv, pdf, etc buttons have been removed temporarily. We hope to put them back in soon but to speed things up we left them off for this release.

Upgrade instructions
If you have the old custom reports bundle you will need to do a few things to get ready to update. 1st, and most important, is to delete the /admin/reports/reporttabs.html. If you've added your own custom tabs there then simply remove the ones from the bundle as we will inject them using page fragments now and no longer need to customize that page directly. Those tabs include Custom Reports, Custom Dashboards, Custom SQL Reports. Custom SQL Reports will now be handled by SQLReports plugin and not the reports bundle. Matt currently has the update ready for you to import.
If you created your own reports for the reports bundle to have you will need to move them to the /admin/reports/CRB folder. A custom grading report would be moved from the /admin/reports/grading folder to the /admin/reports/CRB/grading folder. This was done so that those with the old version didn't have to delete all those extra files.

Why are there two versions of the base?
PowerSchool 7.9 and 7.10 allow us to insert the tabs via page fragment. We came up with a way to insert it that wasn't efficient but worked. 7.11 gives us the efficient way to insert the tabs. If you are on 7.11 or higher use the regular base. However we've provided a version for 7.9 and 7.10 users as well so you can still update now even if you aren't ready to update to 7.11 just yet. Thank the Pearson team for adding in the necessary code in 7.11 to allow for this more efficient page fragment. We told them how we were doing it and why and they made the necessary change to allow for the easier method.

If I install the 7_10 version will I have to delete a ton of files after updating to 7.11?
No. That's the beauty of the plugins. Simply delete the old base plugin and then install the newer base plugin. You don't need to update any of your report files as they will work for both versions of the base. If you are using custom/web_root you will simply go to your wildcards folder and delete the admin_footer_css.crb.content.footer.txt file and add in the /admin/reports/reporttabs.crb.report.tabs.txt file from the new base. All other files are identical.

What comes in the base?
The base is just the setup files. It's the least common denominator that you would need to run any of the reports. It includes the page fragment for the tabs, the setup files for the dynamic tabs, and any images or stylesheets needed throughout the bundle. If you only install the base you will only have 1 tab, the setup tab. Other tabs can be added with other plugins.

Do I need the base?
YES! Without the base you won't see the new reports you're adding with the other plugins.

Should I delete the old files from a previous version?
You can if you want. Leaving them there does create confusion over which you should be looking at. But you can delete them at your own pace since the new bundle files are not located in the same place.

The old bundle had files I had to install by hand. What files do I need to install by hand now?
None so far. We aim to keep it as clean as possible without any files that don't install with the plugin. This wasn't a problem for custom/web_root users but it was for CPM users and we listened and are trying to make it as easy as possible for you.

I use CPM but have never installed a plugin. What do I need to do?
Pearson has made this really easy. Note these directions will only work if your account has permissions to run them.

  1. Click on System from the left menu
  2. Click on System Settings from the center menu
  3. Click on Plugin Management Configuration
  4. Click Install
  5. Click Choose File and navigate to where you downloaded the plugin
  6. Click Install
  7. Now your plugin is installed but not active. Click the empty checkbox next to the plugin you just installed.
  8. Click yes from the popup.

More instruction can be found here

What is the Sponsor all about?
Many times someone will pay to build a customization and then donate it back to the community. Several of the reports in the reports bundle were donated by schools who originally paid to have them built. It was their way of giving back. The update from the old bundle to the new took A LOT of time and is still taking a lot of time. Some of this time was done off hours but some was done on hours. As a result we are listing Computer Logic Group as a sponsor of the upgrade as they donated hours towards this update project.

Enough already, where are the other plugins?
Yes, this was a lot of information. Here are links to the other reports. Note that you can also search for them using keywords such as Attendance or Enrollment from the search box on the left

Change History
V 4.2.1 - Released 2016-08-25

  • Fixed issue introduced by PowerSchool state reporting that duplicates the tabs
  • Added functionality to localize report name/descriptions. Actual localization tags not added yet.
  • Added template for use with BSCPM

Change History
V 4.1.4 - Released 2015-07-27

  • Added files to use with export buttons
  • Moved common files from /scripts and /images to /pds/crb

V 4.0.1 - Released 2014-04-02

  • Removed 4 unused files from /admin/javascript folder. This should help people updating from the old CRB
  • Updated the customreports_static.html file to use the new css file rather than the old one
Sponsor: 
Computer Logic Group

Customization:

Contributor: 
Jason Treadwell
Brent Johnson
Brian Andle
Tim Scoff
Matt Freund
Roger Sprik
Michael Moore
Dean Dahlvang

PS Verions

7.x: 
Y
8.x: 
Y
9.x: 
Y
Plugin: 
Y
CPM Import Friendly: 
Y
Report Type: 
Web Based Report
Images: 
Custom Reports Bundle Setup tab

Comments

When I download the CRB 4.2.1 I get an error when trying to unzip it. Is there something wrong with it? Thank you for your help.

Yes, there was a issue with the site. We've taken steps to correct it and the downloads seem to work now.

Jason Treadwell
Custom Solutions Specialist
jason@powerdatasolutions.org
www.powerdatasolutions.org

I installed the new plug-in and the custom tab is not showing. Suggestions? Where is the link to the older version so I can reinstall it? (I am in Tennessee)

Update: ignorance on my part - got it fixed!

It won't let me delete /admin/reports/reporttabs.html. I deleted all my old files and deleted the old plugins and installed the new file but I get an error 404 message when I go to Custom reports. I have no refresh report option. Please help!

Thanks,

Kelly Schmidt

Yes I enabled the plugins. I was on version 4.0.

I am just verifying before I install the plugin for Custom Report Bundle 4.2.1 that it will work as expected with PS Versions 10.x. Also - all the 'reports' are version 4.1 etc. Will they all work with the 4.2.1 base?
Thank you,
Kim

Does the newest version of the Custom Reports Bundle work with PS10?
I could not get it to work on my server.

Yes, we are on 10.1 and the Custom Reports Bundle works fine.

Cheri Pettus
New Paltz CSD

Thanks Cheripettus!
i have the bundle installed on 10.1.1.0 and i don't see any reports. Any suggestions?

I installed the latest CRB Base plugin but I don't see a Refresh Button.

Any ideas?

10.0.4 - no Refresh Button. New install. Any update?

Jon P. Zurfluh
Director
American School of Warsaw

Appeared. Didn't note there was lag. I have updated list now.

Jon P. Zurfluh
Director
American School of Warsaw

I am also getting the duplicate tab and I only got it after I updated the base bundle. I have turned off the plugin and all the report plugins and still seeing Custom Reports Twice. I have no customization on the reporttab.html and other idea?

I am also seeing the duplicate Custom Reports Tab

I am also seeing the duplicate Custom Reports Tabs

my reporttabs.html is not customized and it will not allow me to delete it. I am hosted.

I recently upgraded to PS 11. I followed directions to re-install the custom reports package, but my Enterprise Reporting tab is missing. If i turn off customizations, it shows. PS support tells me the custom report bundle is causing this. any ideas? help! thanks

Any idea why I would have 2 sqlReports 4 tabs? If I turn off the plugin they both go away but as soon as I turn it on I have 2?

Pages

Subscribe to Comments for "Custom Reports Bundle Base"