Skip to content

Data model

"CUSTOMER_ADMIN_INVITATION_DETAILS" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "invite_external_employee_id": VARCHAR(255) 
  "person_onboarding_id": UUID 
}
"CUSTOMER_ADMIN_INVITATION_TO_ENTITY" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "customer_admin_invitation_details_id": UUID 
  "entity_id": VARCHAR(255) 
  "entity_type": VARCHAR(255) 
  "invite_as_contract_manager": BOOLEAN 
  "invite_as_invoice_manager": BOOLEAN 
  "invite_as_payroll_manager": BOOLEAN 
  "invite_as_people_manager": BOOLEAN 
  "invite_as_wellbeing_referent": BOOLEAN 
}
"PERSON_ONBOARDING" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "end_date": DATE 
  "first_name": VARCHAR(255) 
  "invitation_email": VARCHAR(255) 
  "is_cancelled": BOOLEAN 
  "is_offline": BOOLEAN 
  "lang": VARCHAR(2) 
  "last_name": VARCHAR(255) 
  "onboarding_status": VARCHAR(255) 
  "onboarding_type": VARCHAR(255) 
  "read_only_fields": ARRAY 
  "start_date": DATE 
  "target_ref": VARCHAR(64) 
  "user_id": VARCHAR 
}
"DEPENDENT_ONBOARDING_PROGRESS" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "birthdate": DATE 
  "dependent_confirmed_at": DATETIME 
  "person_onboarding_id": UUID 
}
"EMPLOYEE_ONBOARDING_PROGRESS" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "billing_account_number": VARCHAR(255) 
  "billing_account_type": VARCHAR(255) 
  "birthdate": DATE 
  "city": VARCHAR(255) 
  "gender": VARCHAR(255) 
  "person_onboarding_id": UUID 
  "postal_code": VARCHAR(255) 
  "province": VARCHAR(255) 
  "street": VARCHAR(255) 
  "viewed_terms_at": DATETIME 
}
"ONBOARDING_DOCUMENT" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "document_name": VARCHAR 
  "person_onboarding_id": UUID 
  "uri": VARCHAR(2083) 
}
"RETIREE_ONBOARDING_PROGRESS" {
  shape: sql_table
  "id": UUID {constraint: primary_key}
  "alsace_moselle_eligibility_status": VARCHAR(255) 
  "billing_account_number": VARCHAR(255) 
  "billing_account_type": VARCHAR(255) 
  "birthdate": DATE 
  "city": VARCHAR(255) 
  "country": VARCHAR(255) 
  "gender": VARCHAR(255) 
  "identification_number": VARCHAR(255) 
  "legacy_contract_ref": VARCHAR(255) 
  "legacy_contract_start_date": DATE 
  "legacy_insurance_company_ref": VARCHAR(255) 
  "person_onboarding_id": UUID 
  "postal_code": VARCHAR(255) 
  "proposal_ref": UUID 
  "province": VARCHAR(255) 
  "retiree_onboarding_type": VARCHAR(255) 
  "retirement_date": DATE 
  "settlement_account_number": VARCHAR(255) 
  "settlement_account_type": VARCHAR(255) 
  "street": VARCHAR(255) 
}
"PERSON_ONBOARDING"."id" -> "CUSTOMER_ADMIN_INVITATION_DETAILS"."person_onboarding_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
"CUSTOMER_ADMIN_INVITATION_DETAILS"."id" -> "CUSTOMER_ADMIN_INVITATION_TO_ENTITY"."customer_admin_invitation_details_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
"PERSON_ONBOARDING"."id" -> "DEPENDENT_ONBOARDING_PROGRESS"."person_onboarding_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
"PERSON_ONBOARDING"."id" -> "EMPLOYEE_ONBOARDING_PROGRESS"."person_onboarding_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
"PERSON_ONBOARDING"."id" -> "ONBOARDING_DOCUMENT"."person_onboarding_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
"PERSON_ONBOARDING"."id" -> "RETIREE_ONBOARDING_PROGRESS"."person_onboarding_id": {
  source-arrowhead.shape: cf-one-required
  target-arrowhead.shape: cf-many
}
Hold "Alt" / "Option" to enable pan & zoom

components.onboarding.public.enums.account_type

AccountType

Bases: AlanBaseEnum

ca_account class-attribute instance-attribute

ca_account = 'ca_account'

iban class-attribute instance-attribute

iban = 'iban'

components.onboarding.public.enums.onboarding_type

OnboardingType

Bases: AlanBaseEnum

company_admin_onboarding class-attribute instance-attribute

company_admin_onboarding = 'company_admin_onboarding'

DEPRECATED: Replaced by customer_admin_onboarding, keeping for backward compatibility

customer_admin_onboarding class-attribute instance-attribute

customer_admin_onboarding = 'customer_admin_onboarding'

dependent_onboarding class-attribute instance-attribute

dependent_onboarding = 'dependent_onboarding'

employee_onboarding class-attribute instance-attribute

employee_onboarding = 'employee_onboarding'

partner_onboarding class-attribute instance-attribute

partner_onboarding = 'partner_onboarding'

retiree_onboarding class-attribute instance-attribute

retiree_onboarding = 'retiree_onboarding'

components.onboarding.public.enums.person_onboarding_status

PersonOnboardingStatus

Bases: AlanBaseEnum

completed class-attribute instance-attribute

completed = 'completed'

in_progress class-attribute instance-attribute

in_progress = 'in_progress'

not_started class-attribute instance-attribute

not_started = 'not_started'

components.onboarding.public.enums.retiree_onboarding_type

RetireeOnboardingType

Bases: AlanBaseEnum

Specifies the type of retiree onboarding.

be class-attribute instance-attribute

be = 'be'

fr class-attribute instance-attribute

fr = 'fr'

fr_mtect class-attribute instance-attribute

fr_mtect = 'fr_mtect'

components.onboarding.public.enums.terms_document_type

TermsDocumentType

Bases: AlanBaseEnum

employee_booklet class-attribute instance-attribute

employee_booklet = 'employee_booklet'

life_and_disability_booklet class-attribute instance-attribute

life_and_disability_booklet = 'life_and_disability_booklet'

privacy_policy class-attribute instance-attribute

privacy_policy = 'privacy_policy'

terms_of_use class-attribute instance-attribute

terms_of_use = 'terms_of_use'