Difference between revisions of "Timetable"

From UmsWiki
Jump to: navigation, search
m
(Systems)
 
(15 intermediate revisions by 4 users not shown)
Line 1: Line 1:
Skemabrikker.exe is a small sync job that needs to run when timetables are created, updated or deleted.
+
Skemabrikker.exe is a small sync job that needs to run when timetables are created, updated, or deleted.
  
 
Example of timetable in UMS and Outlook:
 
Example of timetable in UMS and Outlook:
Line 16: Line 16:
 
  Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> Mail] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]]
 
  Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> Mail] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]]
  
=====Help=====
+
====Applyrights====
Displays Microsoft forms with the different parameters.<br />
 
 
 
=====Applyrights=====
 
 
Only works for Exchange and Office365. Restores rights for a room if they have accidentally been deleted or changed.<br />
 
Only works for Exchange and Office365. Restores rights for a room if they have accidentally been deleted or changed.<br />
  
=====Systems=====
+
====Systems====
 
This parameter is used to define what system Skemabrikker.exe will populate the timetables to. We currently support timetable integration to these systems:
 
This parameter is used to define what system Skemabrikker.exe will populate the timetables to. We currently support timetable integration to these systems:
  
 
Exchange
 
Exchange
  
Office 365
+
Office365
  
GSuite
+
GoogleApps
  
 
[[Timetable/itslearning|Itslearning]]<br />
 
[[Timetable/itslearning|Itslearning]]<br />
  
=====Action=====
+
=====Teachersonly=====
find - Used to display the timetables associated with the given [mail] parameter.
+
This parameter is used if the [action] parameter needs to affect only teachers.
 +
 
 +
=====Studentsonly=====
 +
This parameter is used if the [action] parameter needs to affect only students.
 +
 
 +
=====Roomsonly=====
 +
This parameter is used if the [action] parameter needs to affect only a given physical Classroom (When this parameter is used you need to add the ID for the given room ie. [Action] [Mail] 'Room_ID').
 +
 
 +
=====Activitiesonly=====
 +
This parameter is used if the [action] parameter needs to only affect a given activity (When this parameter is used you need to add the ID for the given activity ie. [Action] [Mail] 'Activity_ID').
 +
 
 +
=====Coursesonly=====
 +
This parameter is used if the [action] parameter needs to only affect a given course (When this parameter is used you need to add the ID for the given course ie. [Action] [Mail] 'Activity_ID_Course_ID').
 +
 
 +
====Action====
 +
 
 +
=====find=====
 +
Used to display the timetables associated with the given [mail] parameter.
 +
 
 +
=====delete=====
 +
Used to delete the timetables associated with the given [mail] parameter.
 +
 
 +
=====update=====
 +
Used to update the timetables that needs to be updated and are associated with the given [mail] parameter.
 +
 
 +
=====cleanup=====
 +
Used to find UMS appointments in users calendars and delete them if they are not found in UMS database.
 +
 
 +
====Mail====
 +
 
 +
=====mail/UPN=====
 +
This parameter is used if the [action] parameter needs to affect a specific user.
  
delete - Used to delete the timetables associated with the given [mail] parameter.
+
=====AllTimeTableStudents=====
 +
This will delete timetable blocks from all known students
  
update - Used to update the timetables that needs to be updated and are associated with the given [mail] parameter.<br />
+
'''Works with'''
  
=====Mail=====
+
Office 365
mail/UPN - This parameter is used if the [action] parameter needs to affect a specific user.
 
  
Teachersonly - This parameter used if the [action] parameter needs to only affect teachers.
+
Exchange
  
Studentsonly - This parameter used if the [action] parameter needs to only affect students.
+
=====AllTimeTableEmployees=====
 +
This will delete timetable blocks from all known employees
  
Roomsonly - This parameter is used if the [action] parameter needs to only affect a given physical Classroom (When this parameter is used you need to add the ID for the given room ie. [Action] [Mail] 'Room_ID').
+
'''Works with'''
  
