Difference between revisions of "TimeEditFields"

From UmsWiki
Jump to: navigation, search
(→‎Course)
(→‎TimeEdit field information when uploading to TimeEdit)
 
(9 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.
 
This lets you define which fields in UMS are sent to corresponding fields in TimeEdit.
  
−
Create 4 metadata configurations for
+
Create metadata configurations for (if needed)
  
 
*employees
 
*employees
Line 13: Line 13:
 
*courses
 
*courses
 
*students
 
*students
 +
*groups
  
 
Students are predefined by UMS, no setup is needed.
 
Students are predefined by UMS, no setup is needed.
Line 51: Line 52:
 
!TimeEdit
 
!TimeEdit
 
!Description
 
!Description
 +
!Unique
 
|-
 
|-
 
|ForNavne
 
|ForNavne
 
|person.first_name
 
|person.first_name
 
|First name
 
|First name
 +
|
 
|-
 
|-
 
|Efternavn
 
|Efternavn
 
|person.last_name
 
|person.last_name
 
|Last name
 
|Last name
−
|-
 
−
|StudieNr
 
−
|student.init
 
 
|
 
|
 
|-
 
|-
Line 67: Line 67:
 
|student.username
 
|student.username
 
|
 
|
 +
|X
 
|-
 
|-
 
|
 
|
Line 72: Line 73:
 
|UMS will fill this field with <Username@Students mail domain>
 
|UMS will fill this field with <Username@Students mail domain>
 
This can be overwritten by manual configuration.
 
This can be overwritten by manual configuration.
−
|}
+
|X
−
{| class="wikitable"
 
−
|+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
 
 
|}<br />
 
|}<br />
 
===Employees===
 
===Employees===
Line 95: Line 82:
 
!TimeEdit
 
!TimeEdit
 
!Description
 
!Description
 +
!Unique
 
|-
 
|-
 
|ForNavne
 
|ForNavne
 
|person.first_name
 
|person.first_name
 
|First name
 
|First name
 +
|
 
|-
 
|-
 
|Efternavn
 
|Efternavn
 
|person.last_name
 
|person.last_name
 
|Last name
 
|Last name
 +
|
 
|-
 
|-
 
|
 
|
Line 108: Line 98:
 
|UMS will fill this field with <Username@Employee mail domain>
 
|UMS will fill this field with <Username@Employee mail domain>
 
This can be overwritten by manual configuration.
 
This can be overwritten by manual configuration.
 +
|X
 
|}
 
|}
 
{| class="wikitable"
 
{| class="wikitable"
Line 114: Line 105:
 
!TimeEdit
 
!TimeEdit
 
!Description
 
!Description
−
|-
+
!Unique
−
|
 
−
|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
 
|person.init
 
|Username for TimeEdit
 
|Username for TimeEdit
 +
|X
 
|}
 
|}
 
{| class="wikitable"
 
{| class="wikitable"
Line 132: Line 116:
 
!UMS
 
!UMS
 
!TimeEdit
 
!TimeEdit
 +
!Unique
 
|-
 
|-
 
|MobilePhone
 
|MobilePhone
 
|general.phone
 
|general.phone
 +
|
 
|-
 
|-
 
|WorkMail
 
|WorkMail
 
|general.email
 
|general.email
 +
|X
 
|}
 
|}
  
Line 149: Line 136:
 
!UMS
 
!UMS
 
!TimeEdit
 
!TimeEdit
 +
!Unique
 
|-
 
|-
 
|Aktivitet
 
|Aktivitet
 
|studentclass.code
 
|studentclass.code
 +
|X
 
|-
 
|-
 
|Aktivitet
 
|Aktivitet
 
|studentclass.name
 
|studentclass.name
 +
|
 
|-
 
|-
−
|Aktivitet
+
|
 
|studentclass.no_of_students
 
|studentclass.no_of_students
 +
|
 
|}
 
|}
 
{| class="wikitable"
 
{| class="wikitable"
Line 183: Line 174:
 
!UMS
 
!UMS
 
!TimeEdit
 
!TimeEdit
 +
!Unique
 
|-
 
|-
 
|Aktivitet_Skolefag
 
|Aktivitet_Skolefag
 
|course.code
 
|course.code
 +
|X
 
|-
 
|-
 
|Aktivitet_Skolefag
 
|Aktivitet_Skolefag
 
|course.name
 
|course.name
 +
|
 
|}
 
|}
 
