Only this pageAll pages
Powered by GitBook
1 of 40

Open Pulse Survey Docs

Loading...

Installation

Loading...

User Center

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Survey Managment

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Issue Management

Loading...

Loading...

Platform Config

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Loading...

Open Pulse Survey

Enterprise-grade survey platform for measuring employee engagement and collecting actionable insights


Overview

Open Pulse Survey is a comprehensive employee feedback platform designed to help organizations gather, analyze, and act on employee feedback effectively. With powerful analytics, automated campaigns, and real-time insights, it builds a data-driven feedback culture.


SonarQube Cloud

My Profile

The My Profile section allows users to view and update their personal and professional information, manage their organizational assignments, and configure reporting structures

Basic Information
Employment Details
SBU Assignment
Management

Live Survey (Work in progress)

Manual Setup

This is the original way to host Open Pulse Survey. Based on Free Tiers of Supabase and Netlify

Step 1: Create a Supabase Project

  1. Head over to Supabase and create a new project.

  2. You can name the project anything you'd like, for example: Open Pulse Survey.


Step 2: Initialize the Database

  1. Navigate to the SQL Editor in your Supabase dashboard.

  2. Run the following script:

    👉

  3. Paste the contents of that script into the editor and execute it.


Step 3: Save API Credentials

  1. Go to Settings > API in your Supabase dashboard.

  2. Copy the following and keep them handy:

    • Project URL

    • Anon Public Key

These will be used to configure the frontend later.


Step 4: Fork the Main Repository

  1. Fork this GitHub repository:

This will create your own copy of the project to work with.


Step 5: Configure Your Project

1. Update Supabase Client

Open the file:

Replace the placeholders with your actual Supabase credentials:


2. Update Supabase CLI Config

Open the file:

Update the project_id with your Supabase project ID — this is the first part of your project URL:


3. Commit Your Changes


Step 6: Deploy Supabase Functions

Some features of Open Pulse Survey use Supabase Edge Functions, so you’ll need to deploy them.

Follow the official Supabase guide to deploy your functions:

Quick Steps (CLI)


Deploy Your Project Frontend

You can deploy your site for free using Netlify or Vercel.

  1. Go to or .

  2. Choose Import from Git.

  3. Provide the link to your GitHub fork of the project.

  4. They will automatically detect the build settings and deploy your project.

✅ Optional: You can connect a custom domain, but that is outside the scope of this guide.


That’s it! You now have your own fully functional and serverless instance of Open Pulse Survey, running with Supabase and deployed for free.

Campaigns

The ‘Campaign’ dashboard provides a centralized view of all survey campaigns that have been created and executed.

1. View Previous Surveys

  • Displays a list of all previously created campaigns, including:

  • Useful for referencing historical performance or reusing successful formats.

2. Quick Access to Campaign Details

  • Click on any listed campaign to.

3. Instance Configuration

Manage campaign instances - you can adjust the start and end dates, and change the status.

Note: Only one instance can be active at a time.

Settings

The Settings section allows users to manage their account security and update their password. Keeping this information up to date helps ensure secure and uninterrupted access to the platform.

1. Account Settings Overview

  • Access this section to manage personal security preferences.

Issue Boards

The Survey Issue Boards module allows users to track, manage, and respond to common issues or feedback trends emerging from surveys.

1. Create Board

  • Function: Start a new issue board to categorize and manage recurring survey issues.

Email (Work in progress)

With Open Pulse Survey, you can use your own email system for complete control and branding.Here’s how to set it up, step-by-step:

Step 1: Set Up Your Email Provider (Resend)

Start by creating an account with — the email service provider supported by Open Office Survey.


Survey Builder

The ‘Survey Builder’ dashboard is the central hub for creating, managing, and editing surveys. The Key Functionality:

Step 2: Get Your API Key

Once your Resend account is ready, head to the API section in your Resend dashboard. Copy the API key — you’ll need this to connect your email system with Open Office Survey.


Step 3: Configure Email Settings

In Open Office Survey, go to the Email Notifications settings page. Paste your Resend API key here to enable email sending.


Step 4: Enter Email Provider Name

Under "Provider Name", type: Resend. This tells the system which email platform you're using.