Activitiesonly - This parameter is used if the [action] parameter needs to only affect a given activity (When this parameter is used you need to add the ID for the given activity ie. [Action] [Mail] 'Activity_ID').<br />
+
Office 365
  
=====StartDate=====
+
Exchange
This parameter is used in to define the start date in which the find, delete or update parameter will affect the timetables. The format for this parameter is dd-mm-yyyy.<br />
 
  
=====EndDate=====
+
=====AllTimeTableRooms=====
This parameter is used in to define the end date in which the find, delete or update parameter will affect the timetables The format for this parameter is dd-mm-yyyy.<br />
 
  
=====Type=====
+
This will delete timetable blocks from all known rooms.
UMS - This parameter is used to define that the timetables has to have been generated by UMS will be affected.
 
  
NonUMS - This parameter is used to define that the timetables has to have not been generated by UMS will be affected.
+
'''Works with'''
  
All - This parameter is used to define that timetables both from UMS and non UMS will be affected.<br />
+
Office 365
 +
 
 +
====StartDate====
 +
This parameter is used to define the start date in which the find, delete, or update parameter will affect the timetables. The format for this parameter is dd-mm-yyyy.
 +
 
 +
====EndDate====
 +
This parameter is used to define the end date in which the find, delete, or update parameter will affect the timetables The format for this parameter is dd-mm-yyyy.<br />
 +
 
 +
====Type====
 +
UMS - This parameter is used to define that the timetables that have been generated by UMS, will be effected.
 +
 
 +
NonUMS - This parameter is used to define that the timetables that have not been generated by UMS, will be effected.
 +
 
 +
All - This parameter is used to define that timetables both from UMS and non UMS, will be effected.<br />
  
 
==External systems==
 
==External systems==
Line 79: Line 118:
 
|skemabrikker.exe  office365 find tea@umsacademic.onmicrosoft.com 12-05-2019 13-05-2019 All
 
|skemabrikker.exe  office365 find tea@umsacademic.onmicrosoft.com 12-05-2019 13-05-2019 All
 
|}
 
|}
Inspect the skemabrikker.log. The long string value in the logfile refers to the ID in the table '''SkemaBrikkerSavedEntries_Students, SkemaBrikkerSavedEntries_Teachers, SkemaBrikkerSavedEntries_Rooms, SkemaBrikkerSavedEntries_Activities'''
+
Inspect the skemabrikker.log. The long string value in the log file refers to the ID in the table '''SkemaBrikkerSavedEntries_Students, SkemaBrikkerSavedEntries_Teachers, SkemaBrikkerSavedEntries_Rooms, SkemaBrikkerSavedEntries_Activities'''.
 
[[File:Skemabrikkerlog.png|none|thumb|864x864px]]
 
[[File:Skemabrikkerlog.png|none|thumb|864x864px]]
  
====How do I find timetable blocks with SQL statements ?====
+
====How do I find timetable blocks with SQL statements?====
 
{| class="wikitable"
 
{| class="wikitable"
|select SkemaBrikkerNewEntries.*
+
|Select SkemaBrikkerNewEntries.*
  
 
From  SkemaBrikkerNewEntries
 
From  SkemaBrikkerNewEntries
Line 107: Line 146:
 
[[File:Timetable format and content.png|none|thumb|1152x1152px]]
 
[[File:Timetable format and content.png|none|thumb|1152x1152px]]
 
<br />
 
<br />
 +
 +
===Run only for one user===
 +
 +
====Students====
 +
Skemabrikker.exe studentsonly <username>
 +
 +
====Teachers====
 +
Skemabrikker.exe teachersonly <username><br />

Latest revision as of 13:45, 7 September 2021

Skemabrikker.exe is a small sync job that needs to run when timetables are created, updated, or deleted.

Example of timetable in UMS and Outlook:

Timetable in UMS and Outlook.png


The following systems are supported:

  • Office 365
  • Exchange
  • GSuite

Parameters

Usage

Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> Mail] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]]

