Skip to main content

UserOnboardingProgress

One user's progress through one guided product tour.

Tableuser_onboarding_progress
Tenant-scopedYes — extends TenantOwned
Columns7
Relationships0
Sourcebackend/src/main/java/com/motorph/payroll/model/UserOnboardingProgress.java

Columns​

FieldTypeColumnNullNotes
userOnboardingProgressIdIntegeruser_onboarding_progress_id—primary key, generated
userIdIntegeruser_id——
tourKeyStringtour_key——
statusOnboardingTourStatusstatus—enum
lastCompletedStepStringlast_completed_stepYes—
revisionIntegerrevision——
updatedAtOffsetDateTimeupdated_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

MethodReturnsNotes
findAllByUserIdOrderByTourKeyAsc(Integer userId)List<UserOnboardingProgress>derived
findByUserIdAndTourKey(Integer userId, String tourKey)Optional<UserOnboardingProgress>derived
deleteByUserIdAndTourKey(Integer userId, String tourKey)longderived
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)intexplicit @Query, modifying

Reached by​

These controllers hold — directly or through a service they depend on — a repository over UserOnboardingProgress.

ControllerBase pathEndpointsModule
UserOnboardingController/api/onboarding/tours3Platform 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/.