Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Sync LePo db with OneRoster API for Term, Course, CourseMember and User #151

Open
kyoshizaki opened this issue Nov 8, 2018 · 3 comments
Open

Sync LePo db with OneRoster API for Term, Course, CourseMember and User #151

kyoshizaki opened this issue Nov 8, 2018 · 3 comments
Assignees
@kyoshizaki
Milestone
v0.3

Comments

@kyoshizaki
Copy link
Member

kyoshizaki commented Nov 8, 2018 •
edited
Loading

Issue

  • Course.status is NOT related to term duration.
    • Term.end_at and Term.start_at are NOT used in LePo
  • Existing courses are always visible even though corresponding data is deleted from OneRoster data
  • Existing course members are always visible even though corresponding data is deleted from OneRoster data

Current status: before v0.3.1

Possible activities for each Course.status

draft

manager assistant learner
Show course YES YES NO
Show lesson YES YES NO
Show member YES YES NO
Create sticky YES YES NO
Create highlight YES YES NO
Create notice YES YES ---
Create worksheet YES YES ---
Create member YES YES ---
Edit course YES YES ---

open

manager assistant learner
Show course YES YES YES
Show lesson YES YES YES
Show member YES YES YES
Submit assignment --- --- YES
Evaluate assignment YES --- ---
Create sticky YES YES YES
Create highlight YES YES YES
Create notice YES YES ---
Create worksheet YES YES ---
Create member YES YES ---
Edit course YES YES ---

archived

manager assistant learner
Show course YES YES YES
Show lesson YES YES YES
Show member YES YES YES
Submit assignment --- --- YES
Evaluate assignment YES --- ---
Create sticky YES YES YES
Create highlight YES YES YES
Create notice YES YES ---
Create worksheet NO NO ---
Create member NO NO ---
Edit course YES YES ---

Course.status setting procedure

  • system admin / system manager
  • course manager / course assistant

CRUD processing in data synchronization with OneRoster API

  • Sync to course existence by daily job
  • Course: Create and Update
  • CourseMember: Create and Update
@kyoshizaki kyoshizaki self-assigned this Nov 8, 2018
kyoshizaki added a commit that referenced this issue Nov 9, 2018
@kyoshizaki
🔧 Fix to create work_sheet by course assistant, #151
a95d636
kyoshizaki added a commit that referenced this issue Nov 9, 2018
@kyoshizaki
✨ Sync course & course_members to OneRoster data, #151
cda7f54
@kyoshizaki kyoshizaki mentioned this issue Nov 9, 2018
Merged
@kyoshizaki kyoshizaki added this to the v0.3 milestone Nov 10, 2018
This was referenced Nov 10, 2018
Closed
Closed
@kyoshizaki kyoshizaki changed the title Sync course status to OneRoster data Sync course and enrollment data to OneRoster Nov 10, 2018
@kyoshizaki
Copy link
Member Author

kyoshizaki commented Nov 10, 2018 •
edited
Loading

Implementation

Possible activities for each Course.status

  • same as the current status

Course.status setting procedure

  • Sync to term period by daily job (TermJob)
    • Course must belong to a term
    • set status "draft": current time is before Term.startDate
    • set status "open": current time is after Term.startDate and before Term.endDate
    • set status "archived": current time is after Term.endDate

CRUD processing in data synchronization with OneRoster API

  • Sync to course existence by daily job
  • Course: Create, Update and Logical delete
    • records in OneRoster data: bulk update with "true" for enabled column
    • records deleted from OneRoster data: set "false" for enabled column
  • CourseMember: Create and Update
    • records in OneRoster data: bulk update
    • records deleted from OneRoster data: delete from LePo db

CRUD processing by user from UI

  • when SYSTEM_ROSTER_SYNC is "on"
    • Create: post data to API server and reflect it to DB
    • Read: from DB
    • Update / Delete
      • Resources synchronized with API server: put/delete data to API server and reflect it to DB
      • Resources NOT synchronized with API server (old data): Not permitted (Keep on DB as it is)
  • when SYSTEM_ROSTER_SYNC is "suspended"
    • Create: temporarily not permitted
    • Read: from DB
    • Update / Delete: temporarily not permitted
  • when SYSTEM_ROSTER_SYNC is "off"
    • CRUD: with DB
      • operable only for no sourced_id resource?

Considerations

  • When making Roster API use micro-service in LePo, disable "off" status?
  • State "off" is restricted to be usable only in the development environment?
  • Whether resource owner is SIS or API client

kyoshizaki added a commit that referenced this issue Nov 15, 2018
@kyoshizaki
✨ Sync Course.status to Term duration, #151
ab2e8ac
kyoshizaki added a commit that referenced this issue Nov 15, 2018
@kyoshizaki
🔧 Fix bugs in Sync Course.status to Term duration, #151
97d203c 
- To set course.status correctly according to term
  - introduce TermJob
  - automatically set course.status when creating and updating course
@kyoshizaki kyoshizaki changed the title Sync course and enrollment data to OneRoster Sync LePo db with OneRoster API for Term, Course, CourseMember and User Nov 17, 2018
kyoshizaki added a commit that referenced this issue Nov 17, 2018
@kyoshizaki
✨ Sync Term data to API server by POST/PUT/DELETE method, #151
6517268 
- Request to original API with HTTP POST/PUT/DELETE method for Term resource
kyoshizaki added a commit that referenced this issue Nov 24, 2018
@kyoshizaki
🔧 Fix CRUD conditions for term, #151
1736259
kyoshizaki added a commit that referenced this issue Nov 25, 2018
@kyoshizaki
✨ Sync Course data to API server by POST/PUT/DELETE method, #151
d135525 
- Request to original API with HTTP POST/PUT/DELETE method for Course resource
kyoshizaki added a commit that referenced this issue Nov 26, 2018
@kyoshizaki
🔧 Sync Course managers to API server when creating course, #151
789b8ab 
    - Request to original API with HTTP POST/PUT/DELETE method for Course resource
kyoshizaki added a commit that referenced this issue Nov 29, 2018
@kyoshizaki
🔧 Fix course update bug with Roster API, #151
dcb016d 
- Don't sync course resource if there is no change in the column being synchronized
kyoshizaki added a commit that referenced this issue May 3, 2019
@kyoshizaki
✨ Sync Enrollment data to API server by POST/PUT/DELETE method, #151
1f943f6 
- Request to original API with HTTP POST/PUT/DELETE method for Enrollment resource
- Add sourced_id to Enrollment
@kyoshizaki
Copy link
Member Author

kyoshizaki commented Apr 3, 2021 •
edited
Loading

  • Issue: Sync users with both LDAP and local authentication types
  • Solution: Save authentication as "local " and hashed password from user.password of OneRoster data

kyoshizaki added a commit that referenced this issue Apr 3, 2021
@kyoshizaki
✨ Sync local authentification user with OneRoster API, #151
46c9de3 
Save authentication as "local " and hashed password from user.password
of OneRoster data
@kyoshizaki
Copy link
Member Author

  • Use offset and limit parameters when calling to OneRoster API

kyoshizaki added a commit that referenced this issue Apr 8, 2021
@kyoshizaki
🔧 Add offset and limit when calling OneRoster API, #151
6acf4bb 
Also sync_courses parameter was implemented to limit the course to import
kyoshizaki added a commit that referenced this issue Apr 8, 2021
@kyoshizaki
🔧 Fix default time interval to sync OneRoster API, #151
9e09559
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@kyoshizaki kyoshizaki

Labels
None yet
Projects
None yet
Milestone
v0.3
Development

No branches or pull requests
1 participant
@kyoshizaki