TimeEditFields: Difference between revisions
Tags: Manual revert Visual edit |
|||
(8 intermediate revisions by 3 users not shown) | |||
Line 37: | Line 37: | ||
==TimeEdit field information when uploading to TimeEdit== | ==TimeEdit field information when uploading to TimeEdit== | ||
'''Predefined fields''' are done by UMS and can not be changed and are needed to enter into Configurator. | '''Predefined fields''' are done by UMS and can not be changed and are not needed to enter into Configurator. | ||
'''Required fields''' has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended. | '''Required fields''' has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended. | ||
Line 66: | Line 66: | ||
|StudieNr | |StudieNr | ||
|student.username | |student.username | ||
| | |Username for TimeEdit | ||
|X | |X | ||
|- | |- | ||
Line 74: | Line 74: | ||
This can be overwritten by manual configuration. | This can be overwritten by manual configuration. | ||
|X | |X | ||
|}<br /> | |}<br /> | ||
===Employees=== | ===Employees=== | ||
Line 123: | Line 106: | ||
!Description | !Description | ||
!Unique | !Unique | ||
|- | |- | ||
| | | | ||
Line 158: | Line 131: | ||
===Activity=== | ===Activity=== | ||
TimeEdit's extid for this object type is "studentclass.<Aktivitet>" | TimeEdit's extid for this object type is "studentclass.<Aktivitet>" unless "Use ActivityID" is set | ||
{| class="wikitable" | {| class="wikitable" | ||
|+Predefined fields | |+Predefined fields | ||
Line 173: | Line 146: | ||
| | | | ||
|- | |- | ||
| | | | ||
|studentclass.no_of_students | |studentclass.no_of_students | ||
| | | | ||
Line 240: | Line 213: | ||
|group.name | |group.name | ||
|X | |X | ||
|- | |||
| | |||
|group.number_of_members | |||
| | |||
|} | |} | ||
There | There are no required fields | ||
==Required TimeEdit fields when extracting timetable blocks== | ==Required TimeEdit fields when extracting timetable blocks== | ||
Line 269: | Line 246: | ||
|- | |- | ||
|BlockType | |BlockType | ||
| | |Object | ||
|BlockType | |BlockType | ||
|This is a field on the reservation in TimeEdit | |This is a field on the reservation in TimeEdit | ||
Line 293: | Line 270: | ||
|This is a field on the reservation in TimeEdit | |This is a field on the reservation in TimeEdit | ||
Allow this timetable block to be seen in UMS absence registration | Allow this timetable block to be seen in UMS absence registration | ||
|- | |||
|Exam | |||
|bit | |||
|ExamEvent | |||
|This is a field on the reservation in TimeEdit | |||
Tells UMS that this is an exam event | |||
|- | |- | ||
|teacher | |teacher | ||
Line 481: | Line 464: | ||
When set to True UMS will see the timetable block as [[Attendance Registration]] enabled. | When set to True UMS will see the timetable block as [[Attendance Registration]] enabled. | ||
==== Exam ==== | |||
This will mark the block as an exam event in UMS. | |||
====Comment==== | ====Comment==== |
Latest revision as of 08:26, 26 September 2024
Metadata configuration
Important information
TimeEdit has a limit in the database, a maximum of 20 data fields on a timeblock can be returned. If you map too many metadata the integration will fail. |
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.
Create metadata configurations for (if needed)
- employees
- activities
- courses
- students
- groups
Students are predefined by UMS, no setup is needed.
Some fields are predefined for the metadata settings while other are required if you are extracting Timetable blocks.
All fields are from the Students table.
Key name
The name of the field in TimeEdit.
Static text before database field
The text you write in this field will be suffixed to the UMS database field value.
UMS database field
The database field in the UMS table Students.
Static text after database field
The text you write in this field will be postfixed to the UMS database field value.
Required
UMS will not send the record to TimeEdit If this field is empty when it generates the data to send. This will also be logged in to TimeEdit.Log file.
TimeEdit field information when uploading to TimeEdit
Predefined fields are done by UMS and can not be changed and are not needed to enter into Configurator.
Required fields has to be setup in the Configurator program. They have to be setup with the as described below. The UMS field can be changed but it is not recommended.
All predefined and required fields has to be there for the extraction of Timetable blocks to work correctly.
All fields in TimeEdit are case sensitive.
Students
TimeEdit's extid for this object type is "student.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
UMS | TimeEdit | Description | Unique |
---|---|---|---|
ForNavne | person.first_name | First name | |
Efternavn | person.last_name | Last name | |
StudieNr | student.username | Username for TimeEdit | X |
general.email | UMS will fill this field with <Username@Students mail domain>
This can be overwritten by manual configuration. |
X |
Employees
TimeEdit's extid for this object type is "teacher.<SLI_ID>". SLI ID is from the internal UMS table called SLI and column ID.
UMS | TimeEdit | Description | Unique |
---|---|---|---|
ForNavne | person.first_name | First name | |
Efternavn | person.last_name | Last name | |
general.email | UMS will fill this field with <Username@Employee mail domain>
This can be overwritten by manual configuration. |
X |
UMS | TimeEdit | Description | Unique |
---|---|---|---|
person.init | Username for TimeEdit | X |
UMS | TimeEdit | Unique |
---|---|---|
MobilePhone | general.phone | |
WorkMail | general.email | X |
Example
Activity
TimeEdit's extid for this object type is "studentclass.<Aktivitet>" unless "Use ActivityID" is set
UMS | TimeEdit | Unique |
---|---|---|
Aktivitet | studentclass.code | X |
Aktivitet | studentclass.name | |
studentclass.no_of_students |
UMS | TimeEdit | Description |
---|---|---|
ActivityDescription | studentclass.longdescript | Long description |
Kort_Betegnelse | studentclass.shortname | Short description |
Example
Courses
TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"
UMS | TimeEdit | Unique |
---|---|---|
Aktivitet_Skolefag | course.code | X |
Aktivitet_Skolefag | course.name |
UMS | TimeEdit | Description |
---|---|---|
SkoleFag_Kort_Betegnelse | course.shortname | Short description |
SkoleFag_betegnelse | course.LongDescript | Long description |
Example
Groups
TimeEdit's extid for this object type is "group.<AktivitetsID>"
UMS | TimeEdit | Unique |
---|---|---|
Aktivitet | group.name | X |
group.number_of_members |
There are no required fields
Required TimeEdit fields when extracting timetable blocks
Fields UMS uses when extracting timetable blocks.
TimeEdit Name | TimeEdit object type | UMS object | Description |
---|---|---|---|
studentclass | Object | Activity | Used as activities that are class related |
description | Object | Activity | Used as activities that are not class related |
description | string | Label | This is a field on the reservation in TimeEdit |
BlockType | Object | BlockType | This is a field on the reservation in TimeEdit |
location | Object | Room | Room or location somewhere in the world |
person | Object | Teacher or Student | This can be a student or teacher |
comment | string | Comment | This is a field on the reservation in TimeEdit |
AbsenceRegistration | bit | AbsenceRegistration | This is a field on the reservation in TimeEdit
Allow this timetable block to be seen in UMS absence registration |
Exam | bit | ExamEvent | This is a field on the reservation in TimeEdit
Tells UMS that this is an exam event |
teacher | Object | Teacher | Needs to be created as person in TimeEdit |
student | Object | Student | Needs to be created as person in TimeEdit |
group | Object | Can contain students or teachers | |
course | Object | Course | Used as courses that are class related |
studentclass
TimeEdit name | UMS | Mandatory |
---|---|---|
general.title | X | |
studentclass.code | Activity | |
studentclass.name | ||
studentclass.longdescript | ActivityDescription | |
studentclass.shortname | ActivityShortDescription |
description (Object)
TimeEdit name | UMS | Mandatory |
---|---|---|
general.title | ActivityDescription | X |
activity.name | Activity |
Location
This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.
TimeEdit name | UMS | Mandatory |
---|---|---|
general.id | Room ID | X |
general.id | Room number | |
general.title | Room name |
person
TimeEdit name | UMS | Mandatory |
---|---|---|
person.first_name | FirstName | X |
person.last_name | LastName | |
person.init | Initials |
teacher
TimeEdit name | UMS | Mandatory |
---|---|---|
person.first_name | FirstName | X |
person.last_name | LastName | |
person.init | Initials |
student
TimeEdit name | UMS | Mandatory |
---|---|---|
person.first_name | FirstName | X |
person.last_name | LastName |
Course
TimeEdit name | UMS | Mandatory |
---|---|---|
general.title | X | |
course.code | Course | |
course.name | CourseDescription | X |
course.shortname | CourseShortDescription | |
extid | CourseID |
Groups
TimeEdit name | UMS | Mandatory |
---|---|---|
general.title | Not used in UMS | X |
general.id | Not used in UMS |
Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.
Timetable block
These 2 fields must be set on the timetable block.
AbsenceRegistration
UMS supports Absence information from TimeEdit.
This is achieved by creating a True/False column on the timetable blocks called "AbsenceRegistration"
When set to True UMS will see the timetable block as Attendance Registration enabled.
Exam
This will mark the block as an exam event in UMS.
Comment
This will be put in the comment field in UMS
All other fields
All other fields on a reservation will be added to the comment field in UMS.
Except these to fields that are ignored "r.note" and "r.reservation_text_ref".