Getting Started with ApPHP Survey (for v2.0.0 or above)
- 1. General.
2. Survey's Backend.
- 2.1 Module Installation.
- 2.2 Updating a Module.
- 2.3 Edit Module.
- 2.4 Module Settings.
- 2.5 Questions Types.
- 2.6 Participants Management.
- 2.7 Surveys.
- 2.8 Questionnaires.
- 2.9 Questions (Questionnairy Items).
- 2.10 Survey Participants.
- 2.11 Survey Results.
In this section described what are ApPHP MVC Framework and ApPHP Directy CMF.
1.1 ApPHP MVC Framework.
ApPHP MVC Framework is designed to provide modern and rapid development of websites, web applications and web services. Survey script requires framework version 0.4.0 or later for stable work. You may read more information about the framework from this Framework Documantation page.
1.2 ApPHP Directy CMF.
ApPHP Directy CMF is an open-source content management framework (CMF), built on ApPHP MVC Framework that provides a basic functionality required for creating websites and publishing web content. It includes Frontend and Backend parts, supports multi-language, roles and privileges, templates, modular development etc.
Building an application without ApPHP Directy CMF could take a weeks and weeks of hard developing, debugging and testing (depending on your experience level with PHP).
ApPHP Directy CMF eliminates the need for most of this work, freeing your valuable time for making great and modern applications. Each web applications that built with Directy CMF represents the triple chain, where application logic encapsulated in the special module: MVC Framework ↔ Directy CMF ↔ Web Application.
Find more information about the ApPHP Directy CMF in this Getting Started guide.
2. Survey's Backend.
This section describes how to start work with ApPHP Survey Backend.
2.1 Module Installation.
First of all make sure Survey module is installed on your site. To check it go to Modules / Modules Management page and select System Modules tab. If you see this module in the list with status Enabled it means it's successfully installed.
If for some reason it's still not installed, you have to perform this operation before starting to work with it. To install the module simply click on Install link from the column named Actions.
2.2 Updating a Module.
Remove an old version of the module from protected/modules/ directory and upload there the new one. Then go to Modules / Modules Management page and select System Modules tab. If a new version of Survey module is greater than previous you will see update icon link in Actions column. Click this icon to update the module. If update operation completed successfully update icon will disappear and module version number will be changed to the latest.
2.3 Edit Module.
Once installed the Survey module will appear in the list of available modules on Application Modules page. Now you may edit module parameters (only allowed for system modules).
To edit a module click Edit icon from the Actions menu. On edit module page you may see all module parameters and change some of them, for ex.:
- Survey Code Type
- Send Email Notification
- Show Page Complete Alert
- Participant Fields / Settings
2.4 Module Settings.
Module Settings allows you to configure important settings of the module. To access this page go to Modules / Modules Management, select System Modules tab and then click Survey module link or click on Survey module icon from the dashboard.
Currently you may configure following settings:
- The type of survey code
- Show missing questions alert before going to next page
- Show on login page "I agree with Terms and Conditions"
- Enable direct login by URL
- Type of participant identification for surveys with public access
- Email notifications / Settings:
- Allow to send email notification to participant after finishing the survey
- Allow to send send email notification to admin after finishing the survey
- Define admin email address used to receive notification after participant finish the survey
- Participant Fields / Settings:
- Allow Identity Code field on participant profile
- Allow Password field on participant profile
- Allow First Name field on participant profile
- Allow Last Name field on participant profile
- Allow Email field on participant profile
- Allow Gender field on participant profile
2.5 Questions Types.
Questions Types allows you to manage different types of questions (currently 18 types). You may activate or disactivate any of questions and also to view HTML or Code examples. To access this page go to Modules / Modules Surveys and then click Questions Types Management tab.
2.6 Participants Management.
Select Participants from Surveys side bar. On this page you can manage all participant accounts. You may add, edit or delete existing participants. When you create a new participant account you have to define Identity Code, Password, First Name, Last Name and other information, defined in module settings.
The Surveys Management page allows you to manage surveys. On this page you may create, edit or delete existing surveys. Also you may create a copy of existing survey.
In each survey you may define:
- Expiration Date
- Access Mode: public or registred participants only
- Votes Mode: one time or multiple times
- Genger Formualtion
- Items per Page
- Sort Order
- Login page text
- Welcome page text
- Complete page text
The Questionnaires Management page allows you to manage questionnaires related to the selected survey. On this page you may create, edit or delete existing questionnaires. Also you may create a copy of existing questionnairy. To access this page go to Modules / Surveys / Surveys Management and then click [ Questionnaires ] link in the row of selected survey.
In each questionnairy you may define:
- Category Title
- Items per Page
- Sort Order
- Start page text
- Finish page text
2.9 Questions (Questionnairy Items).
The Questions Management page allows you to manage questions related to the selected questionnairy. On this page you may create, edit or delete existing questions. To access this page go to Modules / Surveys / Surveys Management, click [ Questionnaires ] link in selected survey and then click [ Questions ] link in selected questionnairy.
For each question you may define:
- Question Description
- Question Type
- Question Answers (for questions with multiple answers)
- Alignment Type
- Sort Order
- Required or not
- Active or not
2.10 Survey Participants.
If the survey is defined as "protected" (for registered participants only) you may add participants to this survey via Survey Participants management page. On this page you may add, activate or remove participants from the survey. To access this page go to Modules / Surveys / Surveys Management and click [ Participants ] link in the selected survey.
Before assigning a new participant to survey you have to add him via Participants Management page.
2.11 Survey Results.
The Survey Results page allows you to view statistics related to the selected survey. On this page you see distrubution of answers by questions and also export survey results into CSV file. To access this page go to Modules / Surveys / Surveys Management and then click [ Results ] link in the row of selected survey.
3. Survey's Frontend.
This section describes how to start work with ApPHP Survey Frontend.
3.1 Survey Login/Logout.
When survey is created, it may be defined with "public" or "resgistered" access to participants. Public - means every site visitor may open the page of survey and start it. Registered - means only registered (previously created) users may participate in this survey. For "registered" surveys there is an option to logout on any stage of the survey by clicking on Logout button.
3.2 Steps in the Survey Process.
The standard survey process consists from the following steps:
- Login (if "registered" access)
- Survey Welcome Page
- Questionnaire Welcome Page
- Questionnaire Pages with questions
- Questionnaire Finish Page
- Next Questionnaire ...
- Survey Finish Page
- Logout (if "registered" access)