Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.encoreos.io/llms.txt

Use this file to discover all available pages before exploring further.

The Take Survey page allows an employee to complete an assigned engagement survey using an embedded form, with support for partial completion and resuming an in-progress response. It is served at route /hr/engagement/surveys/:id/respond.

​
Overview

The page resolves the current user’s employee record to obtain employeeId, then checks eligibility via useCanStartSurvey. Survey content renders via FormEmbed. Response state (create/submit) is managed by useSurveyResponseMutation. On successful submission, a completion state is shown. Ineligible users or loading errors display appropriate messages. This page is part of the HR-17 Employee Engagement feature.

​
Who it’s for

No explicit permission gate on this route. Eligibility is enforced by the useCanStartSurvey hook.

​
Before you start

  • The survey must be in active status.
  • The current user must have an associated employee record in the organization.

​
Steps

  1. Navigate to the survey respond link (e.g., from an email notification or the My Surveys page) or go directly to /hr/engagement/surveys/:id/respond.
  2. If eligibility is confirmed, the survey form renders.
  3. Complete the questions. Partial responses may be saved automatically.
  4. Click Submit to finalize the response.
  5. A confirmation screen is shown on successful submission.

​
Key concepts

TermMeaning
EligibilityDetermined by useCanStartSurvey; ineligible users see a blocking message.
FormEmbedPlatform form rendering component that handles question display and input capture.
Partial saveIn-progress response persisted server-side; can be resumed. SME: confirm persistence behavior.

Human Resources

Human Resources core overview.

Governance & parity

This page documents shipped product behavior. It is not medical, legal, or billing advice. Verify against your organization’s policies and applicable regulations before using it for clinical, compliance, or billing decisions. Protected health information (PHI) shown in the product is governed by your tenant’s access controls and is never exposed in this documentation.
  • src/routes/hr/engagement-routes.tsx
  • src/cores/hr/engagement/pages/SurveyResponsePage.tsx
  • src/cores/hr/engagement/hooks/useSurveyResponseMutation.ts
  • src/cores/hr/engagement/hooks/useMyActiveSurveys.ts