TECHNICAL GUIDE

2

CONTENTS

INTRODUCTION ................................................................................................................................. 3

SET UP OVERVIEW ............................................................................................................................ 4

MIS INTEGRATION ............................................................................................................................. 5MIS Link ............................................................................................................................................................................... 5SIMS Writeback Add-on ............................................................................................................................................. 8SIMS Assessment ........................................................................................................................................................ 11

IMPORTING DATA ........................................................................................................................... 13With the MIS Link ....................................................................................................................................................... 13Without the MIS Link ................................................................................................................................................ 13

LOGINS ................................................................................................................................................. 14Security ............................................................................................................................................................................. 14Basic Login Options ................................................................................................................................................... 14LDAP Logins ................................................................................................................................................................... 16Google Single Sign On .............................................................................................................................................. 18Parental Logins ............................................................................................................................................................. 19

APIs ........................................................................................................................................................ 19Using APIs ....................................................................................................................................................................... 19API Example - Frog 3 ................................................................................................................................................. 21

APPENDIX – Permissions Matrix ................................................................................................ 24

3

INTRODUCTION Thankyouforchoosingepraiseasyourschoolrewardssystem.Wehopeithasapositiveimpactonthebehaviourandfocusofyourstudentsandmakesmanagingyourrewardseasy.

Thisguidewillhelpyougetyoursystemset-upandexplainaboutaccessandourMISKit.Wehavetwootherguides,theAdministratorsGuidewhichwillexplainhowtocustomiseyoursiteandtheStaffGuidewhichwillshowyouhowtouseepraiseonadailybasis.

BeforeinstallingtheMISKit,pleaseensureyouhavereadandagreedtotheserviceagreement.ThiswillhavebeenattachedtoyoursubscriptionemailandcanalsobefoundunderDownloads>Guidesandtutorialsontheepraisesite.

Pleasenotethatasepraiseisconstantlybeingupdatedandimproved,theremaybeoccasionswherethisguidedoesnotreflectexactlywhatyousee.

4

SET UP OVERVIEW

Start

Finish

UsingMIS

UsingLDAP?

InstallGroupCallXporterandwaitforit

torunalljobs

RuntheMISsynchronisationin

epraise

DownloadCSVfilesfrom‘importdata’forStudentsandStaff

Fillinusername,passwordandaccess

levels

Importthefiles

ImportyourdatausingCSVfiles,

includingusernamesandpasswords

YesNo

YesNo

Yes

No

UsingLDAP?

ImportyourdatausingCSVfiles.Usernames,passwordsandaccess

levelsoptional*

FillinLDAPsettingsandtestthisworks.

AdjustSitesettingstorequirements

Configurerelatedsettings,e.g.Milestones

AdditemstoShop,DrawsandDonationsas

necessary

FillinLDAPsettingsandtestthisworks.

5

MIS INTEGRATION

MIS Link

Introduction

TheMISlinkisdesignedtoreducetheadministrationofaddingstudents,teachers,classesandmore.

GroupCall(www.groupcall.com)haveproducedthesoftwarethatsitsonyourMISserver.Thesoftwarewillsenddatatoepraise,whichinturnwillupdatetherelevantdatainthesystem.

Limits

ThedataisreceivedfromyourMISsystemeachnightbetween12amand3am;theepraisedataisupdatedbetween3amand5am-readyfortheschoolday.ThiseffectivelymeansthatnewdataaddedtoyourMISwillnotbeavailableinepraiseuntilthefollowingday.

Thethirdlimitisthatnousernamesandpasswordsaretransferred(asMISsystemsrarelycontainthesedetails)soyouwillstillhavetoaddthesemanuallytoepraiseorusetheLDAP/GoogleSingleSignOnfunctionality.

Thefinallimitisontheamountofdatathatcanbetransferred.Thereiscurrentlynolimitonthenumberofstudents,teachersandclasses,butachievementshavealimitof100,000(asthesetakealongtimetosynchronise).

Installing the MIS link

