Synergetic access requirements

In order to synchronise data from Synergetic you will need to grant access to your Synergetic SQL database.

The Intellischool Data Platform is capable of synchronising data with Synergetic for those customers that have purchased an appropriate license.

🔐 Want to know more about what data Intellischool accesses from Synergetic?
Our Synergetic Schema Map document clearly articulates which tables, views, and fields are used by Intellischool, as well as those that are not required.

➡️ Credentials

It is best practice to configure a separate username and password for Intellischool to connect to your Synergetic database. These credentials must be configured using SQL native authentication, not Windows authentication.

➡️ Table access

You may wish to restrict the tables that Intellischool can access depending on the types of data you wish to synchronise with Intellischool.

➡️ Minimum access

The Sync Agent must be given permission to create temporary tables in your Synergetic database. These tables are used for query efficiency, and are deleted automatically at the end of each sync session. They are not visible to other database users.

Read-only access to the following tables / views is required at a minimum for all types of integration:

FileSemesters luTimetableGroup SubjectClasses
FileSemesterYearLevels luYearLevel StudentClasses
luCampus pvStudentNamesAll StudentYears
luFileType Students PastStudentClasses
luForm vStaff vSubjectClassesStaff
luGender vStudents  
luHouse StudentAssessmentResults

To apply the required permissions listed above, run the following SQL statement from a user account that has appropriate database permissions to do so, ensuring that <username> is replaced with the database username you have assigned to the Sync Agent:

GRANT SELECT ON [dbo].[FileSemesters] TO <username>;
GRANT SELECT ON [dbo].[FileSemesterYearLevels] TO <username>;
GRANT SELECT ON [dbo].[luCampus] TO <username>;
GRANT SELECT ON [dbo].[luFileType] TO <username>;
GRANT SELECT ON [dbo].[luForm] TO <username>;
GRANT SELECT ON [dbo].[luGender] TO <username>;
GRANT SELECT ON [dbo].[luHouse] TO <username>;
GRANT SELECT ON [dbo].[luTimetableGroup] TO <username>;
GRANT SELECT ON [dbo].[luYearLevel] TO <username>;
GRANT SELECT ON [dbo].[pvStudentNamesAll] TO <username>;
GRANT SELECT ON [dbo].[Students] TO <username>;
GRANT SELECT ON [dbo].[vStaff] TO <username>;
GRANT SELECT ON [dbo].[vStudents] TO <username>;
GRANT SELECT ON [dbo].[SubjectClasses] TO <username>;
GRANT SELECT ON [dbo].[StudentClasses] TO <username>;
GRANT SELECT ON [dbo].[StudentYears] TO <username>;
GRANT SELECT ON [dbo].[PastStudentClasses] to <username>; --added 2024-03-13
GRANT SELECT ON [dbo].[vSubjectClassesStaff] to <username>; --added 2024-03-13

➡️ Synergetic markbook

In addition to the tables listed under Minimum access above, read-only access to the following tables / views is required:

LearningAreas
luReportResultGroup
luReportResultType
luReportResultTypeMaskExpanded
pvStudentAssessmentResultAreas
StudentClasses
StudentYears
SubjectAssessmentVELSStrands (Victorian schools using VELS only)
SubjectAssessmentVELSDomains (Victorian schools using VELS only)
SubjectAssessmentVELSDomainDimensions (Victorian schools using VELS only)
SubjectAssessmentCurriculum
SubjectAssessmentAreas
SubjectClasses
GRANT SELECT ON [dbo].[LearningAreas] TO <username>;
GRANT SELECT ON [dbo].[luReportResultGroup] TO <username>;
GRANT SELECT ON [dbo].[luReportResultType] TO <username>;
GRANT SELECT ON [dbo].[luReportResultTypeMaskExpanded] TO <username>;
GRANT SELECT ON [dbo].[pvStudentAssessmentResultAreas] TO <username>;
GRANT SELECT ON [dbo].[StudentClasses] TO <username>;
GRANT SELECT ON [dbo].[StudentYears] TO <username>;
GRANT SELECT ON [dbo].[SubjectAssessmentCurriculum] TO <username>;
GRANT SELECT ON [dbo].[SubjectAssessmentAreas] TO <username>;
GRANT SELECT ON [dbo].[SubjectClasses] TO <username>;

