1. Overview
2. QuickStart Guide
   1. For Web Sites and Applications
   2. For Desktop Applications
3. Detailed Documentation
   1. Projects
      1.1 Project Settings
      1.1.1 Users&Feedback
      1.1.2 Management
      1.1.3 Integration
      1.1.3.1 Feedback Form
      1.1.3.2 Signup Form
      1.1.3.3 API Access Key
      
   1.2 Project Reports
   2. Feedback
   3. Beta Users
      3.1 Pending Beta Users
   4. Managers
   5. Account
4. API Specification and Examples

BetaEasy Overview

QuickStart Guide for Web Sites and Applications

Detailed Documentation

Projects

This is primary page for you. Here you can see the list of your projects along with quick stats about each of them as well as create new project. To view statistics for some separate project you can use Quick Filter which allows you to search for a project by its name. Date Range allows you to see project statistics for selected time period. Activity Overview shows the projects progress. You can see the quantity of bugs, features and beta users in comparison with prevoius selected period of time. See Project Details and Project Reports for more detailed information and project settings.

Project Settings

When you click on "Manage" button it takes you to Project Settings page. It consists of three sections: Users&Feedback, Management and Integration:

Users&Feedback

This section in its turn consists of several subsections which enable you to view and hadle information about your feedbacks and users in a convenient way:

1. Requested Features - displays last 10 requested project features. To view all requested features click "View all" at the bottom of features list. Here you can see the quantity of votes and comments for each feature as well as its author and status. Also, it's possible to see its last update, edit or delete feedback. In addition to that you can search for feedback by any of the following parameters: feedback subject, description, author, whom its assigned to, feedback type, status, and submitted date.
   
2. Submitted Bugs - displays last 10 submitted bugs. To view all submitted bugs click "View all" at the bottom of bugs list. Here you can see the quantity of votes and comments for each bug as well as its author and status. Also, it's possible to see its last update, edit or delete feedback. In addition to that you can search for feedback by any of the following parameters: feedback subject, description, author, whom its assigned to, feedback type, status, and submitted date.
   
3. Beta Users - here you can view the list of your beta users, their e-mails, projects assigned to each separate user, whether the user is active or inactive (user is considered inactive if he has not followed the activation link sent to him by e-mail), actions (allows you to attach and detach user to/from your projects) Beta Users has two subsections: Invite Users and Export User
   
   • Invite Users - when you click on "Invite Users" you will be taken to Beta Users Invitation Wizard. You will be able to send an invitation to your users/partners/customers in few simple steps
     1. Select the projects you want to invite users to join form the projects list
     
     2. Add emails of people you want to invite to join the selected projects
     
     3. Preview the list of emails the invitation will be sent to
     
     4. Review email template and make changes if needed. When you're done - proceed to send
     
     5. You will be notified that e-mails were sent successfully
     
   • Export Users - this function enables you to export users list to .csv file. Users are exported in "first name", "last name", "email" format
4. Reports - this section can also be accessed from main Projects page. For detailed section description please see Project Reports section.
5. Public Forum - is a place for your users to leave and discuss project feedback. You can view top, most voted features, latest suggestions, confirmed and implemented ones.
   

Management

This section enables you to conveniently manage your project details. It consists of the following subsections:

1. Edit - allows you to edit project details such as: project name, short name, description, project logo, site URL, set project policy and other settings:
   
   • Name - is a required field. Allows you to name your project
   • Short Name - also is a required field. Please note that this field can not be updated so be careful with short name you have chosen for your project
   • Logo - allows you to upload projects logo. The size of the logo should be 300x100px. If the uploaded logo is larger or smaller it will be resized to fit the required size. Supported formats: JPG/GIF/PNG. You can also preview your current logo.
   • Description - enables you to enter short description of your project (10-250 characters)
   • Site URL - provide complete URL to your project web site
   • Policy - allows you to set accessibility rate of your project as Public or Private
     Public - can be accessed by anyone who wants to become a beta tester of your project
     Private - can be accessed only by users invited by you or managers of the project
   • Settings - by checking the corresponding check box you can:
     Enable anonymous voting - users will be able to vote for the feedback anonymously, not having to register
     Enable users auto-improvement - users will automatically join the project and will be able to leave feedback right away. If this option is disabled they will have to wait for approvement and e-mail notification with an explanation why they were approved (or disapproved). Project owner or manager will get the notification whenever new user wants to join the project and approve or discard them accordingly
     Allow users to invite their friends - gives users the ability to send invitation emails to their friends asking them to join the project
2. Notifications - by checking the corresponding check box you can chose what actions you would like to be notified about. You can select to get notification when: anonymous feedback was added, new user registered to project, user leaves project, new feedback is added on the project's forum, feedback status changed.
   