InstallingtheMISlinkisverysimpleandcanbedownloadedfromtheGroupCallwebsite.

ForSIMS,CMIS,ISAMS,Bromcom(seebelowforadditionalinstructions)orIntegris(seebelowforadditionalinstructions)use:

http://www.groupcall.co.uk/clients/ePraise/ePraise_GroupcallXporter4_Setup.exe

ForProgresso,use:

http://www.groupcall.co.uk/clients/ePraise/ePraise_Progresso_GroupcallXporter4_Setup.exe

Theinstructionsshouldbestraightforward,butyouwillneedtoensurethatyouhaveauseraccountreadytousewiththeappropriatepermissions.Forexample,ifyouareusingSIMSyouwillneedanaccountwiththePersonnelOfficer,AssessmentCo-ordinator,SchoolAdministrator,SeniorManagementTeamandThirdPartyReportingpermissions.

AdditionalnotesforIntegris:

Youwillneedtofollowthebelowinstructions:

1. You’llneedtocreateaG2accountforXporter(thesoftwarethatsendsusallthedata).Theattachment‘CreatingaG2WebservicesAccount.pdf’fromGroupCallexplainsthisprocess.

2. You’llneedtocompletetheonlineactivationsrequestformhere:http://www.rm.com/contactus/Questionnaire.asp?cref=Q3747481&ReducedHeader=1(selectGroupCallXporteronthisform).

6

3. Finally,you’llneedtoinstallXporter,usingtheabovelink.

Oncethishasbeensetupsuccessfullyyoushouldbeabletoseethatyourdatahasarrivedbyvisiting:http://data.epraise.co.uk/

AdditionalnotesforBromcom:

1. You’llneedtocreateanaccountine-Setup>Security>SystemsUsers,makingsuretoenabletheThirdPartyoption.

2. RuntheXporterinstaller,makesureyouchooseBromcomontheMISselectionscreen.3. ClickNexttocontinue.4. EnteryourBromcomserviceURL.Youmayneedtochangethedomainfrom

cloud.bromcom.comifyouhostBromcomlocallyinyourschool.5. EnteryourBromcomSchoolIDandentertheusernameandpasswordcreatedforthirdparty

access.ClickLogin.6. Theinstallerwillnowverifytheconnectionanddisplayyourschool’snameingreen.Click

Nexttosavethedetails.Ifyouraccountdoesnotproducethegreenconfirmation,verifytheURL,usernameandpasswordandretry.Ifitstillwillnotconfirmtheconnection,clickNextandclickYesontheprompttoskipsettingupcredentials.Theinstallerwillsavewhatyouhaveenteredsofarsoyoucancontactusforassistance.

7. EnterthecorrectdetailsforyourschoolonthenextpageandclickNexttofinishtheinstallation.

Oncethishasbeensetupsuccessfullyyoushouldbeabletoseethatyourdatahasarrivedbyvisiting:http://data.epraise.co.uk/

TheMISlinkwillneedaccesstothefollowingURLs:

http://www.groupcall.co.ukhttps://dashboard.groupcall.co.ukhttps://data.epraise.co.ukhttps://mis2.epraise.co.ukhttps://www.epraise.co.uk

ThemostcommonreasonfortheMISlinknotworkingisaproxyservernotallowingtheconnectionthrough.AcommonsolutionistoensuretheGroupCallXporterserviceisrunningasadomainuserwithaccesstotheaboveURLs.

Starting the synchronisation

IfyouareplanningtouseepraiseforasetnumberofyeargroupsthenyoucanlimittheinformationthatepraisewillextractfromSIMS.Todothisgoto:Admin>Sitesettings>MIS,thencompletetheLimittoyeargroupsboxes.Inserttheyearsyouwanttoshowinepraise,makingsurethenumbersareseparatedbyacommabutwithnospaces.

7

Screenshotshowingthe‘Limittoyeargroups’settingcompleted.

