K E Y S U R V E Y ADMINISTRATION MANUAL

Transcription

1 K E Y S U R V E Y ADMINISTRATION MANUAL WorldAPP 161 Forbes Road Braintree MA Tel

2 Contacts CONTACTS Should you have any questions or technical inquiries, please do not hesitate to call, , write, or fax us. For Support Contact: Tel For Sales Contact: Tel Corporate Address: WorldAPP Inc. 161 Forbes Road Braintree, MA Web Site: Please contact WorldAPP if you believe any information in this manual is incorrect. All data used in samples herein is fictitious unless orwise noted. No part this document may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without express written permission WorldAPP, Inc WorldAPP, Inc. All rights reserved. 2

3 Table Contents TABLE OF CONTENTS I - INTRODUCTION HOW THIS MANUAL IS ORGANIZED II API FEATURES API OVERVIEW III USER ADMINISTRATION LICENSE ADMINISTRATION ADD NEW ACCOUNT USER ACCOUNT ADMINISTRATION Searching for User Accounts Important Tips Editing User Accounts Editable Fields Features LDAP USERS SECURITY SETUP TEMPLATE ACCOUNT Creating Survey and Question Templates Template Management CSS Templates

4 Table Contents I INTRODUCTION Key Survey Enterprise Solutions stware is built for business, interfaced for user and engineered for IT; it delivers a powerful, easy-to-deploy system for data garing, evaluation and presentation that enables users, workgroups and even remote divisions to create accounts and collaborate on projects in a user-friendly, controlled and secure environment. Key Survey Enterprise features a user-friendly interface to serve needs everyone in your company. There s no stware to install or download -- all you need to use Key Survey Enterprise is access to a browser. Employees will get going quickly using ready-made templates or y can build custom surveys from scratch. Users have total control over survey results. They can create and customize reports in real-time using any browser, display results in both text or graphic format - even export data to Excel, Powerpoint, SPSS, or or programs. Key Survey Enterprise stware is built to scale. It can handle any number users. Any volume s. Any quantity surveys. Use it to make any kind form, application, or online test for training or assessment purposes. It s designed to meet your survey demands today, and grow with your company. Key Survey Enterprise may be hosted on our secure servers or yours, or delivered fully configured and pre-loaded on a standalone server. Data is completely safe wher stored on your server or ours. Key Survey Enterprise fers option using secure SSL encryption. Administrative controls allow you to define and restrict employee access rights. Key Survey Enterprise puts administrator in complete control all survey creation and survey deployment. The master administrator can create unlimited sub accounts and define access levels for all users. Moving data across your enterprise is no problem for Key Survey Enterprise. It gives you flexibility to pre-populate surveys, employ an API, and export data to or major applications like Excel, Powerpoint, or SPSS, or as a CSV file. It also prints to PDF for hard copy purposes. 4

5 Table Contents HOW THIS MANUAL IS ORGANIZED The manual consists 2 sections (in addition to ). Section II API Features This section provides you with information for accessing survey system API (Application Program Interface). The API provides programmatic access to survey system and allows you to perform following functions: Import responses into your survey Distribute messages with replacement tags in body Receive respondent results Section III User Administration This section provides you with tools you need to search for and edit user accounts and or account information. You will also know how to setup LDAP 5

6 Distributing Creating Table Survey API Contents a Features Reports Survey II - API FEATURES API OVERVIEW Key Survey API (application programming interface) service lets developers design computer programs that interact directly with Key Survey platform. With se applications, customers and third-parties can more efficiently manage ir Key Survey accounts. Key Survey provides multiple API versions, which are API v6.8, v6.9 and v7.3. It is strongly recommended to use most recent version available for your enterprise edition. The API documentation provides information necessary to access survey system API. To connect custom code with Key Survey your program developer will need to get account login credentials and use m in API connection call. They are same that survey administrator uses when needs to access Key Survey account via regular user interface. If you need to set up an API call with a survey from a Multi-Access account, you must use master account s login details. The API provides programmatic access to survey system and allows you to perform following functions: Creating and managing users. Designing and distributing surveys to respondents. Receiving respondent results. Developing additional tools and applications to help you manage accounts. There are more details about Web Services, code examples and API versions in online help your application. Just click HELP link in top right hand corner your account. Or please consult detailed documentation for API system on WorldAPP KeySurvey website. 6