{| class="wikitable"
 
{| class="wikitable"
Line 207: Line 201:
 
====Example====
 
====Example====
 
[[File:Map metadatafields Courses.png|none|thumb|916x916px]]
 
[[File:Map metadatafields Courses.png|none|thumb|916x916px]]
 +
 +
===Groups===
 +
TimeEdit's extid for this object type is "group.<AktivitetsID>"
 +
{| class="wikitable"
 +
|+Predefined fields
 +
!UMS
 +
!TimeEdit
 +
!Unique
 +
|-
 +
|Aktivitet
 +
|group.name
 +
|X
 +
|-
 +
|
 +
|group.number_of_members
 +
|
 +
|}
 +
There are no required fields
  
 
==Required TimeEdit fields when extracting timetable blocks==
 
==Required TimeEdit fields when extracting timetable blocks==
Line 285: Line 297:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|general.title
 
|general.title
 
|
 
|
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|studentclass.code
 
|studentclass.code
 
|Activity
 
|Activity
 
|
 
|
−
|X
 
 
|-
 
|-
 
|studentclass.name
 
|studentclass.name
−
|
 
 
|
 
|
 
|
 
|
Line 304: Line 312:
 
|studentclass.longdescript
 
|studentclass.longdescript
 
|ActivityDescription
 
|ActivityDescription
−
|
 
 
|
 
|
 
|-
 
|-
 
|studentclass.shortname
 
|studentclass.shortname
 
|ActivityShortDescription
 
|ActivityShortDescription
−
|
 
 
|
 
|
 
|}
 
|}
Line 318: Line 324:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|general.title
 
|general.title
 
|ActivityDescription
 
|ActivityDescription
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|activity.name
 
|activity.name
 
|Activity
 
|Activity
−
|
 
 
|
 
|
 
|}
 
|}
Line 337: Line 340:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|general.id
 
|general.id
 
|Room ID
 
|Room ID
−
|X
 
 
|X
 
|X
 
|-
 
|-
 
|general.id
 
|general.id
 
|Room number
 
|Room number
−
|
 
 
|
 
|
 
|-
 
|-
 
|general.title
 
|general.title
 
|Room name
 
|Room name
−
|
 
 
|
 
|
 
|}
 
|}
Line 360: Line 359:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|person.first_name
 
|person.first_name
 
|FirstName
 
|FirstName
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|person.last_name
 
|person.last_name
 
|LastName
 
|LastName
−
|
 
 
|
 
|
 
|-
 
|-
Line 375: Line 371:
 
|Initials
 
|Initials
 
|
 
|
−
|X
 
 
|}
 
|}
  
Line 383: Line 378:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|person.first_name
 
|person.first_name
 
|FirstName
 
|FirstName
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|person.last_name
 
|person.last_name
 
|LastName
 
|LastName
−
|
 
 
|
 
|
 
|-
 
|-
Line 398: Line 390:
 
|Initials
 
|Initials
 
|
 
|
−
|X
 
 
|}
 
|}
  
Line 406: Line 397:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|person.first_name
 
|person.first_name
 
|FirstName
 
|FirstName
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|person.last_name
 
|person.last_name
 
|LastName
 
|LastName
−
|
 
 
|
 
|
 
|}
 
|}
Line 424: Line 412:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|general.title
 
|general.title
 
|
 
|
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|course.code
 
|course.code
 
|Course
 
|Course
 
|
 
|
−
|X
 
 
|-
 
|-
 
|course.name
 
|course.name
 
|CourseDescription
 
|CourseDescription
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|course.shortname
 
|course.shortname
 
|CourseShortDescription
 
|CourseShortDescription
−
|
 
 
|
 
|
 
|-
 
|-
 
|extid
 
|extid
 
|CourseID
 
|CourseID
−
|
 
 
|
 
|
 
|}
 
|}
Line 457: Line 439:
 
!UMS
 
!UMS
 
!Mandatory
 
!Mandatory
−
!Unique
 
 
|-
 
|-
 
|general.title
 
|general.title
 
|Not used in UMS
 
|Not used in UMS
 
|X
 
|X
−
|
 
 
|-
 
|-
 
|general.id
 
|general.id
 
|Not used in UMS
 
|Not used in UMS
 
|
 
|
−
|X
 
 
|}Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.
 
|}Members of groups will be extracted and added to the timetable blocks if a group is added to a timetable block in TimeEdit.
  
Line 482: Line 461:
 
====Comment====
 
====Comment====
 
This will be put in the comment field in UMS
 
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'''".

Latest revision as of 08:42, 9 March 2022

Contents

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 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 Unique
ForNavne person.first_name First name
Efternavn person.last_name Last name
StudieNr student.username 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.

Predefined fields
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
Required fields
UMS TimeEdit Description Unique
person.init Username for TimeEdit X
Best practice fields
UMS TimeEdit Unique
MobilePhone general.phone
WorkMail general.email X

Example

 

Activity

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

Predefined fields
UMS TimeEdit Unique
Aktivitet studentclass.code X
Aktivitet studentclass.name
studentclass.no_of_students
Required fields
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>"

Predefined fields
UMS TimeEdit Unique
Aktivitet_Skolefag course.code X
Aktivitet_Skolefag course.name
Required fields
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>"

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

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

Retrieved from "http://wiki.inlogic.dk/index.php?title=TimeEditFields&oldid=4284"