The document discusses diagnosing and repairing user and course issues using APIs, emphasizing the importance of data source keys and row statuses. It also addresses the limitations of current APIs for complex tasks, suggesting direct database queries may be more effective for certain tasks like enrollment problems. The presentation concludes with insights on managing snapshot rules and improving access to portal roles.

1. Diagnosing account, enrolment and snapshot problems using the APIsDr Malcolm MurrayDurham UniversityPhoto by Terry Bain: http://www.flickr.com/photos/axis/2897335784/

2. Conference Blurb…I've designed custom user and course tools to help diagnose and repair problems with user feeds and snapshotted enrolments. I'll demonstrate how you can use APIs to access fields not exposed in the UI. I'll also discuss times when directly querying the database is still the best thing to do (i.e. when there aren't comprehensive enough classes to use). I'll conclude with a discussion of managing access by portal role.

3. 1Modelling UsersLooking at the APIs and peeking under the covers into the database

4. bb-platform.jarModels common objects seen in the UIblackboard.data.user.Userblackboard.data.role.PortalRoleblackboard.data.course.Courseblackboard.data.course.CourseMembershipblackboard.data.course.CourseMembership$Roleetcetera

5. bb-platform.jarblackboard.data.user.User

6. bb-platform.jarblackboard.data.user.User

7. bb-platform.jarblackboard.data.user.UsergetBatchUid() String

8. getDataSourceId() String

9. getIsAvailable()boolean

10. getUserName() String

11. getId() Idbb-platform.jarblackboard.data.user.UsergetBatchUid() String

12. getDataSourceId() String

13. getIsAvailable() boolean

14. getUserName() String

15. getId() IdTwo unique fields! UserName & BatchUid

16. bb-platform.jarblackboard.data.user.UsergetBatchUid() String

17. getDataSourceId() String

18. getIsAvailable() boolean

19. getUserName() String

20. getId() Id2SnapshotNothing more than a quick overviewRTFM for more information 

21. SnapshotMaking sense of complicated dataUsersPortal RolesCoursesCourse RolesQuota

22. SnapshotReality: multiple sources, frequently changingCourses: TimetablingRoles: LDAPRoles: Student Record SystemUsers: Student Record SystemCourses: Student Record SystemUsers: HR SystemRoles: HR System

23. Managing SnapshotPreparation, Preparation, PreparationQuota feedCourse feedUser feedEnrol feedRole feed

24. SnapshotSimplified scenarios – snapshotting UsersUsers are only ever blocked, not removedSNAPSHOT 2SNAPSHOT 1

25. 3Data Source KeysMean nothing to you?Stay awake through this bit then

26. Data Source KeysOwnership: Makes Snapshot workblackboard.data.user.UsergetBatchUid() String

27. getDataSourceId() String

28. getIsAvailable() boolean

29. getUserName() String

30. getId() IdUsers created using the UI are given a Data Source Key of SYSTEMSnapshot runs with a different DSK and controls the ROW_STATUS field of all Users with this DSK

31. Data Source Keysblackboard.data.datasource.DataSourcegetModifiedDate() Calendar

32. getId() Id

33. RowStatus not exposed

34. getBatchUid() String

35. getDescription() StringRow StatusControlling accessROW_STATUS = 0 normal accessROW_STATUS = 2 no access (blocked)So where can you see this?

36. 4And then there were Two...Working with multiple JAR filesuntil these are finally merged in a future API release

37. Enter bb-cms-admin.jarMany of the classes seen in bb-platform.jarblackboard.data.user.Userblackboard.data.role.PortalRoleblackboard.data.course.Courseblackboard.data.course.CourseMembershipblackboard.data.course.CourseMembership$Roleare extended by classes in bb-cms-admin.jarblackboard.admin.data.user.Person

38. blackboard.admin.data.role.PortalRoleMembership

39. blackboard.admin.data.course.CourseSite

40. blackboard.admin.data.course.Membership

41. blackboard.admin.data.course.Enrollment

42. blackboard.admin.data.course.StaffAssignmentbb-cms-admin.jarblackboard.admin.data.user.PersongetRowStatus() would be here

43. Loaders & Persistersblackboard.persist.user.UserDbLoader – many optionsBut...UserDbLoader will only load User objects where the underlying USERS database table entry has ROW_STATUS = 0

44. Loaders & Persistersblackboard.admin.persist.user.PersonLoaderPersonLoader loads any entry

45. Loading Persons by TemplateSELECT * FROM BB_BB60.USERS WHERE AVAILABLE_IND = ‘N' AND LASTNAME = 'Smith' AND ROW_STATUS = 2;

46. 5Applying this knowledgeAccount Problems – “I can’t log in...”

47. ACCESS?Diagnosis requirements – User AccountUserAvailabilityUser.getIsAvailable() or Person.getIsAvailable()Row StatusPerson.getRowStatus()Data Source KeyTwo parts:Person.getDataSourceBatchUid() - may be enoughUser only exposes getDataSourceId()blackboard.admin.persist.datasource.DataSourceLoader. loadByBatchUid() no loadById() methodblackboard.admin.data.datasource.DataSource.getDescription()OWNER?

48. Model of the ProcessNot Rocket Science...Entry Point:ModuleUsername Known?NOSearch ToolYESIdentify UserDisplay InformationFix Problem

49. Implementation