UserOnboardingProgress
One user's progress through one guided product tour.
| Table | user_onboarding_progress |
| Tenant-scoped | Yes — extends TenantOwned |
| Columns | 7 |
| Relationships | 0 |
| Source | backend/src/main/java/com/motorph/payroll/model/UserOnboardingProgress.java |
Columns
| Field | Type | Column | Null | Notes |
|---|---|---|---|---|
userOnboardingProgressId | Integer | user_onboarding_progress_id | — | primary key, generated |
userId | Integer | user_id | — | — |
tourKey | String | tour_key | — | — |
status | OnboardingTourStatus | status | — | enum |
lastCompletedStep | String | last_completed_step | Yes | — |
revision | Integer | revision | — | — |
updatedAt | OffsetDateTime | updated_at | — | — |
Plus tenant_id, inherited from TenantOwned. Hibernate stamps it on insert and adds where tenant_id = ? to every query, so it is never written or read by application code.
Repository
UserOnboardingProgressRepository
Declared over UserOnboardingProgress with id type Integer. Source: backend/src/main/java/com/motorph/payroll/repository/UserOnboardingProgressRepository.java
| Method | Returns | Notes |
|---|---|---|
findAllByUserIdOrderByTourKeyAsc(Integer userId) | List<UserOnboardingProgress> | derived |
findByUserIdAndTourKey(Integer userId, String tourKey) | Optional<UserOnboardingProgress> | derived |
deleteByUserIdAndTourKey(Integer userId, String tourKey) | long | derived |
upsert(@Param("tenantId") Integer tenantId, @Param("userId") Integer userId, @Param("tourKey") String tourKey, @Param("status") String status, @Param("lastCompletedStep") String lastCompletedStep, @Param("revision") int revision) | int | explicit @Query, modifying |
Reached by
These controllers hold — directly or through a service they depend on — a repository over UserOnboardingProgress.
| Controller | Base path | Endpoints | Module |
|---|---|---|---|
| UserOnboardingController | /api/onboarding/tours | 3 | Platform Misc |
Generated page
This page is rebuilt from the source on every docs build by docs-site/scripts/gen-code-wiki.mjs. Editing it has no effect — change the code, or, if what you want to say is prose, write it in docs/.