Enquette Documentation

Enquette

This documentation is powered by the Dispute component based on the pj DataProvider and the pj DataProvider Framework respectively.

Description:

The Enquette consists basically of one or more pairs of question item and evaluation control, eventually organized in more layers. It either lets the visitor to choose his votes or it displays results statistics together with distribution graphics.

The Enquette can be implemented either as a component (menu) or as a part of Joomla content (article). An important feature is the export in the Office Open XML format (e. g. MS Excel) enabling further processing with external tools.

Administrate Enquette:

  1. Have a look at the Enquette Anatomy
  2. Purchase and Install Enquette package
  3. Create Enquette Menu, Create Enquette Module or Append Enquette to an Article
  4. Set up Enquette
  5. Optionally, Invite selected respondents
  6. Download / upload Enquette
  7. Work up results with Excel
 
Install Enquette package
 
Enquette Anatomy
 
Select Enquette
 
Set up Enquette
 
Enquette Properties
 
Enquette Layers
 
Layer Questions
 
Evaluation Schemata
 
Manage Visitors

Back to Set up Enquette

Continue with Invite selected respondents

Continue with Enquette Properties

Continue with Enquette Layers

Continue with Evaluation Schemata

Continue with Enquette Labels

Visitors

On the Enquette Setup page, at the Tab Visitors, you can manage Enquette Visitors.

Visitor is a concept parallel to Joomla! User. It keeps track on visitors which have responded to some Joomla! Extension using it. Registered users are identified as Visitor by their User data. Unregistered users are asked to identify by name and mail address first time they respond and their subsequent responses are linked to this record.

 

Select display options
Show

Select visitors to display.

  • This Enquette shows Visitors they have responded to some of this Enquette Questions.
  • Invited shows visitors they have been selected to be sent an invitation (see Invite selected respondents) regardless of their hitherto responses.
  • Not invited shows visitors they have not been selected to be sent an invitation, but have provided a response to this Enquette.
  • All shows all Visitors. As the Visitors concept can be used also by another extensions, Visitors referenced there will be displayed, too.
Action Button

Depending on the Show selection, the action button performs various tasks on marked Visitors.

  • At This Enquette selection, the button displays Remove Visitors' Votes. If clicked, all votes to this Enquette provided by marked visitors will be removed.
  • At Invited selection, the button displays Remove from Invited. If clicked, marked visitors will be removed from the invitation list.
  • At All or Not Invited selection, the button displays Invite. If clicked, marked visitors will be added to the invitation list.

Visitors Legend
ID Visitor's unique ID
Visitor Visitor name. If this is a registered user, the name is passed from the Joomla user. Otherwise, this is the name he / she has entered as identification.
Mail Visitor mail. If this is a registered user, the mail is passed from the Joomla user. Otherwise, this is the unverified email he / she has entered as identification.
User If this is a registered user, the link opens the User record for editing.
Language The site language the visitor used last time when active.
Votes Count of Visitor's votes to this Enquette.
All Count of Visitor's votes to all Enquettes.
Last Access Last time the visitor was active. It may mean his last voting to any Enquette or the last activity in an another extension.
IP IP Addresses the visitor was active from.
 
Invite selected respondents

Back to Set up Enquette

Back to Manage Visitors

Continue with Enquette Properties

Continue with Enquette Layers

Continue with Evaluation Schemata

Continue with Enquette Labels

There are several controls at the bottom part of the Visitors Tab at the Setup Enquette page enabling download and upload invited visitors and sending invitation mails.

The invitation mechanism consists in personalized links to the Enquette page, containing the Visitor's language and a token, which unambiguously identifies the Visitor.

There are three tasks related to the invitation mechanism:

Download Invited

If there is an actual version of the download file, it is offered as a download link. Otherwise, the button Create appears and the file will be created.

The file is an Excel workbook saved in XML format. It contains two worksheets: Invited with invited Visitors and Invitation with the Invitation Text.

The Invited worksheet contains columns with the Visitors' ID, Name, Mail, Language, formatted Mail address and a personalized Enquette link.

The Invitation worksheet contains the ID and all language versions of the Invitation Layer Text (see Enquette Layers) set in the Invite part.

You can use this data to send personalized invitations by other means than the Enquette's Invite mechanism. And even if there are no invited Visitors and no Invitation text selected, the empty file is a good template for uploading.
Upload Invited

The upload file has to be an Excel Xml file (Office Open XML). A previously downloaded one is a suitable template.

The file may contain a list of invited visitors in the worksheet named Invited and / or the Invitation Text in the worksheet named Invitation. Any other worksheet is ignored.

The Invited worksheet, if present, has to contain field names in the first row. Only following fields (in any order) take effect, any other column is ignored:

  • visitor_name: obligatory
  • visitor_mail: obligatory
  • visitor_language: optional. The ISO code of one of installed languages (e.g. "en-GB", "de-DE" etc., case insensitive). This is the language the Visitor will receive his invitation in. If there is no language set or the language isn't installed, the invitation comes through in the admin's language.
  • visitor_id: optional. If the visitor_id is set, the corresponding Visitor will be invited (if exists) and the rest of data is ignored. In other cases, the Visitor is searched for by visitor_mail. If not found, a new Visitor with visitor_name is created.

Beware using sheets with visitor_id from other sites, as it denominates foreign Visitors. Delete or clear the column in such case.

The Invitation worksheet, if present, has to contain following names in the first row and following data in the second row:

  • ttext_id: optional. If the file originates in the same site and in the same Enquette and ttext_id in the second row is set, the corresponding Layer Text (if exists) is taken. In other cases, a new Layer Text is created.
  • ISO language codes in the first row and corresponding text language versions in the second row.
Note: the uploaded data takes effect only after the Enquette is saved. Do not Invite Visitor before saving it, as there are no valid links for new Visitors yet.
You can discard the upload any time selecting Cancel on the Enquette's Tool bar.
Invite

Invitation Layer Text: Select the ID for the Invitation Layer Text (see Enquette Layers).

There are several personalizing tokens the Invitation Text may contain:

  • "{subject subject-text}": The email subject (no parenthesis around subject-text). If not present, the Enquette Title is used.
  • "{visitor}": Will be replaced with the Visitor's name
  • "{url}": Will be replaced with the personalized Visitor's Enquette link
  • "{admin}": The Admin's name
  • "{date}": Current Date / Time
  • "{deadline}": Enquette's Deadline

Invite: Send Invitations to invited Visitors

 

 
Enquette Labels
 
Download / upload Enquette