7 III USER ADMINISTRATION LICENSE ADMINISTRATION To activate your enterprise application, license key must be entered on License page. This is unique key that goes along with or installation materials or can be requested from WorldAPP Sales team. When you log in application for first time you are automatically redirected to this page. You can also access it by clicking license link at very top administration account. Enter your license key and click Activate button. If your license key is correct, you will be prompted and license status in right part page will be updated. 7

8 ADD NEW ACCOUNT New user accounts can be added from your administration account. 1. Click Add New button (see picture in Searching for User Accounts subsection on next page). 2. Enter account details in pop-up window. You can also provide or person with link to this page, so account can be created from or side by users mselves. 3. When this is done free trial account is created. Go back to your administration account and search for this newly created user. Perform any changes to it if necessary. For more details see User Account Administration sub-section this manual. Note: Sub-accounts for Multi-User and Multi-Access accounts should be created within se accounts by account holders mselves. 8

9 USER ACCOUNT ADMINISTRATION User account administration should be performed from administration account your application. Admin account login details go along with or installation materials and can be get from Key Survey account coordinator or from production group your company who performed application installation. Administration account allows you to search for and edit regular user accounts, change ir type, expiration date, add or withdraw credits. Editable fields and ir descriptions are shown in Editable Fields table this manual. Searching for User Accounts 1. Access User Search Screen by logging into administration account: 9

10 2. All User Property Fields are searchable. Enter user data into any field to locate user you want to edit. See table below for descriptions each user property field. Properties User ID Login Survey ID First Name Last Name Company Phone City, Country Type Sign Up Expiration Credits Status Description The unique number user in system. The address user. The user login name. The unique number user survey. The user first name. The user last name specified in account. The company name specified in user account. The phone number specified in user account. The residence information. The dropdown box allows you to select user type: - Any; - Single User; - MultiUser Admin; - WebPoll; - Multi-Access; - SubUser. The Sign Up field. The sampling includes those accounts with Sign Up dates limited to range specified in From and To fields. The Expiration field. The sampling includes those accounts with Expiration dates limited to range specified in From and To fields. The quantity remaining user credits. The sampling includes accounts with credits more or equal to number specified in From field and less or equal to number specified in To field. The dropdown box allows you to filter accounts by following status: Any, Active, Locked. 10

11 Use Show items per page dropdown box to indicate number returned records per page in search results. 1. Click Search to begin user search. 2. Click Clear to clear data out all fields. 3. Search results are returned and display associated properties for all users that match search criteria. 4. If user account is a sub-account, unique ID number master account displays in Master ID column. This number is hyperlinked and clicking it allows you to enter application through master account login. 4 Important Tips Keep following things in mind when entering search criteria. If you type partial data into a search field, all results that contain that data excerpt (in that specific field) are returned. This is true on all search fields excluding Survey ID field. For example, if you enter yahoo in Login field, all user accounts containing this domain name in ir logins are returned in search results. If you enter number in Survey ID field, only those user accounts tied to this survey are returned. If you leave all fields blank, entire list user accounts is returned in search results To add more credits to user account input positive integer number into Credits field. To withdraw credits input negative integer number, for example: -35. Account password can be changed from that particular account by users mselves on My Account page. It can be also reset by clicking Reset Password button when editing user account, thus notification with a new password will be automatically sent to address associated with this account. 11

12 Editing User Accounts 1. Once you have located user record you wish to edit, click User ID link to open user record Within user record, you can edit Login, Login Expire, Add/Remove Credits and User Type fields. See table on next page for a description se fields. 3. Use Back and Next to browse through all results returned in previous search. 12

13 Editable Fields: Properties Login Notes Must be a unique record throughout system. Login Expire The date must follow year-month-day standard. Eg Add/Remove Credits URL Suffix User Type You can add or remove credits by placing amount to add or remove in this field. A negative amount represents removal. You can enter a suffix that will be used in all survey links this account. Use this dropdown box to set user type. User Type Single User Multi-User Account Multi-Access Account Subaccounts Description Users can design, edit and distribute surveys and view reports. Users can design sub-accounts in addition to actions performed as a Single User. User can create multiple logins to his single user account and specify access limits for or sub-users this account. Shows number sub-accounts for Multi-User and Multi- Access Sub-accounts for Multi-User and Multi-Access accounts should be created within se accounts by account holders mselves. 13

14 1. Click Show Rights to display all features. Click Hide Rights to collapse list. 2. Activate and deactivate features by clicking to add and remove checkmarks. For more details see Features subsection this manual. 14