3. Managers - enables you to see the list of managers who have access to your project, can change its details and manage feedback. You can also add new manager to the list.
4. Delete Project - allows you to delete the project with all assigned data.

Integration

This section allows you to easily integrate BetaEasy with your web site/software. It has the following subsections:

1. Feedback Form - takes you to feedback form editor which allows you to choose the design of your feedback form and insert it to your web site. It consists of three tabs:
   
   • Badges - enables you select badge color and placement on your web site (left/right side) and preview how it will look on the site
   • Themes - allows you to select a theme for your feedback form and preview it
   • Get Code - you need to copy code which is displayed to insert feedback form on your website. You should insert the code right above the ending of </BODY> tag. If you perform changes to existing website there will be delay upto 24 hours until your changes will be applied. Remember to save settings when you're done
2. Signup Form - takes you to signup form editor which has two tabs:
   
   • Themes - allows you to select a theme for your signup form and preview it
   • Get Code - you need to copy the code below to insert signup form to your website. You should insert it right above the ending of </BODY> tag. Please remember to save changes when you're done
3. API Access Key - here you can get API key to integrate your application with BetaEasy

Project Reports

When you click on "Reports" button it takes you to Project Reports page. Here you can view some reports on the project:

1. Feature Requests and Bug Reports - displays the quantity of requested features and submitted bugs for a certain time period. You can choose to see the report for: day, week, month or set other data range
2. Feature Requests by Status - chart which shows the statuses of requested features in percentage: pending, confirmed, fixed, implemented, etc.
3. Bug Reports by Status - chart which shows the statuses of reported bugs in percentage: pending, confirmed, fixed, implemented, etc.
   
4. Beta Users Registration Activity - displays the quantity of users registrations for a certain time period. You can choose to see the report for: day, week, month or set other data range
5. Beta Users Map Overlay - enables you to see users location and the quantity of users who came from a certain country
   

Feedback

This page allows you to view 10 latest feedbacks for all your projects. You can see feedback ID, title, amount of votes and comments for each feedback, its author and status, last update date. You can also edit or delete a feesback. In oder to view and manage all feedback for each saparate project you need to click "View all" button at the bottom of the corresponding list.

When you click on feedback title you will be taken to single feedback management page. Here you can see the project it belongs to, the date it was added and last updated, its author, status, which browser and operating system were used and whom its assigned to. Also you can view full feedback description, comments and history. You can also manage single feedback from this page:

• Edit - this tab enables you to edit feedback details: change its status, assign it to one of your managers, change feedback type, edit its title and description
• Change Status -  allows you to change feedback status to: pending, confirmed, can not reproduce, fixed, closed, implemented, won't implement. You can also leave comments concerning status change
• Delete - enables you to delete feedback with all assigned data

Beta Users

This is your beta users mangement page, it allows you to manage your users. Here you can view the list of your beta users, their e-mails, projects assigned to each separate user, whether the user is active or inactive (user is considered inactive if he has not followed the activation link sent to him by e-mail), actions (allows you to attach and detach user to/from your projects) Beta Users has two subsections: Invite Users and Export User

• Invite Users - when you click on "Invite Users" you will be taken to Beta Users Invitation Wizard. You will be able to send an invitation to your users/partners/customers in few simple steps
  1. Select the projects you want to invite users to join form the projects list
  2. Add emails of people you want to invite to join the selected projects
  3. Preview the list of emails the invitation will be sent to
  4. Review email template and make changes if needed. When you're done - proceed to send
  5. You will be notified that e-mails were sent successfully
• Export Users - this function enables you to export users list to .csv file. Users are exported in "first name", "last name", "email" format

Pending Beta Users

Pending Users Page enables you to approve or discard beta users who want to join your project. You will get the notification about pending users if "Enable user auto-approvement" box in project settings is not checked and some user wants to join the project. Based on user's answer on why he wants to join the project, you or project manager can approve or discard users access to project testing.

Managers

Managers management page allows you to add manager to the project or add a new one. Here you can see the list of your managers, their e-mails, projects assigned to them. You can attach or detach projects to managers, edit their managers information, add or delete manager. Use Search to find a manager in timely manner.

In order to add a manager to your project you need to click on "Add manager". You have to enter first and last name of the manager, his e-mail address, enter password and password confirmation. All fields are mandatory. When you're done press "Add" button.

Account

Account page enables you to manage your account, change your personal information and password. It has several tabs:

• Personal - allows you to edit your personal information such as: first name, last name, e-mail, company name and interface language
• Change Password - enables you to change your password for a new one. You have to enter your old password and then print in the new one and confirm it
• Subscription History - this page displays your current subscription and your subscription history
• Purchase Subscription - here you can change your subscription, choose different pricing plan
• Data Export - enables you to export all beta users and feedback data to Excel file

API Specification and Examples