Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • This is a subscription module which is currently charged along with support. You will need a licence in order to use this process

  • SynAPI needs to be configured

  • A Custom web service needs to be setup for Edval to talk with Synergetic

  • Edval needs to be configured to talk with Synergetic along with some additional config

  • Synergetic needs to be configured to point to the Timetable / Yard Duties codes with settings for when to import

...

Config

Description

URL

The URL should start with https:// and end with SynergeticWcfService.svc

Password

This password is generated for each third party system and will be supplied from Synergetic once SynAPI has been setup and Edval Sync has been configured.

Web GUID

This Web GUID is generated for each third party system and will be supplied from Synergetic once SynAPI has been setup and Edval Sync has been configured.

DefaultTimetableCode Default Timetable Code 

This code should match exactly the corresponding Timetable Code configuration as per the Synergetic Timetable namesMaintenance > Timetable Config entry shown in the next section

In addition, if you’re using Edval’s multi-campus/multi-grid feature, then the campus name must match the Synergetic Timetable name – this is set up in “Edval | File > Year levels > More > Edit list of campuses”.

Yard Duty Timetable Code

This code should match exactly the corresponding Timetable Code configuration as per the Synergetic Timetable names.  Timetable Maintenance > Timetable Config entry shown in the next section.

This may be the same as the Default Timetable Code in some cases.

In addition, if you’re using Edval’s multi-campus/multi-grid feature, then the campus name must match the Synergetic Timetable name – this is set up in “Edval | File > Year levels > More > Edit list of campuses”.

...

The top screen configures where the files are located and the bottom screen configures the settings used to import the timetabletimetablee.

You will configure this integration for time periods to align with your timetable start and end dates.

Refer to ImportStartDateTime and ImportEndDateTime below.

...

Field

Description

TimetableCode

This is the code that is used when importing the timetable. This is the link from Edval to Synergetic. If Yard duties have been separated then this will need to be configured separately.

Description

A description of the timetable being imported. This is an internal description which isn’t populated through the imports

TimetablePath

This field is not required for this import as we are pushing the data directly into Synergetic without a file in between

FileYear

The Year that we are importing into

FileSemester

The Semester / Term that we are importing into

FileType

The FileType we are importing into. 

ClassCampus

The ClassCampus that is being imported.

TimetableGroup

The TimetableGroup that is being import imported against (doesn’t matter what is in the imported XML)

TimetableType

What type of import are we doing. For Edval we should be using CUSTOM

Valid Values:

CodeDescriptionTIMETABLERTimetable data TIMETABLEREXTExtras / Room replacementsTIMETABLERYDYard duties CUSTOMCustom Import

YearLevelFrom

This will need to be set for the starting year level we are working at in the Edval file.

YearLevelTo

This will need to be set for the last year level we are working at in the Edval file.

StudentLinkField

Edval stores a student code in the database. This is what that code represents in Synergetic and what we will be matching it to.

Valid Values:

CodeDescriptionAltCodeMatch AltCode - Match based on Alternate Code IDMatch

ID - Match based on Synergetic ID PreviousSystemCodeMatch

PreviousSystemCode - Match based on Previous System Code TimetableCodeMatch

TimetableCode - Match based on Timetable Code.

StaffLinkField

Edval stores a staff code in the timetable. This is what that code represents in Synergetic.

Valid Values:

CodeDescriptionIDMatch ID - Match based on SynergeticID Synergetic ID

SchoolStaffCode - Match based on School Staff Code

ImportOrderSeq

The order that we importing the files in.

Set to 1 if not sure.

TimetableOperationMode

This links to luTimetableOperationMode which has various settings for the import. See below for all of the options. 

Examples might be as follows:

CodeDescriptionMeaningTERMTerm ModeClear TERM - Term Mode

Clear Staff & Set any Student Class changes to be Non-Assessable during termASSESSAssessment ModeClear term

ASSESS - Assessment Mode

Clear Staff but don't Set any Student Class changes to be Non-Assessable during Report writing

ImportStartDateTime

The date that the import will start from. If the date the import is running doesn’t fall inside this range then nothing will be imported. 

ImportEndDateTime

The date that the import will end. If the date the import is running doesn’t fall inside this range then nothing will be imported

EnabledFlag

Whether the import is enabled. If this is set to 0 then nothing will be imported for the schedule selected

PeriodOffset

This field allows you to set an offset on the periods that are being imported. This adjusts the timetable period that is being imported by the periodoffset

luTimetableOperationMode

This looking table controls various options around the Automatic Import of the Timetable

...