Epraisewillnotstartupdatingyourdataovernightuntilyoufirstrunamanualupdate.Todothis,goto:Admin>MISlink.Clickontheareasyouwishtosettoupdateautomatically,ensuringthatstudentsandteachersaresynchronisedfirst.Pleasenotethatyouwillnotbeabletodothis,untiltheMISdatahasbeenreceivedfromyourserver,whichmaytakeuptoanhour.

Onceyou’veupdatedalltheareasyouwant,youshouldfindthatthedataisupdatedautomaticallyovernight.Pleasenotethatdatawillnotbedeletedautomaticallyovernight.Youwillneedtorunamanualupdate.Itissuggestedthatyourunamanualupdateeverytermorso,toremoveanystudentsand/orteachersthathaveleft.

Achievements and Behaviour

BeforesyncingbothAchievementPointsandBehaviourPointsyouwillneedtoselecttherelevantsettingsinSitesettings.

Youhave3optionswhenitcomestodecidinghowyouwantyourbehaviourpointstoshowinepraise.Youcaneitherhaveallbehaviourpointsshowas‘0’inepraise,haveallbehaviourpointsshowas‘-1’inepraiseorhaveitsothatitminusesthesameamountasyourMIS.

8

SIMS Writeback Add-On Important:Youwillneedtohavepurchasedthewritebackadd-ontobeabletousethisfeature.DonotattempttoinstallEmergewithoutpurchasingthisadd-on.

EpraiseusestheGroupCallEmergesoftwaretoenableittowritebacktoSIMS.BeforeinstallingEmerge,pleaseensure:

1. Thetimeontheserverisaccurate2. YouhavechosenamemberofstaffinSIMStoattributepointsto(youcancreateanewone

ifyouwant,buttheywillneedatitle,initials,surnameandcontractstartdate)3. YouhavechosenanachievementcategoryinSIMStoattributepointsto(mostschools

createanewonecalled‘epraise’orsomethingsimilar)4. Youhaverunthe‘teacher’and‘behaviourWB’jobsintheGroupCallXporter5. YouhaverunthestaffsyncfromAdmin>MISlink>Syncstaff

Nextyouwillneedtodownloadthesoftware:

http://www.groupcall.co.uk/clients/ePraise/ePraiseEmerge_GroupcallXporter5_Setup.exe

OncethesoftwarehasbeeninstalledyouwillneedtowaitforthejobsinXportertocomplete.

Afterthey’vecompleted,openEmerge.

ThenenabletheServiceBus,thenstarttheserviceagain.

NextchecktheServiceBusisactive–youcandothisbygoingto

https://emergeen.servicebus.windows.net/ssl+yourschoolnumber.

9

Ifit’snot,it’sgenerallyafirewallblockingtraffic.TheEmergeServercommunicatestoServiceBusviaports9350,9351,9352,9353,443and80.ThereismoredetailedguidanceavailablefromGroupCallathttp://support.groupcall.com/emerge-firewall-requirements/.

OncetheServiceBusisactive,Goto‘Users’andaddauser–makearecordoftheusernameandpasswordyouuse.

Theprofilesettingisirrelevant.

InthecaseofahostedXporter,choosethecorrectsitefortheuser(mostschoolswillnotneedtodothis).

10

Now,GotoDevices,andaddadevicewiththeID:

epraiseQ-1-DAAD-4F24-9DC1-2322036A8A7A$$$$

Givethedeviceasensibledescription.

NextyouwillneedtochangeasettingintheXportermanagementconsole.GototheTokenssectionandaddablanktokennamed‘PostUpdate_CacheBehaviourToday’

Finally,gotoepraiseandfillinthesettingsbelow:

11

EpraisewillthenautomaticallyaddupallofyourpointsattheendoftheweekandwritethembacktoSIMS.

WhenitdoesthefirstwritebackitwillupdateSIMSwiththetotalforeachstudentwithinepraiseandthenafterthatwillonlyupdateSIMSwithwhatastudenthasachievedinthatweek(seeexamplebelow).

