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 Survey Details page displays a single engagement survey with response statistics, response list, and lifecycle action buttons. It is served at route /hr/engagement/surveys/:id.

​
Overview

The page loads survey data via useSurveyDetail, response statistics via useSurveyResponseList, and mutation actions via useSurveyMutation. It renders a SurveyResponseStats summary, a SurveyResponseTable, and lifecycle buttons (Play/activate, Stop/close, Archive, Edit) that appear based on current survey status. This page is part of the HR-17 Employee Engagement feature.

​
Who it’s for

No explicit permission gate on this route.

​
Before you start

  • A survey must exist and have its status set to active before employees can respond.
  • Response data populates as employees submit their responses via the Take Survey route (/hr/engagement/surveys/:id/respond).

​
Steps

  1. Navigate to HR > Engagement > Surveys and click a survey row, or go to /hr/engagement/surveys/:id.
  2. Review the Response Statistics summary card for completion rate and totals.
  3. Browse individual responses in the Response Table.
  4. Use lifecycle action buttons to manage the survey:
    • Activate (Play icon) — sets status to active.
    • Close (Stop icon) — sets status to closed.
    • Archive — sets status to archived.
    • Edit — navigates to the survey edit form.

​
Key concepts

TermMeaning
Survey statusLifecycle state: draft, active, closed, archived.
Survey typeCategory: annual, pulse, exit_interview, custom.
Response statsAggregate completion and count metrics from SurveyResponseStats.

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/SurveyDetailPage.tsx
  • src/cores/hr/engagement/hooks/useSurveyDetail.ts
  • src/cores/hr/engagement/hooks/useSurveyResponseList.ts