15 1. Click Show Details to display feature that allows you to copy surveys from or accounts, remove surveys or restore deleted surveys. Click Hide Details to hide this feature Use Select Survey dropdown box to select survey you want to copy. 3. In Type User ID field, enter User ID account you are copying this survey to. 4. The Deleted on column indicates date a survey was deleted and Survey Name field indicates survey s name. The Credits column displays number credits used for viewing results this survey. 5. Click any Restore icons, to restore a deleted survey. 6. Click any Remove icons, to completely remove a survey from your account. 7. Once you have finished editing, click Save to apply changes. 15

16 Features This is a list features, ir descriptions and where in survey application se features are used Features Description Used In 3D Matrix Allows to use 3D Matrix question type. Edit Questions AddFooter AddressBook Advanced Crosstab Advanced Logic Advanced Show/Hide Alias Anonymous Answer Layout Attach File Autill BackButtRem BranchOnRange Allows user to add header and footer to a survey. Allows users to create an address book. This feature is useful for sending out surveys to distribution lists. Allows users to create Advanced Crosstab tables in survey report. This report is used to compare survey responses according to respondent groups. This option activates advanced logic which is used to make flexible survey structures. This feature allows applying conditional showing or hiding answer choices. Allows user to customize From address for launch, reminder and report s. Allows user to perform anonymous survey distribution. Allows selecting answer layout vertically (down) or horizontally (across) when adding or editing specific multichoice question. Allows to attach files ing link to survey/report or survey/report itself to respondents. Allows to import some additional information on respondents along with ir addresses. This enables to prepopulate some questions (fill in responses automatically). It is available if Bulk feature has been set. Allows to remove back button from survey page. This feature means that next question depends on points scored by respondent. Survey Header Survey Footer Address Book Survey Using Address Book Advanced Crosstab Edit Questios Logic Edit Questions Compose Survey Launch Survey Optional Features Compose Format Data File Survey Rules Branch on Range Logic 16

17 Features Description Used In Bulk Click Through Allows to import a complete database addresses that is saved locally on computer. This survey can be ed to everyone in this database at same time. Allows to display how many respondents opened your survey even if nothing was completed and to show response rate. Common Plugins Enables common plugins for an account. Rules Copy Surveys with Reports Copy Surveys with Results Correct XML Scales Allows to copy surveys with reports when designing survey by editing an existing survey with help Copy with Reports check box on Design Survey page. Allows to copy surveys with results when designing survey by editing an existing survey with help Copy with Results check box on Design Survey page. By default values for XML export start from 0. If enable this feature values will start from 1. To List Surveys Home Design Survey Design Survey XML Export Crosstab Allows to create Cross Tabels in reports. Crosstab Custom CSS CustDomainName CustPalette Allows to apply advanced design to surveys and reports by editing CSS styles. Allows to modify domain name in survey or report URL. Allows to change survey layout manually if none predefined color schemes are suitable with help Custom Colors Layout editor. Design Survey Launch Survey Layout Custom Plugins Enables custom plugins for user account. Plugins Custom Survey Buttons CustRankScale CustTextFormat Dashboard Allows uploading your own survey buttons (Next, Back and Submit) on Layout page. Allows to create rank scales and edit or delete any m. Allows to customize formats that can be used by respondent while answering questions with pre-format option. Use this feature to activate custom dashboard within account for QlickView reporting. Layout Rate Items 3D Matrix Customize text format Dashboard 17

18 Features Description Used In Dashboard Add/Edit Duplicate s EditResponses EducationPackage Reminder This feature allows adding custom tabs to default dashboard. This feature allows sending invitations (during bulk distribution), to respondents with same addresses. This feature also assigns a unique code to each respondent (in data file), so you can distinguish survey results and or attributes from file for AutoFilling. Allows to edit survey results respondents. The education package feature allows user to set a time limit for filling out surveys and provides a view total score for each respondent in report, when answers have been supplied with point values. This is an that is sent to respondents whose addresses are in survey Incompletes list. Dashboard Survey To List Format Data File Report by respondent Launch Survey Branch on Range Reminder Report Allows to report or link to it. Report Enable API Enables API. Administration Page Enterprise Plugins Export Unique Survey URL Export to XML Filtering Filtering Uses Wildcard Filtering Uses RegExp Enables high-level enterprise plugins for user account. Allows exporting unique survey URL each respondent along with results into Excel. Allows to export your survey to XML by clicking Export to XML button on Survey Home page. This feature allows user to apply complex filtering to report, such as filtering on text, address, date, etc. The user can also specify which responses to display in report results. This feature is used along with Filtering feature and widens its capabilities to using wildcard characters. This feature is used along with Filtering feature and widens its capabilities by using regular expressions for filtering results. Survey Rules Export to Excel Survey Home Advanced Filter Advanced Filter Advanced Filter 18