Ifyouhaveanyquestionsorsuggestions,pleaseletusknow!

SIMS Assessment ThissectionwillexplainhowtoallowepraisetopullassessmentdatafromSIMS.Thisinvolveschoosingupto20aspectsfromSIMStosendtoepraise,whichepraisewillthenprocessovernight,sothatteacherscanseemarksfromSIMSagainsttheirclassesinepraise.Notethatepraisesimplyselectsthemostrecentresultperaspectforeachstudent,anddoesnottakeintoaccountresultsets.

Selecting the aspects available in SIMS

1. GotoTools>Performance>Assessment>Category

2. RightclickonCESAssessmentServicesandselectAddCategoryType–callitXporter

12

3. RightclicktheXportercategorytype,selectAddCategory,andenterePraiseasthename.Thefinishedstructureshouldlooklikethis:

4. GotoFocus>Assessment>Aspect,andfindtheaspectyouwouldlikeepraisetobeabletosee

5. Editthecategoriesforthataspect,sothattheePraisecategoryisselected,thensaveyourchanges

13

6. Next,you’llneedtoruntheePraiseAssessmentjobintheGroupCallXporter,orwaitforittorunovernight.

7. Finally,synchronisethedatabygoingtoAdmin>MISlink>Syncassessment.Afterthefirstsyncisdoneepraiseshouldautomaticallyaddnewdataovernightwhenitbecomesavailable.

IMPORTING DATA

With the MIS Link SchoolsusingtheLDAPloginsorGoogleSSOoptionstoaccessepraisecanskipthissectioniftheyarehappyforstaffandstudentstoselecttheirownnamewhentheyloginforthefirsttime.Youwillhoweverstillneedtochangetheroleofanystaffmemberyouwanttobedifferentto‘teacher’,eitherusingthismethodorbyeditingthemindividually.

Becauseusernames,passwordsandrolesarenotreadfromyourMIS,youwillstillneedtoaddthosedetailstotheepraisesystem.

Todothis,goto:Admin>UpdatedataandchooseeitherImportstudentsorImportstaff.

Thisdataisimportedin.CSVformat,witheachfieldseparatedwithacommaandeachrecordonaseparateline.

TemplatefileswiththeSIMSdataalreadyenteredareavailableatthebottomoftheStudents/Staffpages(namedexistingstudentdataandexistingstaffdatarespectively).Pleasedownloadthese,fillintheusernameandpasswordfields(androleforstaff)anduploadagainensuringyouchecktheoverwriteexistingpasswordoption.

Without the MIS link

IfyourschoolisusingtheMISlink,pleasereadthatsectioninstead.

Thefirstthingtodoistoaddyourstaff,studentsandclassestothesystem.Thesemustbein.CSVformat,witheachfieldseparatedbyacommaandeachrecordonaseparateline.Thestudentandstaff.CSVfilescanbedownloadedfromyourMISsystem,bycreatingareportwiththerequiredfieldsin.Youwillneedtoeditthe.CSVfilebeforeuploadingit,toaddusernamesandpasswords,asMISsystemsdonotusuallycontainthisinformation.

MostschoolswillwanttousetheStudents,StaffandClassesroutines.Thespecificformatsrequiredandexample.CSVfilesareavailableontheirrelevantpages.

Formoredetailsonaccesslevels,seetheAppendix.

Toimportyourfiles:

1. LoginasaSchoolAdministrator,hoveroverAdminandclickonUpdatedata2. Selecttheimportyouwishtocarryout3. ClickChooseFile4. Selectthe.CSVfileyouwishtoimport5. Selectanyrelevantsettingsforyourimport(e.g.columnheadings)6. ClickImport

14

WhencompletingtheStaff/Studentuploadyouwillneedtochecktheoverwriteexistingpasswordsboxtoallowepraisetoimportthepasswordsyou’vecreated.

