TimeEditFields: Difference between revisions
Created page with "==TimeEdit field information== '''Predefined fields''' are done by UMS and can not be changed and are needed to enter into Configurator. '''Required fields''' has to be setup..." |
No edit summary |
||
Line 1: | Line 1: | ||
==Metadata configuration== | |||
{| class="wikitable" | |||
|'''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 [[GetTimetable/TimeEdit|Timetable blocks]]. | |||
All fields are from the '''Students''' table.[[File:TimeEdit Settings Metadata.jpg|none|thumb|902x902px]] | |||
===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== | ==TimeEdit field information== | ||
'''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 needed to enter into Configurator. |
Revision as of 08:19, 19 February 2020
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.
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
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.
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. |
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.
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. |
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 |
UMS | TimeEdit |
---|---|
MobilePhone | general.phone |
WorkMail | general.email |
Example
Activity
TimeEdit's extid for this object type is "studentclass.<Aktivitet>"
UMS | TimeEdit |
---|---|
Aktivitet | studentclass.code |
Aktivitet | studentclass.name |
Aktivitet | 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 |
---|---|
Aktivitet_Skolefag | course.code |
Aktivitet_Skolefag | course.name |
UMS | TimeEdit | Description |
---|---|---|
SkoleFag_Kort_Betegnelse | course.shortname | Short description |
SkoleFag_betegnelse | course.LongDescript | Long description |