19 Filtering uses fulltext Formula in text and images in reports ImportRespondentData Image Align L/R Image Position JavaScript API Language Links Answers Manage Bounces Navigation Dropdown One Touch Script Panel Filter Password-Survey PDFReport In addition to complex filtering enables fulltext option for advanced text filtering. This feature allows user to create and insert formulas into text report elements. The import response feature allows user to upload responses from a CSV file into a survey. Allows to set alignment image (left, center, right) in top position and add arrows (Up Left, Bottom Left, Up Right, Bottom Right). Allows positioning image (left, top, right) relative to question text. Enables JavaScript for a survey and opens access to survey elements. Allows to select language for popup alerts and to design a survey in different languages. Allows to specify way information about responses to specific questions will be displayed in online report. Enables possibility to track deliviring messages on Results page. Allows to navigate through account pages using dropdown box. This feature navigates respondents to next page, upon selecting one radio buttons. Allows to filter addresses according to results selected surveys. Allows to protect surveys with individual passwords. Allows to convert report to PDF format and to print it. Advanced Filter Text and images Launch Survey Upload responses Add Image Add Image Survey Rules Survey Rules Report Rules Results Survey and Report Editing Pages Survey Rules Address Book Password Protection Format Data File Publish Report PDFSurvey Allows to convert surveys to PDF format. Surveys home Preferred answer Allows to use Skip with alert option. If respondents do not answer question with Skip with alert option and submit survey, y will be prompted to answer it but still y can skip it. Survey Questions 19

20 Features Description Used In PreferredMatrix PrivateNotes Prile Question Analisys Code RandAnswer RandQuestion Redirect RegularExpressions RemoteFilter ReplyTo ReportExpandText Allows to use Compare one against anor question type. Allows to enter comments on survey results respondents. Allows to design prile surveys for Common-Password survey protection. This feature is used for statistic analysis purposes Allows to display question answers in random order. Allows to display questions in random order. Enables to redirect respondents to necessary website after y have submitted survey. Allows to use regular expression for designing custom formats. Allows a report viewer add filters to survey report online. Allows to fill in fields for Reply address and undelivered s. Allows to expand text responses in online report. It should be activated on Customize Report page. Survey Questions Edit Questions Summary Report Common-Password Survey Edit Questions Optional Question Features Edit Single Question Edit Questions Survey Rules Customize text format Report Rules Summary Report Compose Report Items Summary Report Report Logo Allows to attach report logo. Report Layout Response Rate Salesforce integration Search Section 508 Support SecureConnection Allows to show response rate % (which is total number completed surveys multiplied by 100 and divided by total number completed and incompleted surveys) in Completed column in parenses. Allows to launch survey through SalesForce application. Allows to search surveys by survey name, title, introduction or survey ID. Enables Section 508 support for user account. Allows to secure all survey data by encrypting it. Surveys home Launch Survey Surveys home Launch Survey 20

21 Share Calculation Show Results Significance SPSS Sort Respondents By Start Date Statistics TimeSeries Two Color Layout Unique Export Plugins URLAppend Workflow Allows to create a table or graph to show results share calculation in online report and PDF. Gives user an ability to allow survey respondents view ir results. Allows to create a table or graph to show results significance testing in online report. With this feature, user can export survey results to SPSS. Allows sorting reports by date respondents started to take survey. Allows to apply statistical quantities to survey results. This feature allows user to add time series tables and graphs to report. This features activates two color palettes so user can easily apply simple color design to a survey. Enables unique Export Plugins for user account. URL ID append This feature allows user to apply a suffix to survey URL. Enables to receive s or send m to respondents or to any or addresses when a particular response is selected. Share Calculation Survey Rules Significances Report Publish Options Survey report Report Questions Time Series Graph Survey Layout Survey Rules Launch Survey URL Suffix Alert 21

22 LDAP USERS LDAP (Lightweight Directory Access Protocol) is an open standard for a user security repository and auntication mechanism. This feature allows managing users accounts stored inside an LDAP directory. Using LDAP, you can automatically create user accounts within application and prevent users from having to enter login and password when accessing account. Accessing an LDAP user database requires specific connection information about LDAP server. To take advantage LDAP functionality, server administrator firstly should adjust LDAP server s parameters in configuration file deliverable application. The list parameters to be modified: ldaphost - IP address LDAP server; ldapport - LDAP server s port; ldapuser - user name in LDAP; ldappassword - user s password in LDAP; ldapbasednlist - list LDAP s pas, delimitted with semicolon. After that log in administration account and click LDAP Users button to manage users. 22