// Victorian schools using VELS tables only
GRANT SELECT ON [dbo].[SubjectAssessmentVELSStrands] TO <username>;
GRANT SELECT ON [dbo].[SubjectAssessmentVELSDomains] TO <username>;
GRANT SELECT ON [dbo].[SubjectAssessmentVELSDomainDimensions] TO <username>;

➡️ Schoolbox + Synergetic

In addition to the tables listed under Minimum access above, read-only access to the following tables / views is required:

AbsenceEvents pvStaffJobPositions Timetable
Absences pvStudentAssessmentResultAreas TimetableConfig
AttendanceMaster pvTimetableDefinitionAll TimetableDefinition
Attendances StudentClasses vStaffJobPositions
LearningAreas StudentSemester vStudentClasses
luAbsencePeriod SubjectAssessmentAreas vStudentTimetableClasses
luAbsenceReason SubjectClasses vStudentTimetablePeriods
luAbsenceType SubjectClassStaff CalendarEvents
PastStudentClasses tAttendances luTimetableGroup
TimetableSubstitutes    


To apply these permissions quickly, you can use the following SQL script template:

GRANT SELECT ON [dbo].[AbsenceEvents] TO <username>;
GRANT SELECT ON [dbo].[Absences] TO <username>;
GRANT SELECT ON [dbo].[AttendanceMaster] TO <username>;
GRANT SELECT ON [dbo].[Attendances] TO <username>;
GRANT SELECT ON [dbo].[LearningAreas] TO <username>;
GRANT SELECT ON [dbo].[luAbsencePeriod] TO <username>;
GRANT SELECT ON [dbo].[luAbsenceReason] TO <username>;
GRANT SELECT ON [dbo].[luAbsenceType] TO <username>;
GRANT SELECT ON [dbo].[PastStudentClasses] TO <username>;
GRANT SELECT ON [dbo].[pvStaffJobPositions] TO <username>;
GRANT SELECT ON [dbo].[pvStudentAssessmentResultAreas] TO <username>;
GRANT SELECT ON [dbo].[pvTimetableDefinitionAll] TO <username>;
GRANT SELECT ON [dbo].[StudentClasses] TO <username>;
GRANT SELECT ON [dbo].[StudentSemester] TO <username>;
GRANT SELECT ON [dbo].[SubjectAssessmentAreas] TO <username>;
GRANT SELECT ON [dbo].[SubjectClasses] TO <username>;
GRANT SELECT ON [dbo].[SubjectClassStaff] TO <username>;
GRANT SELECT ON [dbo].[tAttendances] TO <username>;
GRANT SELECT ON [dbo].[Timetable] TO <username>;
GRANT SELECT ON [dbo].[TimetableConfig] TO <username>;
GRANT SELECT ON [dbo].[TimetableDefinition] TO <username>;
GRANT SELECT ON [dbo].[vStaffJobPositions] TO <username>;
GRANT SELECT ON [dbo].[vStudentClasses] TO <username>;
GRANT SELECT ON [dbo].[vStudentTimetableClasses] TO <username>;
GRANT SELECT ON [dbo].[vStudentTimetablePeriods] TO <username>;

GRANT SELECT ON [dbo].[CalendarEvents] to <username>; --added 2024-10-23
GRANT SELECT ON [dbo].[luTimetableGroup] to <username>; --added 2024-10-23
GRANT SELECT ON [dbo].[TimetableSubstitutes] to <username>; --added 2024-10-23
GRANT SELECT ON [dbo].[pvAttendancesAll] to <username>; --added 2024-10-23
GRANT SELECT ON [dbo].[pvTimetableDefinitionAll] to <username>; --added 2024-10-23

 

 

🤔 Need further support?
We're ready to help anytime. Reach out at help@intellischool.co