TimeEdit: Difference between revisions

From UmsWiki
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
Kia (talk | contribs)
engineering, inHouse, Administrators
2,475 edits
No edit summary
Kia (talk | contribs)
engineering, inHouse, Administrators
2,475 edits
Line 92: Line 92:
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.
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.


 
=== [[TimeEditFields|TimeEdit field information]] ===
===[[TimeEditFields|TimeEdit field information]]===
 
==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 [[GetTimetable/TimeEdit|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.
{| class="wikitable"
|+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.
|}
{| 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 />
===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.
{| class="wikitable"
|+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.
|}
{| 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
|-
|
|person.init
|Username for TimeEdit
|}
{| class="wikitable"
|+Best practice fields
!UMS
!TimeEdit
|-
|MobilePhone
|general.phone
|-
|WorkMail
|general.email
|}
 
=====Example=====
[[File:Map metadatafields Employees.png|none|thumb|915x915px]]
<br />
===Activity===
TimeEdit's extid for this object type is "studentclass.<Aktivitet>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
|-
|Aktivitet
|studentclass.code
|-
|Aktivitet
|studentclass.name
|-
|Aktivitet
|studentclass.no_of_students
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|ActivityDescription
|studentclass.longdescript
|Long description
|-
|Kort_Betegnelse
|studentclass.shortname
|Short description
|}<br />
 
=====Example=====
[[File:Map metadatafields Activity.png|none|thumb|915x915px]]
<br />
 
===Courses===
TimeEdit's extid for this object type is "course.<Aktivitet>_<Skolefag>"
{| class="wikitable"
|+Predefined fields
!UMS
!TimeEdit
|-
|Aktivitet_Skolefag
|course.code
|-
|Aktivitet_Skolefag
|course.name
|}
{| class="wikitable"
|+Required fields
!UMS
!TimeEdit
!Description
|-
|SkoleFag_Kort_Betegnelse
|course.shortname
|Short description
|-
|SkoleFag_betegnelse
|course.LongDescript
|Long description
|}
 
=====Example=====


==Configure Modules > Timetable >Datasource==
==Configure Modules > Timetable >Datasource==
Line 274: Line 100:
==FAQ==
==FAQ==


=== Missing subject / title ===
===Missing subject / title===
Titles in timetable are based on ActivityDescription in UMS (TimeEdit key: studentclass.longdecript).
Titles in timetable are based on ActivityDescription in UMS (TimeEdit key: studentclass.longdecript).


Revision as of 08:18, 19 February 2020

Prerequisites

Module requirements

  • UMS
  • TimeEdit account

Create TimeEdit settings on templates

Edit a template and apply settings for TimeEdit in order to send data from UMS to TimeEdit

Upload of courses fails if no courses are imported on GetStudents. Verify this with SQL

select distinct Skolefag from ImportFromDB


Description

Enter a name for this setting.

Upload courses

Upload courses from UMS to TimeEdit. This is courses as defined by UMS

Activities/groups upload can not be disabled.

TimeEdit Server connection

All connection information is provided by TimeEdit support.

All information is specific to a customer.

URL (Endpoint)

This URL specifies the endpoint that UMS connects to.

Certificate path

Then XML file you receive from TimeEdit. The certificate must be issued to your school, else you will get this error

Username

Username to access the Webservice URL.

Password

Password to access the Webservice URL.

Employee mail domain

This will be appended to the username to complete a mail address that TimeEdit can use.Example: @inlogic.dk

Students mail domain

This will be appended to the username to complete a mail address that TimeEdit can use. Example: @inlogic.dk

If students are using private mails then leave the field blank and configure metadata where you map general.email with UMS field PrivateMail


Exclude students from classes

Username entered here will prevent them from being member of any activities.

Users will still be uploaded to TimeEdit.

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

Configure Modules > Timetable >Datasource

Create a new datasource in order to get timetable blocks in return from TimeEdit

FAQ

Missing subject / title

Titles in timetable are based on ActivityDescription in UMS (TimeEdit key: studentclass.longdecript).

If bookings are not bound to activities then fill out the comments field in TimeEdit. The Comment field is also displayed on the body text of the booking.


There is no field with ext.id "person.first_name" , "general.email" etc

The missing fields must be configured in the TimeEdit database. You can do this either by making a supportrequest to TimeEdit or download a an administrative tool from TimeEdit, please contact TimeEdit for further information.

How can I test a TimeEdit certificate ?

Download the SoapUI tool and send a soap register-request as shown in the screenshot. If the certificate is registreret correctly at TimeEdit the response will be the key used for 2 factor authentication.

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