Grouper 2.0+ has point in time auditing. The feature is enabled automatically when upgrading. The general design is to keep separate tables for many of the regular Grouper database tables that contain start and end times associated with each row. This allows us to perform efficient queries to find out the state of the data at any point in time or range.
The point in time tables are populated by the change log processor that runs every minute (by default) by the Grouper loader. The point in time tables are also used for flattened notifications of memberships, privileges, and permissions.
If you need just an audit log of high level user actions, you may want to know about User Auditing.
So with point in time, you can do the following queries at a single time in the past or a date range.
- Determine if a person was a member of a group.
- Get all the members of a group.
- Find out what groups a person was a member.
- Find what permissions a person had.
- Get all the attributes assigned to an object (group, etc).
- Get the values that an attribute had.
The following Grouper Web Services support point in time queries.
- Get Members
- hasMember
- getGroups
- getPermissionAssignments
If you have old objects in your point in time data that you don't want anymore, you can delete them using GSH. See edu.internet2.middleware.grouper.pit.PITUtils for various options for deleting old data. Note that point in time data can only be deleted after the actual objects have been deleted and those deletions have been processed by the changeLogTempToChangeLog job, which runs once a minute by default with the Grouper Daemon.
gsh 0% // delete objects that ended before a given date
gsh 0% edu.internet2.middleware.grouper.pit.PITUtils.deleteInactiveRecords(new Date(), true);
gsh 1%
gsh 2% // delete objects that have ended below a given stem
gsh 2% edu.internet2.middleware.grouper.pit.PITUtils.deleteInactiveObjectsInStem("test", true)
If your need to sync your point in time data, you can run the following to make sure all of the objects currently active in Grouper are marked as active in point in time. It's probably a good idea to turn off the Grouper Daemon when you run this.
gsh 0% new edu.internet2.middleware.grouper.misc.SyncPITTables().syncAllPITTables() Searching for missing active point in time fields Found 0 missing active point in time fields Searching for missing active point in time members Found 0 missing active point in time members Searching for missing active point in time stems Found 0 missing active point in time stems Searching for missing active point in time groups Found 0 missing active point in time groups Searching for missing active point in time role sets Found 0 missing active point in time role sets Searching for missing active point in time attribute defs Found 0 missing active point in time attribute defs Searching for missing active point in time attribute def names Found 0 missing active point in time attribute def names Searching for missing active point in time attribute def name sets Found 0 missing active point in time attribute def name sets Searching for missing active point in time actions Found 0 missing active point in time actions Searching for missing active point in time action sets Found 0 missing active point in time action sets Searching for missing active point in time group sets Found 0 missing active point in time group sets Searching for missing active point in time memberships Found 0 missing active point in time memberships Searching for missing active point in time attribute assigns Found 0 missing active point in time attribute assigns Searching for missing active point in time attribute assign values Found 0 missing active point in time attribute assign values Searching for point in time attribute assign values that should be inactive Found 0 active point in time attribute assign values that should be inactive Searching for point in time attribute assigns that should be inactive Found 0 active point in time attribute assigns that should be inactive Searching for point in time memberships that should be inactive Found 0 active point in time memberships that should be inactive Searching for point in time group sets that should be inactive Found 0 active point in time group sets that should be inactive Searching for point in time action sets that should be inactive Found 0 active point in time action sets that should be inactive Searching for point in time actions that should be inactive Found 0 active point in time actions that should be inactive Searching for point in time attribute def name sets that should be inactive Found 0 active point in time attribute def name sets that should be inactive Searching for point in time attribute def names that should be inactive Found 0 active point in time attribute def names that should be inactive Searching for point in time attribute defs that should be inactive Found 0 active point in time attribute defs that should be inactive Searching for point in time role sets that should be inactive Found 0 active point in time role sets that should be inactive Searching for point in time groups that should be inactive Found 0 active point in time groups that should be inactive Searching for point in time stems that should be inactive Found 0 active point in time stems that should be inactive Searching for point in time members that should be inactive Found 0 active point in time members that should be inactive Searching for point in time fields that should be inactive Found 0 active point in time fields that should be inactive java.lang.Long: 0 gsh 1%
Example query
Find where org groups are used outside of the org folder from a day a few days ago (day is hard-coded)
select GPG.NAME, GPF.NAME, GPG_MEMBER.NAME, GPMAV.MEMBERSHIP_START_TIME, gpmav.membership_end_time from grouper_pit_groups gpg_member, GROUPER_PIT_MEMBERSHIPS_ALL_V gpmav, grouper_pit_members gpm, grouper_pit_fields gpf, grouper_pit_groups gpg where GPMAV.MEMBER_ID = GPM.ID and GPM.subject_source = 'g:gsa' and GPM.SUBJECT_ID = GPG_MEMBER.source_ID and GPG_member.NAME like 'penn:community:employee:org%' and GPMAV.OWNER_GROUP_ID = GPG.ID and GPG.NAME not like 'penn:community:employee%' and GPMAV.FIELD_ID = GPF.ID and (GPMAV.MEMBERSHIP_START_TIME is null or GPMAV.MEMBERSHIP_START_TIME < 1364270400000000) and (gpmav.membership_end_time is null or gpmav.membership_end_time > 1364270400000000 )
Find subjects in a group from a certain day, excluding some
select GPG.NAME, GPF.NAME, GPM.SUBJECT_ID
from
GROUPER_PIT_MEMBERSHIPS_ALL_V gpmav,
grouper_pit_fields gpf,
grouper_pit_groups gpg,
grouper_pit_members gpm
where
GPM.subject_source != 'g:gsa'
and GPMAV.MEMBER_ID = GPM.ID
and GPM.SUBJECT_ID not in ('10094590', '10037375', '10033223')
and GPG.NAME like 'penn:community:employee:org:TOPU%'
and gpg.name not like '%_rolluporg_systemOfRecordAndIncludes'
and gpg.name not like '%systemOfRecord'
and gpg.name not like '%_personorg'
and gpg.name not like '%_rolluporg'
and GPMAV.OWNER_GROUP_ID = GPG.ID
and GPMAV.FIELD_ID = GPF.ID
and (GPMAV.MEMBERSHIP_START_TIME is null or GPMAV.MEMBERSHIP_START_TIME < 1364270400000000)
and (gpmav.membership_end_time is null or gpmav.membership_end_time > 1364270400000000 )
;
sfd