Mostschoolsupdatetheirstudentsonceeveryhalftermandthisisusuallysufficient(althoughyoucandothisasoftenasyouwish).Whenimportingdata,thereisanoptiontoremoveolddata.Thiswillremoveallstaff/students/classesetc.thatdon’texistinthefileyouupload.Becarefulusingthis,asyoucannotundoanychanges!

Students,Staff,Classes,etc.canallbeadded,editedanddeletedindividually,throughtherelevantadministrationpages.Thisisusefulforexample,ifasinglestudentjoinsinthemiddleofatermandyoudon’twanttoimporteverythingagain.

LOGINS

Security Securityistakenveryseriouslyatepraise.AllcommunicationwithepraiseisencryptedwithindustrystandardSSLtechnology.Usernamesandpasswordsareencryptedwheneveryouchangeyourpassword–evenwecan’ttellyouwhatyourpasswordis!

Basic Login Options

How do staff log in to epraise?

Staffcanlogintoepraise,usingausernameandpassword.Theseshouldhavebeensetupaspertheimportingdatasection.

15

SchoolAdministratorsareabletologintoanotherstaffmembersprofile.Youcansearchforthestaffmemberbyusingthesearchfacility(toprighthandsideofthescreen),onceyou’veselectedtherelevantstaffmemberclickonthecogiconandthenselectlogin.Toswitchbacktoyourownprofileclickswitchbackonthetoprighthandsideofthescreen.

How do students log in to epraise?

Studentslogintoepraiseeitherwithausernameandpassword,orusingapointcodethathasbeengeneratedbythesystem.

ThesettingthatdecidesthisisunderAdmin>Sitesettings>Login>Studentlogins.

Students login with username and password

Usernamesandpasswordsmustbeimportedwiththestudentdetailsaspertheimportdatasection.It’snotagoodideatogiveeverystudentthesamepassword,soyoucouldrandomlygenerateapasswordandthenmailmergethem,soyoucangivethemouttostudentsonpaper.

Studentscanchangetheirownpasswordandteacherscanchangeanystudent’spasswordbyvisitingthestudent’sprofilepage.

16

Student login using codes

Eachcodeisworthacertainnumberofpoints(decidedwhenthecodeisgenerated),andstudentsmustclaimthesecodesinorderforthemtocount.

Althoughwenolongerrecommendthismethodasitislesssecure,itispossibletosetupthestudentloginssothattheyusecodestoaccessepraise.Tologintothesystem,withtheStudentloginssettingsettoYes–usingcodes,studentscanusenew(unclaimed)codes,orcodesthey’vealreadyclaimed.Withbothapproaches,theymustselecttheirtutorgroup,thenname,thentheywillbedirectedtoaddthepointifit’sanewcode,ortotheirhomepageifit’sanoldone.

Codesareunique,withover700milliondifferentcombinations,sothechancesofastudentguessingoneareveryslim,howevertheycaneasilybelostorstolen.

LDAP Logins

Introduction

LDAPloginsallowepraisetoauthenticateusersagainstyourownactivedirectoryserver,meaningtheydon’thavetorememberseparateusernamesandpasswords.Thisguidewillexplainhowtosetthisup.

OnceLDAPloginsareswitchedon,allusersexceptfortheusercalledadmin,willattempttoauthenticateagainstthis–regardlessofwhetherthesettingsarecorrectornot.

Epraisemustbeabletoaccesstheserveryouspecifyinthesitesettings–mostschoolswillhavetospecificallyallowaccessfromourLDAPservers-46.38.163.146and5.79.4.13-inordertodothis.

Settings

BeforeLDAPwillwork,youmustfillintherelevantsettings,goto:Admin>Sitesettings>Login.

17

For staff

Option 1: Add staff first

Youcanaddstaffinthenormalway(eitherindividuallyinAdmin>Staff,orinbulkinAdmin>Updatedata>Importstaff).Justuseanyrandompasswordforthis-asthepasswordfieldwillnotbechecked.

Theadvantageofthisapproachisthatyoucansettherole(e.g.Teacher,PastoralLeader,SchoolAdministrator)beforeusershaveloggedin.

