queXS: +Administration
+queXS relies on the LimeSurvey +system to administer the questionnaire to the operator. A patched +version of LimeSurvey +is included with queXS to aid in interoperability. +
+Keep in mind that a single questionnaire in LimeSurvey can be +added to queXS multiple times if necessary (eg once for testing, once +for the live run).
+Go to the queXS administration page
+Click on the link: Administer questionnaires with LimeSurvey
+Enter the LimeSurvey username and password
+By default the username is:admin and the password is: + password
+Use the LimeSurvey + documentation to assist in creating a new questionnaire.
+The following settings must be adhered to to create a + successful questionnaire that is interoperable with queXS
+Under “Presentation and Navigation”
+Format must be “Question by Question”
+Template must be “quexs”
+End URL must be a link to the rs_project_end.php + file in your queXS installation directory, for example: + http://active.dcarf/quexs/rs_project_end.php
+Automatically load URL when survey completes must be “Yes”
+Under “Notification and Data Management”
+Anonymous answers must be “No”
+Enable Token-based answers persistence must be “Yes”
+Within the text of questions, the + following tags may be entered, which will be automatically filled at + run time by the queXS system.
+{PeriodOfDay} – Either: morning, afternoon or evening
+{Operator:firstName} – The first name of the operator
+{Operator:lastName} – The last name of the operator
+{Respondent:firstName} – The first name of the + respondent
+{Respondent:lastName} – The last name of the + respondent
+{Sample:xxxx} – Where xxxx is the name of a column + within the provided sample file
+Once the questionnaire is ready to run, it must be activated + within LimeSurvey.
+Also, a “tokens table” within LimeSurvey is + required to be created after activating the questionnaire.
+Use the queXML + tools website to convert your queXML + file in to a LimeSurvey import file
+Follow the instructions for “Add a questionnaire from + an existing instrument in Limesurvey”
+When creating a new survey, use the “Import” + feature
+Import the LimeSurvey csv file produced by conversion from + queXML or from an existing installation of LimeSurvey
+Make sure the settings for the questionnaire match those from + the section above “Add + questionnaire manually”
+Go to the “Create a new questionnaire” link in + queXS administration
+Enter a name for the questionnaire
+Select the questionnaire from the list “Select creation + type” +
+A questionnaire created in LimeSurvey should appear under + “Existing questionnaire...”
+If the questionnaire is for testing, make sure to select the + “Testing” box. This will ensure that all calls can only + be made internally to operators – no matter what sample is + assigned to a questionnaire.
+If there is to be respondent selection for the questionnaire, + enter it in to the boxes. You may use the tags + listed above
+Respondent selection introduction is the first text read by + the operator to whoever answers the phone. This is used to find the + respondent you are after.
+Respondent selection project introduction is used to tell + the respondent about the project, and to illicit their cooperation
+Respondent selection callback (already started + questionnaire) is read to the respondent if they have already + started the questionnaire and are being called back. +
+Message to leave on an answering machine is a message to + leave on the answering machine if allowed by the system.
+queXS requires sample lists to be in CSV +form. The first row should contain the name of the column. Most +statistical packages, and Microsoft Excel can export lists in CSV +form. The minimum required for a sample file is a single column +containing a phone number. A sample list containing the name of the +respondent should be formatted with the first name and last name of +the respondent is separate columns. For example:
+|
+ firstName + |
+
+ lastName + |
+
+ Number + |
+
+ Sex + |
+
|---|---|---|---|
|
+ Fred + |
+
+ Jones + |
+
+ 03 1234 5678 + |
+
+ M + |
+
|
+ Mary + |
+
+ Jones + |
+
+ 03 1234 5678 + |
+
+ F + |
+
+
Once the sample list is saved in CSV form, it can be imported in +to queXS
+Go to the page: Import a sample file (in CSV form)
+Browse for the file and give the sample file a descriptive + name
+Click on “Submit”
+A page will appear containing a list of all the columns in + the sample file, along with a checkbox indicating whether the column + should be imported, the name of the column and the “type”
+For each column, select whether it is to be imported, check + the name, and select the type of data contained in that column. For + example:
+String: A field that should be imported “as is” + and not to be specifically used by queXS. (but will be available + when using the {Sample:xxxx} tag)
+Phone number: A phone number
+Primary phone number: The main phone number for this + respondent. This must be selected for one and only one column
+State: The state (currently only Australian states loaded, + either in abbreviated form such as: VIC, NSW or full such as + Victoria or New South Wales)
+Postcode: The postcode (only Australian postcodes loaded)
+Respondent first name: The first name of the respondent
+Respondent last name: The last name of the respondent
+Then click on “Submit query”
+Only fields that have at least one phone number will be added + to the sample
+Use the “Assign samples to questionnaires” link to +assign a sample to a questionnaire.
+Select a questionnaire to operate on
+Select the sample to add from the list
+Choose from the following
+Max calls (0 for unlimited): Maximum number of calls (a call + is a call to any number available in the sample)
+Max call attempts (0 for unlimited): A call attempt is a + chance an operator has to call any or all of the numbers for a + particular case
+Number of answering machine messages to leave per case (0 + for never): How many answering machine messages to leave
+Select from sample randomly? (otherwise sequentially): The + method to select from the sample list when creating a case
+
+
+
A pre-filled question is a question within the questionnaire that +has data filled before the operator begins collecting data. The +pre-filled data could be static (the same for each case within the +questionnaire) or come from information already available in the +sample.
+To pre-fill a question within the questionnaire, go to the + link: “Set values in questionnaire to pre fill”
+Select the questionnaire, then the question to pre fill
+Enter in either the static information, or sample information + using the tags listed above
+To remove the pre-fill, simply click on it.
+queXS relies on an underlying authentication system (such as +Apache Basic Authentication) to handle authentication of users. Once +they are authenticated, queXS uses the username of the operator to +determine who the operator is, and therefore how to assign work to +them. This means that queXS needs to know the authentication system +username (username only, not password) of each operator on the system +and some other details if using Voice over IP (VoIP).
+To add an operator to queXS, click on “Add operators to + the system”
+Enter the system username
+Enter the first name of the operator, and the last name of + the operator
+Enter the timezone where the operator is located in (this + list may help) it should be in a format such as + “Australia/Victoria”
+The telephone extension number must be unique for each + operator, and is necessary if using VoIP. This is the extension to + log in as to the VoIP system. queXS will send the extension number + as the password when logging on.
+The normal interviewer, supervisor and refusal converter + checkboxes automatically assign skills to the operator. See the + Assigning skills to operators section for a + description of operator skills
+When an operator is assigned to a questionnaire they will be +assigned work from that questionnaire. An operator can be added or +removed from a questionnaire at any time.
+To assign an operator to a questionnaire, go to the link: + “Assign operators to questionnaires”
+Check the box for the operator and the questionnaire, then + click on “Submit query” to confirm it.
+
+
Assigning skills to operators is done in a similar fashion to +assigning operators to questionnaires. The following skills are +available:
+Temporary outcomes
+These are “normal” cases, such as ones that have + never been called, or have a previous outcome such as No answer
+Supervisor outcomes
+Where a case has been referred to the supervisor
+Refusal outcomes
+Where the case has been refused
+Final outcomes
+Where the case has a final outcome, such as complete, final + refusal, disconnected number
+Appointments
+Where an appointment has been made
+
+
Use the “Modify operator skills” tool to assign the +appropriate skills to each operator. A “normal” +interviewer has “Temporary” and “Appointment” +assigned to them.
+
+
queXS will usually only assign work to operators if they are +assigned to the questionnaire, have the appropriate skill assigned to +them, and finally that there is a shift available at the current time +for the questionnaire. Defining shifts allows for appointments to be +restricted to times when operators will be available, and to restrict +work to specific hours.
+It is desirable to add as many shifts as you know will be run in +advance so that operators will be able to schedule appointments in +them. But conversely, remember not to add shifts if they will not be +run, as appointments may be made for those times.
+The shifts listed by default are taken from the shift_template +table, and can be modified by a system administrator.
+To assign shifts to questionnaires, use the “Shift + management (add/remove)” tool
+Select the questionnaire to create a shift for
+The current year and week of the year are selected, but these + may be changed to suit when the shifts need to be added
+Confirm the shift start and end times, and dates, and select + the “Use shift” checkbox if you wish to include that + shift for this questionnaire +
+Click on “Submit changes” to confirm your shift + selection
+
+
Once you have completed all the steps in the “Questionnaire +Creation and Management” section, the system should be ready to +execute questionnaires. The following sections describe information +about the progress of the questionnaire, and functions for the +supervisor to modify erroneous outcomes or handle cases where the +operator was unsure about what outcome to assign
+Clicking on this link will display a list of all appointments in +the future.
+By selecting a questionnaire, a list of AAPOR +outcomes and rates will be listed.
+Performance of operators is split in to completions per hour and +effectiveness. Effectiveness is the ratio of how often an operator is +on a call while a case is assigned to them.
+An operator may incorrectly assign an outcome to a call, or have +assigned a case to be reviewed by a supervisor. A supervisor can then +modify the outcome of a call and/or the outcome of the case.
+To modify the outcomes of calls or cases, go to the “Assign + outcomes to cases” link
+Select a case
+If a drop down box is visible, there are cases assigned to + the supervisor in it that can be dealt with. If so, you can select + one of the cases from the drop down list
+A box to enter a case id is also available +
+Confirm that the project and sample is correct for the case + you are expecting
+A list of calls made for that case will be listed
+Clicking “Edit” on the call list will allow you + to change the outcome of the call
+Please note that changing the outcome of the call will not + change the outcome of the case automatically
+Notes are listed
+It is recommended to add a note to the case if any changes + are made so the operators will not be confused about any possible + inconsistencies with the case
+A case outcome can be set
+This is the current outcome for the case. This determines + how cases are made available to operators
+A shift report is filled in by the shift supervisor to detail any +notes about a particular shift.
+A supervisor can search the sample to find particular records to +either remove from the sample, therefore not ever be selected as a +case, or if a case has already been assigned – to be able to +see what calls have been made to the case and modify the outcome if +necessary (using the Assigning outcomes to cases tool).
+To search the sample, click on “Search the sample”
+Select the sample you wish to search within
+Enter the search term in the box and click “Start + Search”
+A list of matching searches will appear
+If a sample record has already been assigned to a + questionnaire (become a case), then clicking the “assigned to + questionnaire” link will take you to the Assigning outcomes + to cases tool for viewing or modifying the outcome of the case
+If a sample record has not yet been assigned to any + questionnaire, then the link “No cases yet assigned” + will appear. By clicking this link, the record will be deleted from + the sample.
+WARNING: You cannot recover a deleted record, so be + careful!
+If nothing in the sample matches your search criteria, no + records will be returned
+A client view of the project is available in the client +subdirectory of the queXS installation. If this URL is made available +publicly, and each client is assigned a system username and password +as for operators, then clients can be added to the system and +assigned to questionnaires. Each client will then see a progress +report of each questionnaire assigned to them when visiting the +client page and entering in their credentials.
+Follow the link “Add clients to the system”
+Enter in the system username of the client
+Enter their first name and last name
+Enter the timezone the client is in (or leave as default if + unknown)
+Click “Add user” to add the client to the system
+Follow the link “Assign clients to questionnaires”
+Check the box that intersects the client's name and the + questionnaire +
+Click on “Submit query” to confirm the assignment
+queXS: +Installation
+Server
+PHP version 5 or greater
+AdoDB
+MySQL version 5 or greater
+Client
+Firefox web browser
+Server
+Asterisk server (only tested with 1.4 or greater)
+Client
+SIP client with auto answer (I recommend pjsua)
+Extract tar ball or zip file to a directory on your web + server
+Security warning:
+queXS does not have any intrinsic security, so relies on the + web server for authentication
+Set up a form of authentication such as basic username + password authentication
+Make sure to secure the entire installation to trusted + users/operators
+Secure the /admin subdirectory to trusted administrators + only
+Create the database structure by using the database/quexs.sql + file on your mySQL database server.
+It is recommended to create a database user with privileges + only to the queXS database
+Edit the config.inc.php file to point to your database and + your local web paths
+Edit the db.inc.php file to point to your AdoDB installation
+Edit the include/limesurvey/config.php file to point to your + database and local web paths
+The limesurvey database can be the same as the queXS + database, as it will create tables with a prefix
+Make sure this database information is the same as in the + queXS config.inc.php file for the LIME_DB fields
+Open a web browser, and browse to the queXS installation + subdirectory include/limesurvey/admin/install
+Follow the on-screen instructions to install LimeSurvey
+Remove the include/limesurvey/admin/install directory from + the web server +
+Browse to the admin directory of the queXS installation in a + web browser to begin administering the queXS system
+| description | +Plain language description | +delay | +outcome type | +tryanother | +contacted | +tryagain | +eligible | +require_note | +calc | +outcome_id | +aapor_id | +
| Time delay in minutes | +Whether to try the next number on the list | +Whether or not the phone picked up | +Whether to try this number ever again | +If the respondent is eligible to participate | +Whether to require a note to be entered | +Which AAPOR calculation to assign to | +|||||
| Not attempted or worked | +Didn't dial this number - need to exit (for example to start a break/ end work for the day) | +0 | +Temporary | +Yes | +No | +Yes | +No | +No | +UH | +1 | +3.11 | +
| No answer | +No one answers, either rings out or is busy | +180 | +Temporary | +Yes | +No | +Yes | +Yes | +No | +UH | +2 | +3.13 | +
| Technical phone problems | +The telephone system tells you an error - please enter this in the notes | +180 | +Temporary | +Yes | +No | +Yes | +No | +No | +UH | +3 | +3.16 | +
| Other, Referred to Supervisor (Eligible) | +A person has answered, but this needs to be referred to the supervisor | +0 | +Supervisor | +No | +Yes | +Yes | +Yes | +Yes | +O | +4 | +2.34 | +
| Other, Referred to Supervisor (Unknown eligibility) | +This case should be referred to the supervisor | +0 | +Supervisor | +No | +No | +Yes | +No | +Yes | +UO | +5 | +3.91 | +
| Soft Refusal, Other | +A refusal such as "The person doesn't feel like doing it" | +10080 | +Refusal | +No | +Yes | +Yes | +Yes | +Yes | +R | +6 | +2.111a | +
| Hard Refusal, Other | +A refusal such as "The person does not want to do it, do not call again" | +10080 | +Refusal | +No | +Yes | +Yes | +Yes | +Yes | +R | +7 | +2.111b | +
| Soft Refusal, Respondent | +A refusal such as "I don't feel like doing this questionnaire" | +10080 | +Refusal | +No | +Yes | +Yes | +Yes | +Yes | +R | +8 | +2.112a | +
| Hard Refusal, Respondent | +A refusal such as "I do not wish to do this questionnaire, do not call again" | +10080 | +Refusal | +No | +Yes | +Yes | +Yes | +Yes | +R | +9 | +2.112b | +
| Complete | +When the questionnaire is complete. This is usually automatically selected by the system | +0 | +Final | +No | +Yes | +Yes | +Yes | +No | +I | +10 | +1.1 | +
| Known respondent refusal | +Only use this outcome if you are a refusal converter | +0 | +Final | +No | +Yes | +Yes | +Yes | +No | +R | +11 | +2.11 | +
| Household-level refusal | +Only use this outcome if you are a refusal converter | +0 | +Final | +No | +Yes | +Yes | +Yes | +No | +R | +12 | +2.11 | +
| Broken appointment (Implicit refusal) | +If on an appointment and nobody answers the phone | +10080 | +Refusal | +Yes | +No | +Yes | +Yes | +No | +R | +13 | +2.112c | +
| Disconnected number | +Telephone system says this number is disconnected | +0 | +Final | +Yes | +No | +No | +No | +No | +14 | +4.32 | +|
| Fax/data line | +A fax or modem answers the phone | +0 | +Final | +Yes | +Yes | +No | +No | +No | +15 | +4.2 | +|
| Business, government office, other organization | +This number is for a business, that is not relevant to the respondent | +0 | +Final | +Yes | +Yes | +No | +No | +No | +16 | +4.51 | +|
| No eligible respondent | +The respondent is not available on this number | +0 | +Final | +Yes | +Yes | +No | +No | +No | +17 | +4.7 | +|
| Accidental hang up or temporary phone problem | +An accidental hang up has occurred, you may call again | +0 | +Temporary | +Yes | +Yes | +Yes | +Yes | +No | +O | +18 | +2.35a | +
| Definite Appointment - Respondent | +Appointment is scheduled with the respondent for a definite time | +0 | +Appointment | +No | +Yes | +Yes | +Yes | +No | +R | +19 | +2.12a | +
| Definite Appointment - Other | +Appointment scheduled by a household member for the respondent at a definite time | +0 | +Appointment | +No | +Yes | +Yes | +Yes | +No | +R | +20 | +2.12b | +
| Unspecified Appointment - Respondent | +When an appointment is scheduled by the respondent for a general, unspecific time | +0 | +Appointment | +No | +Yes | +Yes | +Yes | +No | +R | +21 | +2.13a | +
| Unspecified Appointment - Other | +Appointment is scheduled by a household member for the respondent at an unspecific time | +0 | +Appointment | +No | +Yes | +Yes | +Yes | +No | +R | +22 | +2.13b | +
| Household answering machine - Message left | +Left a message on the answering machine - only if prompted to | +180 | +Temporary | +Yes | +Yes | +Yes | +Yes | +No | +NC | +23 | +2.22 | +
| Household answering machine - No message left | +Answering machine answered, but did not leave a message | +180 | +Temporary | +Yes | +Yes | +Yes | +Yes | +No | +NC | +24 | +2.22 | +
| Respondent Dead | +The respondent is reported as being deceased | +0 | +Final | +No | +Yes | +No | +Yes | +No | +O | +25 | +2.31 | +
| Physically or mentally unable/incompetent | +Respondent not in the country, or have a mental or physical impairment (not language) | +0 | +Final | +No | +Yes | +No | +Yes | +No | +O | +26 | +2.32 | +
| Household level language problem | +Cannot get through to the respondent: members of the household cannot speak English | +0 | +Final | +Yes | +Yes | +No | +Yes | +No | +O | +27 | +2.33 | +
| Respondent language problem | +When the respondent cannot answer the questionnaire as they cannot speak English | +0 | +Final | +No | +Yes | +No | +Yes | +No | +O | +28 | +2.33 | +
| Answering machine - Not a household | +Answering machine makes it clear you called a business unrelated to the respondent | +0 | +Final | +Yes | +Yes | +No | +No | +No | +UH | +29 | +3.14 | +
| Out of sample | +Not the right age, already completed using another mode (eg on paper)) | +0 | +Final | +No | +Yes | +No | +No | +No | +30 | +4.1 | +|
| Non contact | +Respondent not currently available on this number and no appointment made | +180 | +Temporary | +Yes | +Yes | +Yes | +Yes | +No | +NC | +31 | +2.2 | +
+
+
queXS +for Windows is simply the queXS +package with all the required executable files and configuration to +run “out of the box”. This functionality is provided by +the XAMPP +package. I have simply packaged queXS +using XAMPP, +and added ADOdb
+
+
It may be useful for +testing and temporary use – but please note that XAMPP +is not necessarily secure, and may need to be modified for secure +use.
+
+
Download the queXS + for Windows package from SourceForge
+Execute the file to + extract it to a root directory (such as c:\ ) or a + usb stick root directory (eg e:\ ) - It is a 7zip + compressed self executable file
+Please note you will + need at least 250Mb free
+Go to the directory: + xampplite
+
+
Execute the file + “mysql_start.bat”
+Execute the file + “apache_start.bat”
+Go to: + http://localhost/forbidden/quexs/admin/ + in your browser
+Note you will need to + use the default credentials of:
+Username: adam
+Password: adam
+Follow the queXS + administration documentation here: + http://quexs.sourceforge.net/documentation/administer.xhtml
+Run queXS as a user by + browsing to: http://localhost/forbidden/quexs/
+
+
Execute the file + “apache_stop.bat”
+Execute the file + “mysql_stop.bat”
+
+
Edit the file + xampplite\htdocs\forbidden\.htpasswd and add usernames and passwords + in the format username:password
+Make sure to let queXS + know about the new users by going to: + http://localhost/forbidden/quexs/admin/ + and updating the user list
+
+