23 The following page enables you to create accounts in application for selected users. 1. Use Your LDAP users list box to select specific user. 2. Click Add to move user to LDAP users with an account list box. 3. To remove added users, select m from LDAP users with an account list box and click Remove button. Notes: Hold down CTRL and click left mouse to select several users at once. The user marked with * is no longer in your LDAP. Click Save button for changes to take effect. 23

24 SECURITY SETUP This page allows you to set up security regulations and to manage password settings for all account types. Using this administration resource, you can adjust security policy account access, reset passwords, deactivate and reactivate accounts. To access security settings you need to log in admin account and click Passwords button. 24

25 This page provides possible security settings: 1. User passwords expire in. Allows you to manage password validity term. The supported options are: Never Expires (by default); Expires in.. days (The value must be between 0 and 365). Enforce password history. Enables you to determine number unique new passwords that have to be associated with a user account before an old password can be reused. The possible options are: Is not logged (by default); Remember.. passwords (The value must be between 0 and 10). Password complexity requirement. This security setting requires password to meet complexity requirements. The possible options are: No Restriction (by default); Must mix alpha and numeric ( password must contain at least one numeral and one letter); Must contain special characters ( password must contain one following non-alphabetic character:!,, #, $, %, &,, (, ), *, +, -,., /, :, ;, <, =, [, \, ], ^, _, `, {,, }, ~). Minimum password length. Enables you to set minimum password length. The supported options are: Not Limited (by default); At least characters (The value must be between 0 and 16). Account expiration requirement. Allows you to limit term account can stay idle. The possible options are: Never Expires (by default); Expires if idle for.. days (The value must be between 0 and 365). Account lockout policy. This setting disables a user account if an incorrect password is entered a specified number times over a specified period. You may set following option: Do not lock accounts (by default); Lock accounts for.. minutes after.. invalid attempts (The value must be more than 0 for minutes and between 1 and 10 for attempts). Notes: Click Save button for changes to take effect; Click Cancel button to undo all actions up to last saved one. 25

26 TEMPLATE ACCOUNT Template account is a system account that is used to create and store survey and question templates, as well as custom mes. Later y can be used in regular and workgroup accounts by regular users. The default template account name that goes with your installation is template. When you log in to template account you will see list folders that contain default template surveys, CSS templates and question library available for your regular users. Creating Survey and Question Templates Survey templates are available for all accounts within your environment and are used for quick survey creation. They are divided into categories and contain list commonly asked questions depending on category y belong to. Users that create new survey using templates can n customize newly created surveys within ir personal accounts by adding new questions, deleting or editing predefined questions. To add new survey template: 1. Click New Survey button at very top template account. 2. Select I want to create my survey from scratch option to create survey template adding questions you need. Select I want to create my survey using a template option to create survey template by customizing existing template. Then click Next. 3. Give unique name to your survey template. Note: survey name will be displayed to or users when y create survey from templates. 26

27 4. Select category you want to create survey for from second step. Use Templates section to add survey template or Question Library section to add current survey questions to library for public use. 5. Save your changes and click Next. 6. Add as many questions to your survey as you need and proceed with or survey design procedures is necessary. Now your survey template or questions from Question Library are available for all users. Template Management By default all template surveys and questions from Question Library are organized within different categories. On Template Management page you can customize se categories or add new ones. 1. Click Manage Categories link from Surveys home page template account. 27

28 2. If your installation is an Extreme Form application, use Forms Templates and Form Library options to customize categories. Orwise use Templates and Question Library options. 3. Select category you want to edit and click Edit Category button. 4. Edit category name and assign group where this category should reside. You can also number category by typing its number. The check box available next to numbering field shows or hides category from templates list. 5. Click Save button to apply changes. 6. Go back to customize or template account properties. CSS Templates Along with survey and question templates you can create CSS templates (mes). They can later be used by regular users to improve survey design and appearance from Theme Library page. 1. Create new survey from scratch or use available template. Follow default survey design steps. 2. Go to survey Layout page. 3. Click Theme Library button. 4. Click Manage Categories link from bottom left part page. 5. Edit default categories if necessary or click Add New to add your own category. 6. Go back and click Add New Theme link to add new me template. 7. While creating categories or mes follow standard steps described in Key Survey User Manual and Online Help file. When this is done, regular users will be able to use CSS templates and apply m to ir surveys within just a few steps. 28