Option 2: Wait for staff to login, allow them to select their name

Ifyou’venotspecificallyaddedeachmemberofstaff,whentheyloginandarerecognisedasamemberofstaff(becauseoftheStaffBaseDNsetting),epraisewilltryandmatchthemwithamemberofstaff,basedontheuserscnfieldinactivedirectory.Ifanymatchingsurnamesarefound,thentheuserwillbegivenalistofthosemembersofstafftopickfrom,afterwhichtheycanthenlogin.Whentheyloginforthefirsttime,auseraccountwillbecreated.

Theadvantageofthisapproachisthatit’squicker,howeveryoumaystillneedtoadjusttheroleforsomemembersofstaff,asthedefaultisTeacher.

For students

Option 1: Add usernames to the students data

Importyourstudentsinthenormalway(Admin>Updatedata>Importstudents),inaformatthatincludesusernamesandpasswords.

OncetheLDAPuserhasbeenrecognisedasastudent,epraisewillthenlookforthatstudentinthestudent’sdata,byusername.Ifitfindsamatch,itwilllogthatstudentin.

Option 2: Let students pick their own name

IfanLDAPuserattemptstologinandisrecognisedasastudent,butdoesn’thaveamatchingusernameorUPN,thenextstepisforepraisetolistanymatchingstudents,basedontheirgivennameandsnfieldsinactivedirectory.Ifeitheroftheseareblank,itwillcheckthecnfieldformatchingsurnames.Ifanymatchesarefound,itwillpresentepraisewithalistofthematches,andallowthestudenttoselecttheirownname,beforeloggingin.

18

Onceastudenthassuccessfullyloggedin,epraisewilladdtheusernametothestudent’sdata,sotheydon’thavetogothroughthesameprocessagain.

Option 3: Add UPNs to Active Directory

ByaddingtheUPNstoActiveDirectory(‘AD’),youcandosomemoreinterestingstuffwithactivedesktops,suchasshowingthestudent’spoints,withoutthemloggingin.

IfanLDAPuserattemptstologinbutdoesn’thaveamatchingusernameinthestudentdata,thenextthingepraisewilllookforisaUPNintheemployeeIDfieldofAD.IfitfindsthisUPN,anditmatchesastudent,itwilllogthestudentin.

Tosetthisup,followtheseinstructions:

1. CreateaCSVfilewithjusttwofields–usernameandUPN,e.g.name,employeeIDbdunford,C53566432jbaker,B25356646

2. DownloadtheActiveRolesManagementShell,fromhttp://www.quest.com/powershell/activeroles-server.aspx

3. RunthecommandImport-Csvc:\AD.csv|foreach{Get-QADUser$_.Name-Sizelimit0|Set-QADUser-ObjectAttributes@{employeeID=$_.employeeID}}

OncetheUPNshavebeenaddedtoAD,aslongasyourstudentdataisuptodate,studentsshouldbeabletoaccesstheepraiseservice–youwillnotneedtoaddtheirusernamesandpasswordstoepraise.

Google Single Sign On SchoolswhichuseGoogleappsforeducationorsimilarmaybeabletouseGooglesinglesignon.Thiswillallowstudentsandstafftoclickonaloginbutton,whichwilllogthemstraightintoepraisewithouttheneedtotypeinausernameandpassword–assumingtheyarealreadysignedintoGoogle.

Toenablethis,checktheGoogleloginscheckboxandenteryourdomainandaregularexpressionforstudentsandstaffaccounts.Theregularexpressionallowsustoidentifywhattypeofuseraccountitisbytheusername.

Pleasegetintouchifyouwouldlikeustocompletethissettingforyou.

19

Parental Logins

What are parental logins?

Parentalloginsallowparentstologinandseehowwelltheirchildisdoing.Itwillalsoallowthemtoreceivecommunicationfromepraise,suchasmilestonenotifications(therewillbeawarningwhenparentalmilestonesareswitchedon).Parentsareabletoresettheirpasswordandtoturnofftheautomaticmilestonenotifications(youcanalsodothisviatheParentsadministrationtab).