Applyrights

Only works for Exchange and Office365. Restores rights for a room if they have accidentally been deleted or changed.

Systems

This parameter is used to define what system Skemabrikker.exe will populate the timetables to. We currently support timetable integration to these systems:

Exchange

Office365

GoogleApps

Itslearning

Teachersonly

This parameter is used if the [action] parameter needs to affect only teachers.

Studentsonly

This parameter is used if the [action] parameter needs to affect only students.

Roomsonly

This parameter is used if the [action] parameter needs to affect only a given physical Classroom (When this parameter is used you need to add the ID for the given room ie. [Action] [Mail] 'Room_ID').

Activitiesonly

This parameter is used if the [action] parameter needs to only affect a given activity (When this parameter is used you need to add the ID for the given activity ie. [Action] [Mail] 'Activity_ID').

Coursesonly

This parameter is used if the [action] parameter needs to only affect a given course (When this parameter is used you need to add the ID for the given course ie. [Action] [Mail] 'Activity_ID_Course_ID').

Action

find

Used to display the timetables associated with the given [mail] parameter.

delete

Used to delete the timetables associated with the given [mail] parameter.

update

Used to update the timetables that needs to be updated and are associated with the given [mail] parameter.

cleanup

Used to find UMS appointments in users calendars and delete them if they are not found in UMS database.

Mail

mail/UPN

This parameter is used if the [action] parameter needs to affect a specific user.

AllTimeTableStudents

This will delete timetable blocks from all known students

Works with

Office 365

Exchange

AllTimeTableEmployees

This will delete timetable blocks from all known employees

Works with

Office 365

Exchange

AllTimeTableRooms

This will delete timetable blocks from all known rooms.

Works with

Office 365

StartDate

This parameter is used to define the start date in which the find, delete, or update parameter will affect the timetables. The format for this parameter is dd-mm-yyyy.

EndDate

This parameter is used to define the end date in which the find, delete, or update parameter will affect the timetables The format for this parameter is dd-mm-yyyy.

Type

UMS - This parameter is used to define that the timetables that have been generated by UMS, will be effected.

NonUMS - This parameter is used to define that the timetables that have not been generated by UMS, will be effected.

All - This parameter is used to define that timetables both from UMS and non UMS, will be effected.

External systems

itslearning

Office 365

Google GSuite

FAQ

How do I find timetable blocks with skemabrikker.exe ?

Example following the general parameters:

skemabrikker.exe office365 find tea@umsacademic.onmicrosoft.com 12-05-2019 13-05-2019 All

Inspect the skemabrikker.log. The long string value in the log file refers to the ID in the table SkemaBrikkerSavedEntries_Students, SkemaBrikkerSavedEntries_Teachers, SkemaBrikkerSavedEntries_Rooms, SkemaBrikkerSavedEntries_Activities.

Skemabrikkerlog.png

How do I find timetable blocks with SQL statements?

Select SkemaBrikkerNewEntries.*

From SkemaBrikkerNewEntries

Join SkemaBrikker_Students On SkemaBrikkerNewEntries.SkemaBegivenhed_ID = SkemaBrikker_Students.SkemaBegivenhed_ID And SkemaBrikkerNewEntries.SkemaBrikkerAdminServers_ID = SkemaBrikker_Students.SkemaBrikkerAdminServers_ID

And SkemaBrikkerNewEntries.Activity = SkemaBrikker_Students.Activity

Where

SkemaBrikker_Students.cpr In (Select Cpr from Students where studienr= 'xxxxxx')

and SkemaBrikkerNewEntries.Dato = '28-11-2018'

Order By RealStartDateTime

How do I change format and content of timetable blocks in Outlook?

Open UMS Configurator, select Modules "TimeTable" and select your datasource, then edit Format And Content

Variables can be replaced as pictured below.

Timetable format and content.png


Run only for one user

Students

Skemabrikker.exe studentsonly <username>

Teachers

Skemabrikker.exe teachersonly <username>