TimeEditFields

From UmsWiki
Revision as of 11:21, 7 July 2021 by Kia (talk | contribs)
Jump to: navigation, search

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 4 metadata configurations for

  • employees
  • activities
  • courses
  • students

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.

TimeEdit Settings Metadata.jpg

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 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.

Predefined fields
UMS TimeEdit Description
ForNavne person.first_name First name
Efternavn person.last_name Last name
StudieNr student.init
StudieNr student.username
general.email UMS will fill this field with <Username@Students mail domain>

This can be overwritten by manual configuration.

Required fields
UMS TimeEdit Description
person.name Is a concatenation of first_name and last_name

Is only used when fetching data in timetable blocks

Do no set this up when creating meta data

This has to be setup in TimeEdit


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.

Predefined fields
UMS TimeEdit Description
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.

Required fields
UMS TimeEdit Description
person.name Is a concatenation of first_name and last_name

Is only used when fetching data in timetable blocks

Do no set this up when creating meta data

This has to be setup in TimeEdit

person.init Username for TimeEdit
Best practice fields
UMS TimeEdit
MobilePhone general.phone
WorkMail general.email

Example

Map metadatafields Employees.png

Activity

TimeEdit's extid for this object type is "studentclass.<Aktivitet>"

Predefined fields
UMS TimeEdit
Aktivitet studentclass.code
Aktivitet studentclass.name
Aktivitet studentclass.no_of_students
Required fields
UMS TimeEdit Description
ActivityDescription studentclass.longdescript Long description
Kort_Betegnelse studentclass.shortname Short description

Example

Map metadatafields Activity.png

Courses

TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"

Predefined fields
UMS TimeEdit
Aktivitet_Skolefag course.code
Aktivitet_Skolefag course.name
Required fields
UMS TimeEdit Description
SkoleFag_Kort_Betegnelse course.shortname Short description
SkoleFag_betegnelse course.LongDescript Long description

Example

Map metadatafields Courses.png

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 string 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

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
studentclass.code Activity
studentclass.longdescript ActivityDescription
studentclass.shortname ActivityShortDescription
ActivityID extid

description (Object)

TimeEdit name UMS
activity.name Activity
general.title ActivityDescription
extid ActivityID

Location

This can considered as rooms or they can be locations. They will be put in UMS tables as rooms.

TimeEdit name UMS
general.id Room ID
general.id Room number
general.title Room name

person

TimeEdit name UMS
person.first_name FirstName
person.last_name LastName
person.init Initials

teacher

TimeEdit name UMS
person.first_name FirstName
person.last_name LastName
person.init Initials

student

TimeEdit name UMS
person.first_name FirstName
person.last_name LastName

Course

TimeEdit name UMS
course.code Course
course.name CourseDescription
course.shortname CourseShortDescription
extid CourseID

Groups

TimeEdit name UMS
general.title Not used in UMS
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.

Comment

This will be put in the comment field in UMS