Youcanalsodisableaccesstoepraiseforanyparentsthatdonotwishtoseethesite.Todothisgoto:Admin>Parents>Edit>tickDisableaccessbox.Ifthesuppliedemaildoesnotwork,thenthisinformationwilldisplayundertheEmailstatusbox.

How do I set this up?

1. YouneedtoturnitoninSitesettings(undertheParentstab)2. Youneedtoimportthedata3. IfyoudonothavetheMISkitgoto:Admin>Updatedata>Importparents4. IfyouhavetheMISKitgoto:Admin>MISlink>Syncparents

How do parents log in?

Parentscanloginbyvisitingaparticularwebaddress,suchas:

https://www.epraise.co.uk/index.php?school=example&login=parents

Theythenentertheiremailandclickonregister;epraisewillthensendanemail,whichwillincludealinkallowingthemtologinandcreateapassword.

Pleasetestparentalloginsbeforegivingyourparentsaccess,toensuretheycanonlyseewhatyouwantthemtosee!

APIs

Using APIs

What is an API?

AnAPIisawaytogetinformationinandoutofasystem.Inthecaseofepraise,thismeansthingssuchasattendance,graphsandleaderboards,whicharegreatfordisplayingonyourVLE,websiteorscreensaroundtheschool.Forexample,theJSONAPIhasbeendonesothatitcangetindividualstudentsmilestones,achievementsandaccolades.

20

What is the difference between the private and public API?

ThepublicAPIcontainsnostudentnames,whereastheprivateonecancontainstudentnames.Someschoolsarehappyforstudentnamestobepublic(asthereisnoassociatedimage),othersprefernotto,hencehavingtwoseparateAPIs.YouwillneedtoprovideyourAPIkey,whenusingtheprivateAPI.

Is it live?

Generally,yes,althoughsometimesinformationmaybedelayedtoensurethatepraiseremainsresponsiveforeverybody.

Does it automatically update?

Yes,thereisatimerthatwillrefreshthegraph/leaderboard/livestreamperiodically.

How do I set it up, in our school website?

ThefirststepistochoosetheAPIyouwouldliketouseandcopytheURL(websiteaddress)forit.Forexample,the‘reasons’graphhastheURL:

https://www.epraise.co.uk/api_public.php?school=example&graph=reasons&size=600x300&bgcolour=ffffff

Thenyouneedtogotothecodeofyourwebsite,andinsertsomethinglikethis:

<iframe src="https://www.epraise.co.uk/api_public.php?school=example&graph=reasons&size=600x300&bgcolour=ffffff" frameborder="0" width="600" height="300"></iframe>

Givingyousomethinglikethisinyourwebsite:

How do I set it up, on our flat screens?

Manyschoolshavespecialsoftwarefortheirflatscreens.Thewaytosetthisupvaries,butyou’relookingforawaytodisplayawebpage–thismightbecalledawebframeorwebslideforexample.YoushouldthenbeabletocopyyourchosenAPIURLintothesettingsforthatframe.

How do I set it up with iSAMS?

InorderforGroupcallXportertobeabletoextractdatafromthesystemtheyneedAPIaccesswhichiSAMSrequiresactivation.

21

YouwillneedtocontactiSAMSsotheycanallow3rdpartyAPIaccessonyouraccount.OnceconfirmedyouwillthenneedtocreateaBatchAPIkeyorrequestcreationofonefromiSAMSsupport.Itshouldbecreatedwiththefollowingaccesspermissions:

HRManagerPupilManagerCurrentPupilsRegistrationManagerRewradsAndConductTeachingManagerTimetableManagerSchoolManager

API Example - Frog 3 *Belowisaguidefromoneofourschools,showingyouanexampleofhowyoucanuseAPIsontheFrog3platform–thishasnotbeentestedbyepraiseandisbeingshownforreferenceonly*

