2009-08-03
QPL Reference Manual

Warning! This page is in the process of being rewritten for QPL Version 6. It may still have references to QPL Version 5.

The Test Message page performs a number of tests on your message job to determine if it is ready to be sent to the mail queue for processing. These include checking that...

If your job fails any of these tests, you can not send your message to the mail queue. You must go back to the Edit Message page to make corrections and then test your message job again.

It also estimates how many respondents will get your message. You should verify that this is the number you expected! If your query is based on respondents current answers to your questionnaire, then the actual number of messages sent will not be known until the message queue runs your job.

Finally, it immediately sends copies of the message, without any replacement of the embedded data fields, to any email addresses that have been added to any of the default test accounts (i.e., user names test0 through test9). To use this feature, you must update a test account to add an email address before testing your email message.

These tests do not, however, cover everything you should check. For example, it does not test any links to files you may have put into your HTML message, and it does not check the query URL you may be sending respondents as the address of your questionnaire web site. Generally, you will want to modify the query so you use the system to send an email message to yourself. If it works, you can copy that message to a new job, adjust the query to select your respondents, and then send the "live" message job to the mail queue.

Summary

The summary statement at the top of the page tells you how many messages will be sent and the subject that will be used for the message.

Query

This is the SQL query that the mail queue will use when your message becomes eligable for processing (according to the delay you set) to (1) select email addresses from the user accounts and (2) select data from the user accounts and, optionally, the questionnaire data to be used to "fill in the blanks" in your message template.

Reconciled Template and Data Fields

This table compares the data fields you entered in your text and HTML message templates with the data fields that your query selects from your questionnaire project data base. The test page will report errors if each data field used in the templates does not have a matching data field in the query. (The opposite situation, having fields in the query that are not used in the template, does not generate an error though this would not be a good programming practice.)

Message

The Message section shows how your message template how the various parts of your message will be put into an Internet email envelope. This is not how the message will appear to respondents. A respondent's email reader will automatically open the envelope and display the contents as you would expect. (For information on Internet email standards, see the Internet Mail Consortium web site at http://www.imc.org.)

Use this display to check the word-wrapping on your text message. This is the same wrapping that a respondent would see if they received the message. Wrapping in HTML-formatted messages is not important. The message will be rendered in a respondent's email reader according to the HTML tags used.

Attachment

If you are using an attachment, a message will be displayed here that indicates whether the file was found or not. The attachment file must be uploaded to the questionnaire web site before the message job may be sent to the mail queue. Also, on Linux servers, file names are case-sensitive and may not contain spaces.

Recepients

The recepient list shows the user name and email address of everyone who will receive this email message, according to your query settings.

The final list of recepients is not generated, however, until your message is launched from the mail queue (according to the delay you have set in your mail job and when the mail queue is scanned for eligible jobs). So, if your query is based on how respondents marked their questionnaire, some of them may change their answers between the time you have tested your settings here and the time that the mail is actually created and sent thus making this list not entirely accurate -- time marches on! To see the list of who actually were sent messages, click on the View Log button on the Edit Message page after the messages have been sent.

Send

If no errors were found in your message job, then the "Send" button will be displayed at the bottom of the page. If you are satisfied with your message, you can click this button to send the job to the mail queue.

Sending a job to the mail queue also effectively freezes the job: you can no longer make changes to the message or send it again. You may, however, copy the message to a new message job and edit and send that. Or, if the job has not been processed by the mail queue, you can recall the message and then edit and resend the same message.

If errors were found, then the "Send" button is not available and so you can not send the message job to the mail queue.

Comments

The comments you entered on the Edit Message page are repeated here.

Cancel

Click on the satisfied "Cancel" button to go back to the Edit Message page.

Print

Click on the "Print" button to print the Test Message page.