LogoutSchedules
The LogoutSchedules table stores the configuration of scheduled logouts. This table contains all active and historical logout schedules created by administrators, including one-time, daily, and weekly schedules.
Columns
| Column Name | Column Type | Description |
|---|---|---|
Date | String | The date on which the schedule was created or updated. This is the partitioning column. |
Id | String | A unique identifier for the logout schedule. |
GroupName | String | The name of the user or group associated with this schedule. |
UpdateTime | DateTime | The timestamp when the schedule was last created or modified. |
Schedule | String | The schedule type. Possible values are Once, Daily, or Weekly. |
ScheduleDate | String | For Once schedules, the specific date when the logout should occur. Not meaningful for recurring schedules. |
Time | String | The time of day when the logout should occur, in HH:mm format. |
Timezone | String | The timezone for the scheduled time. |
Days | byte | For Weekly schedules, a bit field byte indicating which days the schedule is active. See Days bit field below. |
Immediate | boolean | Whether the logout is immediate (true) or scheduled (false). |
Kick | boolean | Whether the user is forcibly disconnected (true) or given a warning with the option to ignore (false). |
Event | String | The event type for this record. Values include created, updated, or deleted. |
Message | String | The message displayed to users after they are logged out. |
Schedule types
The Schedule column contains one of the following values:
| Schedule | Description |
|---|---|
Once | A one-time logout that occurs at a specific date and time. |
Daily | A recurring logout that occurs at the same time every day. |
Weekly | A recurring logout that occurs at the same time on specific days of the week. |
Days bit field
For Weekly schedules, the Days column contains a bit field byte where each bit represents a day of the week:
| Bit Position | Value | Day |
|---|---|---|
| 0 | 1 | Sunday |
| 1 | 2 | Monday |
| 2 | 4 | Tuesday |
| 3 | 8 | Wednesday |
| 4 | 16 | Thursday |
| 5 | 32 | Friday |
| 6 | 64 | Saturday |
Multiple days are represented by summing the corresponding values. For example:
62= Every weekday (2 + 4 + 8 + 16 + 32)127= Every day (1 + 2 + 4 + 8 + 16 + 32 + 64)
Event types
| Event | Description |
|---|---|
create | A logout schedule was created. |
update | A logout schedule was updated. |
delete | A logout schedule was deleted. |