Creating an Email Job

To create an Email Job:

  1. Log in to Enterprise Manager as either the Local Administrator or a User with sufficient permissions to work with Email Jobs and the projects they are in.
  2. Expand the appropriate Project
  3. Select the Email Jobs icon
  4. Select Take Action/Add Email Job
  5. After entering the appropriate General and Job Scheduling properties go to the Email Message Tab.
  6. When finished Click Save
  7. When ready to begin the Email Job click the Enable icon in the Email Job Data Grid.

The email job tab of the Project page


Settings Tab

General Email Job Properties


Job Scheduling Properties

Batch Size


NOTE: The mailer frequency is the maximum number of Emails that Illume will send in a specified time period. This setting does not guarantee that the Emails will be sent at the set frequency. It only ensures that Emails will not be sent more frequently than specified.

The Email Job's actual frequency depends on network conditions and the availability of system resources. For example, during periods when the outgoing mail server is busy, the actual rate at which Illume sends Email may be well below the maximum frequency you requested.

Start and Stop Conditions

Email Jobs can be scheduled to start on a specific date, or on a relative date. A relative date is a specified number of days after the participant received Email from another Email Job. Email Jobs can be scheduled to end on a specific date, or when specific conditions are met.


NOTE: Only one type of start condition and one type of stop condition apply. For example, if you click the Save button with a stop date specified, then the stop conditions will not apply.


Email Job start and stop conditions apply only to the Email Job. They do not apply to the survey.

Start Conditions

There are three possible start conditions for an Email Job.  Only one condition may apply for an Email Job.




Stop Conditions




  1. When a defined number of participants have been emailed. This is an absolute number.
  2. When a percentage of the participant list has been emailed. This is a relative number. Once the percentage of the list is reached, the email job pauses. If more participants are added to the list, it will send more emails.
  3. When a defined number of participants complete the survey. This is an absolute number.
  4. When a defined percentage of participants from the participant list finish the survey. This is a relative number and will pause the email job when the percentage is reached. More participants may take the survey after the email job has stopped, as long as the survey remains running. If more participants are added to the participant list, the job may be restarted.


Message Tab


The message in an Email Job can be configured for multiple languages.  The language sent to a specific Participant is based on the Language Definition set for that Participant in the Participant List.

To set a Language:

  1. In the Email Message Tab of the Email Job
  2. Click on the add icon AddIcon.gif next to the Language drop-down
  3. Select the appropriate language from the drop-down and click Add
  4. Repeat as needed
  5. Continue to create the Email Message in all of the languages selected for the Email Job.




The Addresses section will provide a list of possible recipients for the specific Email.  Recipients may include Participants, Case Owners and/or Study Managers.


From - Will be the default From Address configured in the Applications Settings or will provide a drop-down if additional From addresses have been added to the Project by a System Administrator.

Reply To - Will be the same as the From default if left

CC and BCC - Can be added if desired



To compose the text for the email message, click the Email Message tab of the Email Job.


The following fields will be displayed


Composing a Message

The HTML editor allows for the composition of a formatted HTML email using a word-processor style interface. Formatting can be applied by simply highlighting text and clicking buttons or selecting options on the toolbar.


NOTE: There are two tabs on the editor: HTML Body Editor and Plain Text Body Editor.

Adding Images

To add an image to an email message, click the image button EM_EmailInsertImageIcon.gif and specify, at minimum, the URL of the image. When adding images to an email, Illume does not attach the image as part of the message. This means it is important to specify the full URL of the image, which should be on a publicly available web server. (Hint: When clicking the Preview button and the image does not appear in the previewer, the recipients will not be able to see it.)


Personalizing Email Messages

Personalizing an Email Message can be accomplished by piping data from participant lists directly into an email. Illume looks for tags in the email message that follow the format {UserData:FieldName} That is: the word UserData, followed by a colon and the name of the field whose data to insert. All of this must be enclosed in curly braces. Capitalization does not matter.


The HTML editor includes a drop-down to help insert user data.  Click the drop-down to see the user data fields. Choose the user data field to insert.



To insert custom user data from the participant list, choose Custom Column from the drop-down and type in the name of the field at {UserData:ENTER CUSTOM COLUMN} .

Embedding the Survey URL

Email jobs also support a {SurveyURL} tag. This tag will embed a custom survey URL into each email. Illume automatically figures out what information is required for the participant to log in, and it embeds that information in the URL. When a participant clicks on this link, he or she can begin taking the survey without having to log in. Text can be added to the {SurveyURL} tag to display a "friendly" link, rather than a long URL.


For example, the tag {SurveyUrl:click here} would produce the words "click here" as a clickable link. Clicking the link has the same effect as clicking the long survey URL: participants can start responding to the survey questions. Keep in mind, however, that not all participants have HTML enabled mail clients. Those using text-based mail clients will not be able to "click here" to reach the survey. These participants need access to the full survey URL, so they can copy it from the email and paste it into a browser.


The HTML editor includes a drop-down to insert the Survey URL in the email.  Whatever is typed in the Enter Link Text becomes the text of the clickable link.





To embed the raw URL, use {SurveyRawURL} to produce the actual URL of the survey. This is the URL in plain text form. It is not clickable, but participants can cut and paste it into the address field of their browser to go to your survey.


NOTE: Selecting Bare Window will launch the survey in a browser window that has no address bar and no toolbar.

Embedding an Opt-Out Link

To include an opt-out link in the email, use the {OptOutURL} tag, this can be found in the HTML editor under the Survey Link drop down. This tag, like the SurveyURL tag, is a “friendly” link so text can be added for display purposes. Any participant who clicks on this link will be marked as Do Not Contact on that Participant List and any Master or Derived lists that are associated with that list.


Plain Text vs. HTML

Email jobs send "multi-part" messages in two formats: plain text and HTML. Which version the recipient sees depends on their email program and display preferences. If you define an HTML message, and the recipient's email program is configured to display HTML, the recipient will see the HTML version. If the recipient's email program cannot display HTML, or is set to display text only, the recipient will see only the text version. To reach the widest possible audience, include a plain text version of the message.