Setting up

LogintotheFrog3toolkit.

Getthewidget.skeletonfromhttp://fdp.frogcommunity.com/generator/makingsuretoticktherolespreference.

Createanew.htmlfileandpastethewidget.skeletonfromtheabovewebsite.

CreateablankwebpageandusetheFDPWidgetContainerFrogBrick(below).Linkthefrogbricktotheabove.htmlfile

Creating the Widget

Toensuretheuserhascorrectpermissionstoviewstudentdata,intheroletagenter:

<role name="api.users.getinfo" />

Onpageloadfunctionenter:ToextractthestudentUPNfromFrog:

var GetUserInfo=function(data) { upn = data[0].upn; }

Frog.API.get("users.getinfo",

{ "params": {"id":UWA.Environment.user.id, 'details':'upn'},

"onSuccess": GetUserInfo});

Todefinethedatasource,whatdatatoextractandoutputitonthepage:

22

var myServer = http://api.epraise.co.uk/api_json.php?school=yourschool&key=yourkey&get=student&upn=”+upn;

UWA.Data.getJson(myServer, function(data){

var displayPoints = UWA.extendElement(widget.body.getElementsByTagName('p')[0]);

displayPoints.setText(data.points);

});

UsesomebasicCSSstylingtochangethelookofthewidget:

p {

color: white;

font-size: 20px;

line-height: 1em;

z-index: 99;

position: absolute;

width: 120px;

top: 90px;

text-align: center;

}

.box {

width: 120px;

height: 120px;

position: relative;

}

23

.points { background-color: #DAA520; }

.circle{

position: relative;

border-radius: 50%;

width: 70px;

height: 70px;

background-color: white;

top: 10px;

left: 25px;

}

#totalPoint { color: #DAA520; font-size: 40px; top: 13px; left: -25px; }

UseHTMLelementstooutputthedata:

<div class="box points">

<div class="circle">

<p id="totalPoint"></p>

</div>

<p>Total Points</p>

</div>

OurStudentDashboardepraisesectionwiththewidgetembedded:

24

APPENDIX – Permissions Matrix Pleasenotethatthislistisnotacompletereference,butwillgiveyouanoverviewofwhohasaccesstothemostcommonlyusedfeatures.

Section View/Action basic^ leader* praise_admin school_adminHome Viewdashboard Viewlivestream Me Viewprofile Viewplanner Viewweeklybulletins Viewpointshistory Changepassword Groups Awardpoints Viewclasses Viewtutorgroups Add/removeclasses Findstudents/classes Viewstudentprofiles Add/cancelpoints Add/cancelaccolades Add/cancelmanualachievements Add/canceldemerits Nominatestudentsfordraws Changestudentpasswords Cancelmilestonesachieved Offerpoints Community Viewgetinvolved

Viewhousepoints Add/edit/deletehousepoints Viewcharitablecauses Add/edit/deletecauses Viewstudentleaderboard Viewsubjectleaderboard Viewtutorgroupleaderboard Viewstaffleaderboard Viewdepartmentleaderboard Rewards Viewshopitems Viewwishlist Viewoverview Viewpurchases Add/edit/deleteshopitems Suggestions Viewprizedraws Add/edit/deletedraws Overviews Viewyearsoverview Viewgroupsoverview Viewdemeritsoverview WeeklyBulletins Viewsitestatistics Viewsecuritylog Downloads Exportdata

Generatemilestonecertificates Generatestudentreports

25

Generatestudentbios Displayresources Viewguidesandtutorials Administration Updatesitesettings Add/edit/deletestudents Add/edit/deletestaff Add/edit/deleteparents Add/edit/deleteclasses Add/edit/deletesubjects Changeachievementsettings Changemilestonesettings Checkcodes Generatecodes Importdata Resetdata ViewAPIs MISLink

^Includestheroles‘ta’,’teacher’and‘support_staff’*Includestheroles‘pastoral_leader’,’curriculum_leader’and‘other_leader’