Jump to content

GetTimetable/TimeEdit: Difference between revisions

From UmsWiki
Kia (talk | contribs)
 
(18 intermediate revisions by 2 users not shown)
Line 9: Line 9:


==Setting==
==Setting==
[[File:GetTimetable TimeEdit.jpg|none|thumb|783x783px]]
[[File:GetTimetable TimeEdit.jpg|none|thumb|790x790px]]


===[[GetTimetable/Format and content|Format and content]]===
===[[GetTimetable/Format and content|Format and content]]===
Line 15: Line 15:
===Description===
===Description===
Name of the setting.
Name of the setting.
===[[GetTimetable/Absence_settings|Absence settings]]===


===Server connection===
All connection information is provided by TimeEdit support. (Please contact them for this information.)
All information is specific to a customer. This must match the one under the data source for templates.
====URL (Endpoint)====
This URL specifies the endpoint that UMS connects to.
====Certificate path====
Then XML file you receive from TimeEdit.
====Username====
Username to access the Webservice URL.
====Password====
Password to access the Webservice URL.
===[[GetTimetable/Export_settings|Export settings]]===
===[[GetTimetable/Export_settings|Export settings]]===


==Extra required TimeEdit fields==
===Object Types===
This setting defines the object type that UMS will extract from TimeEdit. If you click the buttons you will see default values for the object names in TimeEdit.


===Fields UMS uses when extracting timetable blocks.===
You can enter more object types for each UMS object


*studentclass (Activity)
In the example below. UMS will extract classroom and location as a room in UMS.
*description (Label)
*BlockType
*location (Room or location somewhere in the world)
*person (This can be a student or teacher)
*comment
*AbsenceRegistration
*teacher
*student
*group
*course
*activity.name


===Location===
[[File:GetTimetable TimeEdit ObjectTypes Room.jpg|none|thumb|547x547px]]
This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.


Location must have 2 fields in TimeEdit
==== Comment ====
 
The external name from TimeEdit.
====general.id====
Will be put in these 2 fields in UMS
 
*Room ID
*Room number
 
====general.title====
Will be put in this field in UMS
 
*Room name
 
===Course===
 
====extid====
Will be put in this fields in UMS
 
*SKFA_ID
 
====course.code====
Will be put in this fields in UMS
 
*Course


====course.name====
This is a string value.
Will be put in this fields in UMS


*Description
Indicates the comment set in UMS on the event.


====course.shortname====
==== Absence registration ====
Will be put in this fields in UMS
The external name from TimeEdit.


*DescriptionShort
This is a bit/bool value.


===Timetable block===
Indicates an absence event in UMS.
These 2 fields must be set on the timetable block.


====AbsenceRegistration====
==== Exam ====
UMS supports Absence information from TimeEdit.
The external name from TimeEdit.


This is achieved by creating a True/False column on the timetable blocks called "'''AbsenceRegistration'''"
This is a bit/bool value.


When set to True UMS will see the timetable block as [[Attendance Registration]] enabled.
Indicates an exam event in UMS.


==== Comment ====
=== [[TimeEditFields#Required_TimeEdit_fields_when_extracting_timetable_blocks|TimeEdit field information]] ===
This will be put in the comment field in UMS


==FAQ==
==FAQ==

Latest revision as of 11:40, 18 August 2026

Requiements

UMS Modules

SLI

TimeEdit

This feature only works if UMS has uploaded the data with our TimeEdit module.

Setting

Description

Name of the setting.

Object Types

This setting defines the object type that UMS will extract from TimeEdit. If you click the buttons you will see default values for the object names in TimeEdit.

You can enter more object types for each UMS object

In the example below. UMS will extract classroom and location as a room in UMS.

Comment

The external name from TimeEdit.

This is a string value.

Indicates the comment set in UMS on the event.

Absence registration

The external name from TimeEdit.

This is a bit/bool value.

Indicates an absence event in UMS.

Exam

The external name from TimeEdit.

This is a bit/bool value.

Indicates an exam event in UMS.

FAQ

What to do when TimeEdit replaces an existing timetable system such as SIS ?

When the school is ready to drop the old system, all old timetable data must be removed from UMS, else the enduser will see duplicated timetable blocks due days back / days ahead settings in both old and new system.