Integrating EdPotential with Schoolbox

If you're using Schoolbox, you're able to add a button to your Schoolbox integration. This allows you to link directly into EdPotential, and to the specific student you are viewing in Schoolbox.

Schoolbox is a popular LMS and school portal, and EdPotential can integrate with a mixture of staff, parent and student aspects.

What you'll need:

1. A Schoolbox admin account, running on a Schoolbox instance v18.2 or above.
2. An existing EdPotential account.
3. Your EdPotential school ID. This can be found by opening any page on EdPotential and looking at the number after the first slash in the URL.

Let's get started!

1. Log in to your Schoolbox portal.
2. Navigate to the Administration area by clicking your profile picture at the top-right of the page.
3. Select Profile Buttons.
4. Click to Add a custom button.
   
5. In the Button Text field, enter the label for your button (e.g. EdPotential).
6. Enter a Hover Description, which is the text that will show when a user hovers over the button (e.g. Open VIA Character class reports on EdPotential).
7. (Optional) Enter a CSS Class. This depends on if you use a custom skin config.
8. Choose an Icon (e.g. Graduation Cap).
9. Your options should now look something like the below: 
10. You will now need to enter a Destination URL. There are two options:
    1. https://goedpotential.com/r/93/student/id/[profileExternalId]/full/view - This is our standard student report.
    2. https://goedpotential.com/r/93/student/id/[profileExternalId]/nceaassessments/view - This is a table of results specifically designed for NCEA results.
    3. Other URLs as advised should be entered here.
11. Choose a Destination Target. New Window is recommended as it means the Schoolbox portal remains open in the background.
12. Your destination options should now look something like the below:
13. Change the Button Availability options to control which profiles this button will show on. 
    1. The recommended setup is to enable it for all campuses and and for any student role types you have created in the system (e.g. this might be Junior, Middle and Senior).
14. Change the Button Visibility options to control who gets to see the button. 
    1. The recommended setting is to enable it for all campuses, and the staff role types you have created in the system (e.g. this might be Administration and Teacher). 

Note: If you wish to enable parents or students to view reports on EdPotential, you will need to contact us to allow access. By default, we do not let parents or students access information on EdPotential.

15. Click the Create profile button to finish creating the button
16. Open any student profile and verify that the newly created button is there and is operational. Clicking the EdPotential link should open a new window, and link directly to the student report (or what was entered in step 10).

This process is described by Schoolbox support in the release video for v18.2, from 7min 10sec. 

If you have further questions or would like support setting this integration up, please contact us.