Setting up KAMAR Directory Services (KDS) with EdPotential
If your school uses KAMAR, you can enable a connection that allows data to flow directly into EdPotential. This article explains how.
Instructions from KAMAR can be found here: https://www.kamar.nz/setup/server/directory-services
Note that the initial full sync may cause an increased load on your KAMAR server. It's advisable to complete the first sync outside of peak school hours.
- Start by accessing your KAMAR account, and then navigating to the following area:
- Setup > Server > Directory Services
- Click the New Service button.
- Confirm creation by clicking Create.
- Enter the details as follows:
- Name: EdPotential.
- Address: goedpotential.com/kamar/v3.
- Port: Leave as 443.
- Timeout: Leave as 30.
- Username: As given to you.
- Password: As given to you.
- Change the radio box from XML to JSON
- Next, click the Check and Enable button. This will check the connection to EdPotential, and (provided there are no errors) enable it.
- The dialogue box will have a blue border if successful, or a red border if it fails.
- You should see a message similar to the screenshot saying Status: Ready. If you receive a different error please contact us with details of the error.
- Now KAMAR is connected to EdPotential, we need to schedule when the data is sent, which is set in the next section.
- Tick Event Updates. This will enable new entries in KAMAR to be synced immediately in EdPotential.
- Select a time for the Daily Update. We recommend you set a time between 1:00 a.m. and 5:00 a.m. to avoid conflicts with KAMAR and maintenance scripts.
- Select the days of the week the Daily Update is to occur. We recommend selecting Monday to Friday.
- We next need to configure the data to be sent, which is set in the section below.
- Students:
i. Tick Details. Click the pencil icon to edit the student details which are to be shared. We recommend that you tick everything, as this will give you the option to view any identifiers on EdPotential (e.g. Tutor Groups, Houses, or Special Needs students)ii. For Subjects, tick All.iii. If you would like student attendance data to show in reports tick Attendance, and in the prompt that opens:- Tick Include Attendance.
- Tick Send whole year in next sync.
- Click OK.
iv. Tick Assessments, and in the prompt that opens:
- Tick Include Assessment Results.
- Click Send All.
- Click OK.
- Students:
Once completed successfully, the date in the dialogue box should change to 1 Jan 2000. If the date does not change, please complete step 7. again.
- Staff
i. Tick Details.
ii. For Subjects, tick All. - Tick Subject Details.
- Schools will typically have just one option, dependent on your KAMAR setup. If your KAMAR account includes data for multiple schools or campuses, please only select the one(s) for which you have responsibility.
- Once you're ready, click Run Now and click Update in the prompt.
- In the background, KAMAR will send a full update to EdPotential. Changes will be sent regularly after they happen in KAMAR.
If you experience any issues during this process, please don't hesitate to get in touch.