Step 5: Add Sender Email Address

This is the email address your recipients will see (e.g., [email protected]). Use your company’s verified domain to avoid landing in spam.


Step 6: Set the "From Name"

Set this to your Survey Name, company name, or anything recognizable to your team.


Step 7: Save Configuration

Don’t forget to click the "Save" button after entering all your details. This ensures your email setup is active and ready to go.


Step 8: Test Before Sending

Use the Test Email option to preview your emails and ensure everything looks perfect before going live.

Resend
Click here to view schema.sql
https://github.com/BrainStation-23/openpulsesurvey
https://supabase.com/docs/guides/functions/deploy
Netlify
Vercel
/src/integrations/supabase/client.ts
const supabaseUrl = 'https://your-project-id.supabase.co';
const supabaseKey = 'your-anon-public-key';
/supabase/config.toml
project_id = "your-project-id"
git add .
git commit -m "Configured Supabase credentials"
git push
# Make sure you're in the project root and have Supabase CLI installed
supabase login
supabase link --project-ref your-project-id
supabase functions deploy
Aimed at maintaining privacy and account protection.

2. Change Password

Users can update their password using a simple form:

Fields:

  • Current Password

    • Enter your existing password for verification.

  • New Password

    • Enter a strong new password (follow any organization-defined password policies).

  • Confirm New Password

    • Re-enter the new password to ensure accuracy.

  • Update Password

    • Submits the form and updates your password upon successful validation.

Use Cases:
  • Grouping common employee concerns

  • Tracking action items raised via survey feedback

  • Creating thematic boards (e.g., “Tech Concerns,” “Workplace Culture”)


2. Search Boards

  • Function: Quickly locate a specific board by name using the search bar.


3. My Boards View

  • Table Columns:

    • Board Name – Title of the board (e.g., Common Issues)

    • Description – Optional field for context (can be blank)

    • Status – Indicates if the board is active or archived

    • Created – Shows the creation date (e.g., 30/03/2025)

Management

Manage your reporting relationships within the platform

  • Current Supervisors:

    • Shows your Primary Supervisor (e.g., Raisul Kabir).

    • Ability to Add New Supervisors as needed, ensuring accurate managerial reporting and oversight.

Save Changes

  • After editing any section, click Save Changes to apply updates to your profile.

Performance

This section highlights the rockstars in your organization. You’ll get:

  • Top Performing SBUs

  • Top Performing Managers

This makes it easy to recognize who’s making an impact.

Top Performing SBUs

Top Performing Managers

Demographics

Break down results based on:

Location

Gender

Employment Type

Employee Type

Employee Role

Level

Insightful for understanding how different segments are feeling and engaging.

Level

The Levels feature allows you to manage different hierarchical levels within your organization.

  • You can activate or deactivate any level with a single click.

  • You can also rename levels and assign specific colors to them for better visual identification.

SBU Assignment

SBU Assignment

Features:

  • Available SBUs – List of all SBUs in the organization.

  • Assigned SBUs – SBUs currently linked to your profile.

Users can select or change assignments based on organizational structure or team alignment.

My Surveys

The My Surveys section provides users with a personalized dashboard to view, manage, and complete their assigned surveys.

Survey Search & Filtering

  • Search Bar:

Users

The Users feature allows you to manage employee or user data

1. Upload Users

You can upload employee or user data using one of the following methods:

  • Individually (one by one)

Create Survey

Step-by-Step Guide

Follow these steps to create a customized survey using the Survey Builder.


Step 1: Access the Survey Builder

  1. Navigate to the Survey Management > Surveys> Survey Builder section in your Admin Portal

Create Campaign

Follow these steps to create and launch a campaign

Step 1: Access Create Campaign

  • From the Survey Builder menu, click on Create Campaign.


Basic Information

This section allows users to update their core identity details.

Editable Fields:

  • Name – Update your full name as it appears across the platform.

  • Organization ID

Employment Types

In this section, you can add new Employment Types based on your organization’s structure.

  • Examples include Permanent, Part-Time, Trainee, or any custom type.

  • You can also assign colors to each type for easier identification and differentiation across the platform.

Needs Attention

