240db4e2a7
Some checks failed
Server CI / Postgres (shard 0) (push) Has been skipped
Server CI / Postgres (shard 3) (push) Has been skipped
BuildEnv Docker Image / build-image (push) Failing after 4s
BuildEnv Docker Image / build-image-fips (push) Failing after 4s
Migration Review & Release Notes / Generate migration review & release notes (push) Failing after 3s
Server CI / Build Environment (push) Failing after 3s
Server CI / Postgres (shard 1) (push) Has been skipped
Tools CI / check-style (mattermost-govet) (push) Failing after 4s
Server CI / Postgres (shard 2) (push) Has been skipped
Tools CI / check-style (mmgotool) (push) Failing after 3s
Server CI / Elasticsearch v8 Compatibility (push) Has been skipped
Server CI / OpenSearch v2 Compatibility (push) Has been skipped
Server CI / Postgres FIPS (shard 0) (push) Has been skipped
Tools CI / Test (mattermost-govet) (push) Failing after 3s
Server CI / Postgres FIPS (shard 1) (push) Has been skipped
Server CI / Postgres FIPS (shard 2) (push) Has been skipped
Tools CI / Test (mmgotool) (push) Failing after 3s
Server CI / Postgres FIPS (shard 3) (push) Has been skipped
Server CI / Run mmctl tests (push) Has been skipped
Server CI / Run mmctl tests (FIPS) (push) Has been skipped
Server CI / Merge Postgres Test Results (push) Has been skipped
Server CI / Merge Postgres FIPS Test Results (push) Has been skipped
Server CI / Check backport migrations (push) Has been skipped
Server CI / Check generated files (push) Has been skipped
Server CI / check-style (push) Has been skipped
Server CI / Vet API (push) Has been skipped
Server CI / Build mattermost server app (push) Has been skipped
Server CI / Server CI Complete (push) Failing after 2s
Server CI / Server CI Artifacts (push) Has been skipped
Server CI / Sentry Upload (push) Has been skipped
Server CI / Server CI Report (push) Failing after 5m1s
Server CI Nightly Race / Race Detector (push) Has been skipped
CodeQL / Analyze (go) (push) Has been cancelled
CodeQL / Analyze (javascript) (push) Has been cancelled
Webapp CI Cache Warm / Warm Webapp node_modules Cache (push) Has been cancelled
E2E CI Cache Warm / Warm E2E npm Registry Cache (push) Has been cancelled
API / build (push) Has been cancelled
Web App CI / check-types (push) Has been cancelled
Web App CI / check-lint (push) Has been cancelled
Web App CI / check-i18n (push) Has been cancelled
Web App CI / check-external-links (push) Has been cancelled
Web App CI / test (platform) (push) Has been cancelled
Web App CI / test (mattermost-redux) (push) Has been cancelled
Web App CI / test (channels shard 1/4) (push) Has been cancelled
Web App CI / test (channels shard 2/4) (push) Has been cancelled
Web App CI / test (channels shard 3/4) (push) Has been cancelled
Web App CI / test (channels shard 4/4) (push) Has been cancelled
Web App CI / upload-coverage (push) Has been cancelled
Web App CI / build (push) Has been cancelled
YAML Lint / yamllint (push) Has been cancelled
Push mirrored docker images / cd/Push mirrored docker images (push) Has been cancelled
docs-cd / Build and deploy docs (push) Has been cancelled
Docs CI / build (push) Has been cancelled
E2E Cache Warm: Cypress deps / Warm Cypress deps cache (push) Has been cancelled
Scorecards supply-chain security / Scorecard analysis (push) Has been cancelled
Server CI Weekly / Postgres FIPS (push) Has been skipped
Server CI Weekly / Run mmctl tests (FIPS) (push) Has been skipped
Server CI Weekly / Postgres with binary parameters (push) Has been skipped
Server CI Weekly / Build Environment (push) Failing after 1s
Server CI Cache Warm / Warm Go Module and Build Cache (push) Failing after 2s
Server CI Nightly Race / Build Environment (push) Failing after 1s
82 lines
4.6 KiB
Plaintext
82 lines
4.6 KiB
Plaintext
---
|
|
title: "Manage user surveys"
|
|
---
|
|
<PlanAvailability slug="all-commercial" />
|
|
|
|
In a self-hosted Mattermost deployment, you can use the Mattermost User Survey integration to gather direct feedback from your Mattermost users to identify what's working well and what's not with your Mattermost instance.
|
|
|
|
All user responses are stored in and remain within your self-hosted deployment, and no telemetry data is sent back to Mattermost. You can export a CSV report of NPS scores and user responses for further analysis, or to share your feedback data with Mattermost. You can schedule when each survey begins, define how long each survey lasts, specify teams excluded from the survey, as well as customize both a welcome message and a user question you want feedback on.
|
|
|
|
<Important>
|
|
|
|
The User Satisfaction Survey Plugin is the recommended approach for gathering user feedback, replacing the deprecated [User Satisfaction Survey Plugin](/administration-guide/manage/user-satisfaction-surveys) for new deployments.
|
|
|
|
</Important>
|
|
|
|
## Setup
|
|
|
|
You must be a Mattermost system admin to [upload the plugin](#install) to your Mattermost self-hosted deployment [enable it](#enable), [create surveys](#create-surveys), and [export survey responses](#export-survey-responses) using the System Console.
|
|
|
|
The User Survey integration is compatible with Mattermost v9.11.2 or later.
|
|
|
|
## Install
|
|
|
|
From Mattermost v9.11.2 (ESR) and Mattermost Cloud v10, this plugin is pre-packaged with the Mattermost Server. If your Mattermost deployment is on a prior release, download the [latest plugin binary release](https://github.com/mattermost/mattermost-plugin-user-survey/releases), and upload it to your server via **System Console \> Plugin Management**.
|
|
|
|
### Upgrade
|
|
|
|
We recommend updating this integration as new versions are released. Generally, updates are seamless and don't interrupt the user experience in Mattermost.
|
|
|
|
Visit the [Releases page](https://github.com/mattermost/mattermost-plugin-user-survey/releases) for the latest release, available releases, and compatibiilty considerations.
|
|
|
|
## Enable
|
|
|
|
Go to **System Console \> Plugins \> User Survey** to enable this integration.
|
|
|
|
Once the integration is installed and enabled, create surveys by completing configuration in the System Console, as described below.
|
|
|
|
### Create surveys
|
|
|
|
Under **Survey setup**, specify the date, time, and details for a new survey:
|
|
|
|
1. **Send next survey at**: Specify the date and time when the survey will begin rolling out to users.
|
|
|
|
> <div class="note">
|
|
>
|
|
> <div class="title">
|
|
>
|
|
> Note
|
|
>
|
|
> </div>
|
|
>
|
|
> A single survey can be active at a time. If you already have an active survey running, you'll need to reschedule your new survey to start on a date after the current survey expires. Alternatively, you can end the active survey early by selecting **End survey**.
|
|
>
|
|
> </div>
|
|
|
|
2. **Survey expiry (days)**: Specify how long the survey will be open to responses in days.
|
|
3. **Exclude specific teams**: Specify who will receive the survey. You can send the survey to all users, to all users on specific teams, or omit all users from specific teams.
|
|
|
|
|
|
|
|
4. **Survey message text**: Customize the introductory message text users see when prompted to complete the survey.
|
|
5. **Linear scale question (1-10)**: This question is required that helps calculate the NPS score.
|
|
6. **Textual question**: This question is required that helps gather user feedback.
|
|
7. **Textual question (Optional)**: You can optionally specify a text-based question for your survey.
|
|
8. Select **Save**. Your new survey is scheduled, and displays under **Active and past surveys** once the survey is shared with users.
|
|
|
|
|
|
|
|
## Active surveys
|
|
|
|
When a survey starts, all users recieve a direct message from a feedback bot containing the active survey. The survey includes one mandatory scale-based question, and optional text-based questions.
|
|
|
|
|
|
|
|
Users must answer all required questions in order to submit their response. When a user selects **Submit**, their responses are recorded.
|
|
|
|
## Export survey responses
|
|
|
|
Select **Export responses** to download a CSV file containing NPS scores and user responses gatherered through the survey. You can export data from active surveys which will contain data collected so far.
|
|
|
|
|