mirror of
https://github.com/ACSPRI/queXS
synced 2024-04-02 12:12:16 +00:00
355 lines
19 KiB
HTML
355 lines
19 KiB
HTML
<body bgcolor="#E5E5E5">
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt; font-weight: 700">You are currently viewing the
|
|
<u>Token Control</u> section of LimeSurvey.</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt">From this point you can view and
|
|
edit the tokens for your survey.</font></p>
|
|
|
|
<p><font style="font-size: 8pt" face="Verdana"><a href="#What are tokens">What
|
|
are tokens</a><br>
|
|
<a href="#Display Tokens">Display Tokens</a><br>
|
|
<a href="#Add new token entry">Add New Token Entry</a><br>
|
|
<a href="#Import/Upload CSV File">Import/Upload CSV File</a><br>
|
|
<a href="#Email Invitation">Email Invitation</a></font><br>
|
|
<font style="font-size: 8pt" face="Verdana"><a href="#Send Reminder">Send
|
|
Reminder</a><br>
|
|
<a href="#Generate Tokens">Generate Tokens</a></font></p>
|
|
|
|
<p><font style="font-size: 8pt" face="Verdana">The following options are
|
|
available from the tokens control main menu bar:</font></p>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/home.png" width="20" height="20"></font></td>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<strong>Home</strong> Click here to close the token control window and view the
|
|
standard administration screen for your survey.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/summary.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Summary</font></strong><font face="Verdana" style="font-size: 8pt">: Click
|
|
here to view a sumary of entries in your tokens table, and to access some
|
|
general database administration features, such as:</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"> </td>
|
|
<td valign="top">
|
|
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="100%" id="AutoNumber2">
|
|
<tr>
|
|
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Set all
|
|
entries to 'N' invitation sent</strong>: </font></td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td><font face="Verdana" style="font-size: 8pt">Deletes all records of
|
|
invitations sent out. Usually done if something goes wrong with your
|
|
email of invitations and you want to try it again.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Delete
|
|
all unique token numbers</strong>: </font></td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td><font face="Verdana" style="font-size: 8pt">Delete all generated
|
|
token numbers</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Delete
|
|
all token entries</strong>: </font></td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td><font face="Verdana" style="font-size: 8pt">Clear the tokens table
|
|
completely</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td colspan="2"><font face="Verdana" style="font-size: 8pt"><strong>Drop
|
|
tokens table</strong>: </font></td>
|
|
</tr>
|
|
<tr>
|
|
<td> </td>
|
|
<td><font face="Verdana" style="font-size: 8pt">Remove tokens from your
|
|
survey. The survey would then be accessible to all.</font></td>
|
|
</tr>
|
|
</table>
|
|
</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/document.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Display
|
|
Tokens</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
|
|
display all token entries</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/add.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Add new
|
|
token entry</font></strong><font face="Verdana" style="font-size: 8pt">: Click
|
|
here to add a new participant to the tokens table.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/importcsv.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Import
|
|
Tokens File</font></strong><font face="Verdana" style="font-size: 8pt">: Click
|
|
here to import a CSV file containing names and email addresses. The CSV file
|
|
must be a standard comma delimited file with no quotations. The first row is
|
|
interpreted as a header row. Order of data should be: Firstname, Lastname,
|
|
Email, [token]. The token field is optional.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/importldap.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Import
|
|
Users from LDAP</font></strong><font face="Verdana" style="font-size: 8pt">: Click
|
|
here to import a users' names and email addresses from an LDAP directory.
|
|
This feature has to be enabled by the administrator in config.php to be available.
|
|
It is also up to the administrator to setup Ldap queries in config-ldap.php.
|
|
</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/invite.png" width="20" height="20"></font></td>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<strong>Send email invitation</strong>: Click here to send email invitations to the
|
|
participants listed in your tokens table.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/remind.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Send email
|
|
reminder</font></strong><font face="Verdana" style="font-size: 8pt">: Click here
|
|
to send email reminders to the participants listed in your tokens table.
|
|
Reminders are only sent to participants who have already been sent an
|
|
invitation.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/tokenify.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Generate
|
|
Tokens</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
|
|
generate unique random token numbers for your participants. Although you can
|
|
manually create token numbers, or import them from a CSV file, it is usually
|
|
recommended that you use this feature as it ensures that there are no
|
|
duplicate entries.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/delete.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Drop Tokens
|
|
Table</font></strong><font face="Verdana" style="font-size: 8pt">: Click here to
|
|
drop the tokens table and remove tokens from your survey. The survey would
|
|
then be accessible to all.</font></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p><font style="font-size: 8pt" face="Verdana"><strong><a name="What are tokens">What are "tokens"</a></strong><br>
|
|
Tokens are a system you can use to have a controlled survey. A controlled survey
|
|
allows you to have a list of 'participants', or people who have been invited to
|
|
respond to the survey, and then control their access to the survey. Each
|
|
participant is issued with a unique token number. This token number gives the
|
|
participant access to the survey.</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt">When tokens are activated for
|
|
your survey, the only people who can access the public survey are those who have
|
|
a 'token' that matches an entry in this table. Using the tokens control section
|
|
of LimeSurvey you can add, remove and modify these token entries.</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt">The LimeSurvey tokens system
|
|
allows you to track who has access to your survey, send out invitations and
|
|
reminders to those participants, and see if they have responded. If you make
|
|
your survey non-anonymous (or tracked) you can also match responses to the token
|
|
entry.</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt"><u><strong><a name="Display Tokens">
|
|
Display Tokens</a></strong></u><br>
|
|
When displaying tokens, you can see all your entries (in lots of 50, or as
|
|
determined by you). The top section of the display is the <strong><i>Data View
|
|
Control</i></strong> menu bar. This menu bar gives you the following options:</font></p>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/databegin.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Show start</font></strong><font face="Verdana" style="font-size: 8pt">:
|
|
Click here to view entries from the beginning of your list.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/databack.png" width="20" height="20"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Show last</font></strong><font face="Verdana" style="font-size: 8pt">:
|
|
Click here to view the previous lot of entries.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/dataforward.png" width="20" height="20"></font></td>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<strong>Show next</strong>: Click here to view the next lot of entries.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt">
|
|
<img border="0" src="../../../images/dataend.png" width="20" height="20"></font></td>
|
|
<td valign="top"><font style="font-size: 8pt" face="Verdana">Show last<font style="font-size: 8pt">:
|
|
Click here to view the very last entries in your list.</font></font></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>
|
|
<font style="font-size: 8pt" face="Verdana">You are also able to set the number
|
|
of tokens displayed, and the starting point of your records using the "Records
|
|
Displayed:" and "Starting From:" fields, then clicking on "Show".</font></p>
|
|
|
|
<p>
|
|
<font face="Verdana" style="font-size: 8pt"><strong>Sorting Display</strong><br>
|
|
At the top of each column when
|
|
displaying tokens, is the name of the field and the 'sort' icon (<img src="../../../images/downarrow.png" width="16" height="16">).
|
|
Clicking on the sort icon will re-order the display of tokens, sorted
|
|
alphabetically by that column.</font></p>
|
|
|
|
<p>
|
|
<font face="Verdana" style="font-size: 8pt"><strong>Actions<br>
|
|
</strong>A set of actions can be performed with each individual token entry. These
|
|
actions are listed below:</font></p>
|
|
|
|
<table border="0" cellpadding="0" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" id="AutoNumber1">
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Edit Token Entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="E"></font></td>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt"><strong>Edit Entry</strong>:
|
|
Click here to edit this entry.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Delete Token Entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="D"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Delete Entry</font></strong><font face="Verdana" style="font-size: 8pt">:
|
|
Click here to delete this entry.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Do Survey" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="S"></font></td>
|
|
<td valign="top"><strong><font face="Verdana" style="font-size: 8pt">Do Survey</font></strong><font face="Verdana" style="font-size: 8pt">:
|
|
Click here to do the survey using this token.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="V"></font></td>
|
|
<td valign="top"><font style="font-size: 8pt" face="Verdana"><strong>View
|
|
Response</strong>:
|
|
Click here to view the response made by this participant (only available
|
|
where applicable).</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="I"></font></td>
|
|
<td valign="top"><font style="font-size: 8pt" face="Verdana"><strong>Invite</strong>:
|
|
Click here to send an invitation to this participant only.</font></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top"><font face="verdana" size="2">
|
|
<input title="Send reminder email to this entry" style="FONT-SIZE: 8px; WIDTH: 16px; HEIGHT: 16px; font-face: verdana" type="submit" value="R"></font></td>
|
|
<td valign="top"><font face="Verdana" style="font-size: 8pt"><strong>Reminder</strong>:
|
|
Click here to send a reminder invitation to this participant only.</font></td>
|
|
</tr>
|
|
</table>
|
|
|
|
<p>
|
|
<span style="font-weight: 700; text-decoration: underline">
|
|
<font face="Verdana" style="font-size: 8pt"><a name="Add new token entry">Add
|
|
new token entry</a></font></span><font face="Verdana" style="font-size: 8pt; font-weight: 700; text-decoration: underline"><br>
|
|
</font>
|
|
<font face="Verdana" style="font-size: 8pt; ">
|
|
With this screen you can create a new token entry, adding an extra participant
|
|
to the list of people who can access the survey. The fields available are:<br>
|
|
<strong>Firstname</strong>: The participants first name<br>
|
|
<strong>Lastname</strong>: The participants last name<br>
|
|
<strong>Email</strong>: The participants email address<br>
|
|
<strong>Token</strong>: The participants unique token. While you can create your own at
|
|
this point, it is better to use the "Generate tokens" feature later, and leave
|
|
this blank.<br>
|
|
<strong>Invite Sent?</strong>: If a "Y" is in this field, the participant will not be sent
|
|
an invitation email when you choose "Invite". If anything else is in here, the
|
|
invitation email will be sent.<br>
|
|
<strong>Completed?</strong>: If a "Y" is in this field, the participant will not be able
|
|
to use the token. When a participant completes the survey, this field is changed
|
|
to "Y".</font></p>
|
|
|
|
<p>
|
|
<font face="Verdana" style="font-size: 8pt">There are no mandatory fields in the
|
|
'add new token' screen. You can include as much or as little information as you
|
|
want. There is no duplicate entry control either, so it is possible to have the
|
|
same name over and over again.</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt"><u><strong>
|
|
<a name="Import/Upload CSV File">Import/Upload CSV File</a></strong></u><br>
|
|
With this feature you can import a CSV file containing names and email addresses
|
|
for use in your LimeSurvey survey. The CSV file must be saved as a comma
|
|
delimited file, without quotation marks and the very first line is always
|
|
interpreted as a header row, so if your file doesn't have a header row, the
|
|
first row will be lost! Your file should look something like this:</font></p>
|
|
|
|
<div align="center">
|
|
<center>
|
|
<table border="0" cellpadding="3" cellspacing="0" style="border-collapse: collapse" bordercolor="#111111" width="300" id="AutoNumber3" bgcolor="#C0C0C0">
|
|
<tr>
|
|
<td width="100%">Firstname, Lastname, Email, Token<br>
|
|
Jason, Cleeland, jason@cleeland.org, <br>
|
|
Bob, Jones, bob@cleeland.org,</td>
|
|
</tr>
|
|
</table>
|
|
</center>
|
|
</div>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt">Note that the final column
|
|
(token) is optional. You can import your own token numbers - this may be useful
|
|
if you want to use another methodology for generating tokens. For example, if
|
|
you are a membership based organisation you could import your members membership
|
|
number as their token.</font></p>
|
|
|
|
<p><u><strong><font face="Verdana" style="font-size: 8pt"><a name="Email Invitation">
|
|
Email Invitation</a></font></strong></u><font face="Verdana" style="font-size: 8pt"><br>
|
|
Use this feature to send invitation emails to all participants in your tokens
|
|
table. Before sending an email, LimeSurvey checks each entry to ensure that the
|
|
following conditions are met:<br>
|
|
a) Email address exists<br>
|
|
b) Token has been generated<br>
|
|
c) An invitation has not already been sent<br>
|
|
d) Participant has not yet completed the survey</font></p>
|
|
|
|
<p><font style="font-size: 8pt" face="Verdana">Each invitation is personalised,
|
|
and is merged with information from the tokens table. You are given the option
|
|
of modifying the subject and text of your email before it is sent out. To use
|
|
information from the tokens table in the body of your email, use the following
|
|
'merge' codes:<br>
|
|
{FIRSTNAME}: First name<br>
|
|
{LASTNAME}: Last name<br>
|
|
{SURVEYNAME}: The name of your survey<br>
|
|
{ADMINNAME}: The name of the survey administrator<br>
|
|
{ADMINEMAIL}: The email address of the survey administrator</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt">For example, if your message
|
|
reads "Dear {FIRSTNAME} {LASTNAME} here is a survey called {SURVEYNAME} for you
|
|
to try. Love {ADMINNAME}" The recipient will receive an email that looks
|
|
something like this: "Dear Saddam Hussein here is a survey called What I Did On
|
|
My Holidays for you to try. Love Jason Cleeland".</font></p>
|
|
|
|
<p><font face="Verdana" style="font-size: 8pt"><u><strong><a name="Send Reminder">
|
|
Send Reminder</a></strong></u><br>
|
|
Use this feature to send reminder emails to all participants in your tokens
|
|
table. Before sending an email, LimeSurvey checks to ensure that the following
|
|
conditions are met:<br>
|
|
a) Email address exists<br>
|
|
b) Token has been generated<br>
|
|
c) An invitation has already been sent out<br>
|
|
d) Participant has not yet completed the survey</font></p>
|
|
|
|
<p><u><a name="Generate Tokens"><strong><font face="Verdana" style="font-size: 8pt">
|
|
Generate Tokens</font></strong></a></u><u><strong><a name="Generate Tokens"><font face="Verdana" style="font-size: 8pt"> </font>
|
|
</a></strong></u><font face="Verdana" style="font-size: 8pt"><br>
|
|
Use this feature to generate unique random token numbers for each entry in the
|
|
tokens table that does not have a token.</font></p>
|