This is where you’ll spot potential red flags. You’ll see:

Managers who may need support

Dashboard

Your dashboard is the command center for everything happening inside your organization’s surveys and feedback systems. Here’s what you’ll find:

Create Campaign
Create Survey
Overview
Performance
Demographics
Needs Attention
Search surveys by name, email, or organization ID for quick access.
  • Filter by Status:

    • Assigned – Surveys that have been assigned but not yet started.

    • In Progress – Surveys you’ve started but haven’t submitted.

    • Submitted – Surveys you’ve completed and submitted.

    • Expired – Surveys that were not completed before the deadline.


  • Monthly Pulse Survey (Example Display)

    • A sample listing showing how an active survey appears:

      • Title: Monthly Pulse Survey

      • Anonymity Indicator: Anonymous

      • Next Due: 12/05/2025

      • Completion Status: 0 of 1 completed

    • Survey Description:

      A fully anonymous monthly Pulse Survey aims to gather employee feedback on workplace experiences, engagement, and concerns, helping drive continuous improvements. Your insights enable us to create a better, more supportive work environment

    In bulk using a CSV file

    Additional notes:

    • A downloadable CSV template is available in the upload section to help you format your data correctly.

    • You can also update existing users in bulk using the same upload process.


    2. Filter Options

    Use the Primary Filters to sort or segment users by:

    • Units

    • Employee levels

    • Locations

    • Employment types

    • Employee roles

    • Employee types


    3. User Types

    You can view and manage the following types of users:

    • Active users

    • Admins


    4. Bulk Actions

    The Bulk Action tool allows you to:

    • Remove users

    • Toggle user status (e.g., active/inactive)


    Step 2: Create a New Survey

    1. Select Create Survey.

    1. A new page will appear with fields to input basic information.


    Step 3: Fill Out Basic Survey Information

    • Survey Name: Enter the name of your survey.

    • Survey Description: Provide a brief description explaining the purpose or context of the survey.

    • Tags: You can add tags to categorize or filter your survey


    Step 4: Design Your Survey Using Survey Builder

    Scroll down to the Survey Builder section and click on the Open Survey.js Creator Button


    Step 5: %%%% use the form builder to

    This step is required to properly generate the survey.

    1. Go to the Designer option and prepare your question sets.

    2. The go for JSON Editor to get the codes.

    1. Copy your survey’s JSON configuration code.

    1. Paste the code into the Survey Builder section.


    Step 6: Save Your Survey

    Click the Save Survey button to finalize and store your survey.

    Step 2: Enter Campaign Information

    Fill in the required fields:

    • Campaign Name: Enter a title for your campaign.

    • Description: Provide a short description of the campaign.

    • Survey: Select a previously built survey template.


    Step 3: Choose Survey Type

    • Select Monthly Pulse Survey as the survey type.

    • Optionally, enable anonymous responses if desired.


    Step 4: Schedule Configuration

    You will be directed to the Schedule Configuration page. Choose between:

    • Recurring Campaign: Repeats the campaign on a defined schedule.

    • Regular Campaign: Runs the campaign once.


    Step 5: Set Campaign Timing

    • Choose the start date and time.

    • Choose the end date and time.


    Step 6: Review & Launch

    • Review all campaign settings.

    • Click Launch Campaign to activate it.


    You're Done!

    Your campaign has been successfully created and scheduled.

    – Modify your internal company identifier.
  • Gender – Choose or update your gender identity.

  • Date of Birth – Enter or revise your date of birth.

  • Silent Employees who never responded
    Built with React
    Powered by Supabase
    TypeScript

    AI Prompts

    With AI Prompts, you can create custom instructions that guide the AI to generate tailored insights — exactly the way you want them. Here’s how to set it up:

    Step 1: Add or Edit Prompts

    Create new AI prompts or customize existing ones to generate the kind of insights you need from survey data.


    Step 2: Activate/Deactivate as Needed

    Easily toggle prompts on or off without deleting them — keep your setup flexible.


    Step 3: Generate Custom Reports

    Apply your chosen prompt while generating reports to get AI-powered, tailored feedback summaries.


    Surveys

    The Surveys page serves as the central hub for creating, managing, and monitoring survey campaigns. It brings together essential tools for survey lifecycle management, from design to live deployment.

    Location

    If your organization operates in multiple locations, you can easily update and manage them using the Location Configuration feature.

    • You can add or update each location .

    • This helps in properly organizing users, surveys, and other configurations by their respective

    Employment Details

    Employment Details

    Fields Include:

    • Employee Level – Define your hierarchy level in the organization.

    • Office Location – Select your current work location.

    • Employment Type – Specify permanent, temporary, etc.

    • Work Type – Indicate if you're Permanent Probation, Support Staff, Trainee, Contractual or Part Time.

    • Employee Role – Specify your functional role.

    • Employee Type – Choose between full-time, part-time, contract, etc.

    • Job Title/Position – Write your current role/title.

    Achievements

    The Achievements feature is designed to recognize and reward user participation in surveys.

    1. View Achievements

    • Displays a list of available achievements that users can earn.

    • Each achievement includes the following details:

    Dashboard

    Survey Builder

    Campaigns

    Live Survey


    2. Create Achievement

    • Admins can create new achievements using the Create Achievement option.

    Steps to Create an Achievement

    1. Select Achievement Type

    • Survey Completion:

      • Survey Completion

      • Response Rate

      • Streak

      • Campaign Completion


    2. Enter Achievement Details

    • Name:

      • Enter a clear and motivating title for the achievement (e.g., Survey Star, Dedicated Contributor II).

    • Description:

      • Provide a short explanation of what the user needs to do (e.g., Complete 5 surveys to earn this badge).

    • Icon:

      • Select or upload a visual icon that will represent the achievement in the UI.

    • Points:

      • Set the number of points awarded upon completion.

      • Example: 25 points for completing 3 surveys.

    • Status:

      • Set to Active to make the achievement available to users.

      • Set to Inactive if the achievement should not be awarded yet.


    3. Define Achievement Conditions

    • Required Surveys:

      • Enter the number of surveys a user must complete to earn this achievement (e.g., 3, 5, or 10).

      • This field is critical for tracking progress.


    4. Preview

    • A live preview will show:

      • Achievement Name

      • Description

      • Point Value


    5. Finalize or Cancel

    • Create Achievement: Saves and activates the achievement (if set to Active).

    • Cancel: Discards the changes and returns you to the achievements list.

    Surveys

    Key Functionality

    1. Create New Surveys

    Create Campaign button:

    • Opens the survey editor to draft new survey content (questions, formats, logic, etc.).

    • Surveys can be saved as drafts or published when ready.

    2. Survey Search and Filters

    • Search Bar:

      • Quickly find existing surveys by name or keyword.

    • Tags:

      • Use tags to categorize and organize surveys by theme, department, or use case.

    3. Manage Existing Surveys

    • Each entry typically includes:

      • Survey name

      • Status indicator (e.g., draft, live, closed)

      • Created date

    Employee Roles

    You can manage and customize Employee Roles within your organization.

    • Add new roles based on your organizational needs.

    • Assign specific colors to each role to visually distinguish them across the platform.

  • Survey Status:

    • Filter surveys based on their status (e.g., Draft, Ongoing, Completed).

  • You can edit ongoing or draft surveys directly from this dashboard.

  • Completed surveys can be cloned or reviewed for reference.

  • Permissions Configuration

    The Permissions section allows administrators to define who can view, create, or vote on specific items based on organizational structure, roles, and employment details.

    Permission Rule 1 Configuration

    1. Organization

    Strategic Business Units (SBUs)

    • Action: Select one or more SBUs.

    • Purpose: Apply this rule only to employees within specific business units.

    Locations

    • Action: Select one or more geographic office locations.

    • Purpose: Filter access by physical or remote work locations.


    2. Position

    You can apply one or more filters to specify which users the rule will apply to. These filters include:

    • Levels

      • Action: Choose from defined organizational levels (e.g., Executive, Mid-level, Entry-level).

      • Purpose: Apply permissions based on employee seniority or grade.

    • Employee Roles

    3. Employment

    • Employment Types

      • Action: Choose from options like Permanent, Contractual, Freelance, etc.

      • Purpose: Restrict rule application to specific types of employment agreements.

    • Employee Types


    4. Permissions

    Specify what actions the selected group(s) can perform:


    5. Rule Impact

    • The system will show a live status like:

      "Rule 1 Impact: This rule applies to no one since no groups are selected."

    • This helps admins understand the reach and relevance of the rule instantly.


    6. Actions

    • Add Permission Rule: Create a new rule with different filters or permissions.

    • Save Permissions: Finalize and apply changes made to rules.

  • Action: Select roles such as Manager, Analyst, Engineer, etc.

  • Purpose: Grant specific access to roles tied to responsibilities.

  • Action: Select from Full-time, Part-time, Intern, Consultant, etc.

  • Purpose: Filter further based on work engagement type.

  • Permission

    Description

    Can View

    Allows users to see content

    Can Create

    Allows users to generate or initiate content

    Can Vote

    Allows users to participate in voting or rating

    Security Rating
    Lines of Code
    Vulnerabilities
    Maintainability Rating
    Technical Debt

    Create Campaign

    Follow these steps to create and launch a campaign

    Step 1: Access Create Campaign

    • From the Survey Builder menu, click on Create Campaign.


    Step 2: Enter Campaign Information

    Fill in the required fields:

    • Campaign Name: Enter a title for your campaign.

    • Description: Provide a short description of the campaign.

    • Survey: Select a previously built survey template.


    Step 3: Choose Survey Type

    • Select Monthly Pulse Survey as the survey type.

    • Optionally, enable anonymous responses if desired.


    Step 4: Schedule Configuration

    You will be directed to the Schedule Configuration page. Choose between:

    • Recurring Campaign: Repeats the campaign on a defined schedule.

    • Regular Campaign: Runs the campaign once.


    Step 5: Set Campaign Timing

    • Choose the start date and time.

    • Choose the end date and time.


    Step 6: Review & Launch

    • Review all campaign settings.

    • Click Launch Campaign to activate it.


    You're Done!

    Your campaign has been successfully created and scheduled.

    Instance Automation

    The Instance Automation feature ensures smooth and hands-free management of recurring survey instances by automating the transition of instance statuses.

    1. Automatic Status Management

    • The system performs daily checks to determine if any survey instance needs a status update.

    • Two status changes are automated:

      • Activation: Changes instance status from ‘Upcoming’ to ‘Active’ when the start date is reached.

      • Completion: Changes instance status from ‘Active’ to ‘Completed’ when the end date is reached.


    2. Daily Check Time

    • Set a specific Daily Check Time in your local timezone.

    • The system performs its check once per day at this configured time.

    • This process is optimized for efficiency — reducing unnecessary checks while ensuring timely updates.


    3. Automatic Activation

    • If an instance's start date matches the current date, and the system time matches your Daily Check Time, it will automatically be activated.

    • Helps maintain a hands-off, reliable survey launch process.


    4. Run Now (Manual Trigger)

    • Use the Run Now button to manually trigger the automation process.

    • This immediately checks for any instances that qualify for activation or completion, regardless of the scheduled Daily Check Time.

    My Team

    The My Team section offers a visual representation of your immediate team and reporting structure.

    Team Hierarchy by Level

    • Teams are organized by hierarchical levels (e.g., CEO at the top, Managers, and then Team Leads).

    • This view helps you understand:

      • Who your direct supervisor is.

      • Who your peers are (team members reporting to the same supervisor).

      • Titles and roles of your colleagues for better context.

    Team Members List

    A detailed list of team members along with their roles and designations:

    Your Supervisor

    Clearly indicates your direct reporting line.

    SBUs

    The Strategic Business Units feature allows you to manage different units within your organization.

    You can add new SBUs by providing the following information:

    • SBU Name

    • Website (optional)

    • SBU Head (person responsible for the unit)

    This feature helps you organize your company structure clearly and assign responsibilities accordingly.

    Overview

    Stay updated on survey activity in real-time.

    • Pending surveys

    • Active campaigns

    • Completed campaigns

    • Average Completion Rate

    All displayed with clean, easy-to-read graphs to help you understand the flow at a glance.

    Response trends in graphical view

    Department completion rates - Chart view

    Department completion rates - Table view