Timetable: Difference between revisions
No edit summary |
No edit summary |
||
| Line 4: | Line 4: | ||
The following systems is supported | The following systems is supported | ||
* Office 365 | *Office 365 | ||
* Exchange | *Exchange | ||
* GSuite | *GSuite | ||
<br /> | <br /> | ||
=== Usage === | ===Usage=== | ||
Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]] | Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]] | ||
== Parameters == | ==Parameters== | ||
== Get started with itslearning == | ==Get started with itslearning== | ||
=== | ===Requirements=== | ||
* A Timetable user - this user holds all events | *A Timetable user - this user holds all events | ||
* Access to Organisation API at itslearning | *Access to Organisation API at itslearning | ||
* Valid itslearning sync from inLogic | *Valid itslearning sync from inLogic | ||
=== Create Timetable user === | ===Create Timetable user=== | ||
For the purpose of syncing the timetable to itslearning, we need a UMSTimetableUser. The synckey for user object has to be the same as the username, UMSTimetableUser. | For the purpose of syncing the timetable to itslearning, we need a UMSTimetableUser. The synckey for user object has to be the same as the username, UMSTimetableUser. | ||
=== Access to Organisation API === | ===Access to Organisation API=== | ||
To get access to this API, you'll need to contact your local itslearning Services Team. | To get access to this API, you'll need to contact your local itslearning Services Team. | ||
See [https://developer.itslearning.com/Organisation_API.html#3801600 this] for more information | See [https://developer.itslearning.com/Organisation_API.html#3801600 this] for more information | ||
=== Valid itslearning sync from inLogic === | ===Valid itslearning sync from inLogic=== | ||
A valid sync of the users from UMS to itslearning is needed - this ensures our timetable information is matched correctly with student, activities and course information. | A valid sync of the users from UMS to itslearning is needed - this ensures our timetable information is matched correctly with student, activities and course information. | ||
Revision as of 13:49, 9 May 2019
Skemabrikker.exe is a small sync job that needs to run when timetables has to be created, updated or deleted.
The following systems is supported
- Office 365
- Exchange
- GSuite
Usage
Skemabrikker.exe [<optional> System] [<optional> Action] [<optional> StartDate] [<optional> EndDate] [<optional> Type [UMS | NonUMS | All]]
Parameters
Get started with itslearning
Requirements
- A Timetable user - this user holds all events
- Access to Organisation API at itslearning
- Valid itslearning sync from inLogic
Create Timetable user
For the purpose of syncing the timetable to itslearning, we need a UMSTimetableUser. The synckey for user object has to be the same as the username, UMSTimetableUser.
Access to Organisation API
To get access to this API, you'll need to contact your local itslearning Services Team.
See this for more information
Valid itslearning sync from inLogic
A valid sync of the users from UMS to itslearning is needed - this ensures our timetable information is matched correctly with student, activities and course information.
FAQ
To find all timetables generated by UMS for a user or for ie. every student use the following parameters with the skemabrikker.exe command.
Skemabrikker.exe office365 find <mail> <StartDate> <EndDate> [UMS | NonUMS | All]
By default the UMS parameter is selected, since there is generally no need to affect and look for items that wasn't generated by UMS. Instead of the <mail> parameter you can use AllTimeTableEmployees and AllTimeTableStudents to select either employees or students respectively.
To delete all timetables generated by UMS for a user or for ie. every student use the following parameters with the skemabrikker.exe command.
Skemabrikker.exe office365 delete <mail> <StartDate> <EndDate> [UMS | NonUMS | All]
By default the UMS parameter is selected, since there is generally no need to affect and look for items that wasn't generated by UMS. Instead of the <mail> parameter you can use AllTimeTableEmployees and AllTimeTableStudents to select either employees or students respectively.
It is not recommended to run the office365 delete parameter with the All parameter since it will delete everything in the affected users calender's in the given time frame.