The List Item Emailer Wizard, introduced in the Winter 2006
release of the Workplace Suite, is used to configure email notification
directly in SharePoint. In the past, if you wanted to configure email
notification, you would have had to access the List Item Emailer (LIE) web part
in FrontPage to modify the properties and configure emails, then return to
SharePoint.
With the LIE Wizard, all of the
properties that were previously only accessible via FrontPage are now presented
on a single administration screen (see 0List
Item Emailer Wizard PropertiesHelp_D2HPrivate(-9,1795)List
Item Emailer Wizard Properties0). Lists and libraries are
still email-enabled via FrontPage, but once that has been done and the list or
library saved as a template, the new LIE Wizard keeps the process within
SharePoint. You can place the LIE Wizard
on a page and use it to configure email notification on all of your lists from
a single location.
Once email notification has been configured, an email can be
sent to the identified individual(s) each time an item in the email-enabled
list is added or modified. The person who adds or modifies the list item has
the option to send an email, define the content of the message, and specify who
to send it to.
Last Modified: DATE \@ "MMMM yy" October 06
When you first
access this web part, only the first two fields are displayed.
1. Use the List
URL property to identify the URL where the email-enabled list is
located and then select Get
Lists. If the list you want to work with is on the current site, you
can leave the field blank. All of the current site’s email-enabled lists are
already loaded into the drop-down below this field.
· If
you do not see the list you want to work with here, see the Appendix of the
CorasWorks Workplace Suite Capabilities Guide for procedures to email-enable a
list. The Capabilities Guide is included in the Workplace Suite download and
also available in the Support area of CorasWorks Central.
2. Select the list you want to work with from the
drop-down labeled Select
an email-enabled list. Once this has been done, the Wizard interface
is expanded.
· Only
the email-enabled lists in the identified URL will be listed in the drop-down
field.
· The
properties on the Wizard interface are described in 1List
Item Emailer Wizard PropertiesHelp_D2HPrivate(-9,1795)List
Item Emailer Wizard Properties1.
3. When you are finished making your changes,
select Update to save
them. The next time an item is added or modified in to the affected list, an
email notification that utilizes your changes will be sent.
Email
Notification provides several list templates for email-enabled lists,
including:
· Announcements
· Contacts
· Documents
· Events
· Links
· Tasks
These steps
explain how to use these list templates to create an email-enabled list. If you
are working with a different type of list or a custom list, the Appendix of the
Capabilities Guide includes procedures entitled “How To: Email-Enable a List or
Library.” The Capabilities Guide is included in the zip file downloaded from
CorasWorks, and it is also available in the Support section of CorasWorks Central.
(If you do not
have an ID and password for CorasWorks Central, please contact our Support team
at support@corasworks.net.)
1. Go to the site where you want to create the list.
2. Expand the Lists section of the Workplace View Advanced and select Create
List. The Create Page is displayed, with the lists and
library templates you can use.
3. Select Lists from the menu on the left
side of the page, and then select the name of the appropriate
template.
4. Type a name for your new list in the Name field.
5. Provide a description that makes it clear that this list is email-enabled
and then click Create. The list is created in your SharePoint site
and will be displayed on your screen.
You have added
an email-enabled list to your SharePoint site that is ready for use.
NOTE: You can also email-enable your
own lists and libraries; you do not have to rely solely on the email-enabled
list templates provided by CorasWorks. Detailed procedures to email-enable a
list are provided in the Appendix of the CorasWorks Workplace Suite
Capabilities Guide, which is included in the Workplace Suite download and also
available in the Support area of CorasWorks Central.
This section
explains how to send an email by creating an item and notifying someone about
it.
1. Access the list and click New Item. Fill out the fields as usual and note the
following email-related fields:
· Send Email: A Yes or No choice
· Message: The body of the message
to be sent to the person to whom you assign the task
· Assigned To: Who the task is assigned to (and the email will
be sent to)
o To use a cross-site group, the site
must be set up with unique permissions and the cross-site group must be given
rights to that site.
· CC: The person to be copied on
the email
· History: Will contain the audit
trail information, empty for now
o This field is NOT supported for
document or picture libraries because SharePoint limits a
multi-line field in libraries to 254 characters.
2. Select Yes from the Send Email field, if it is not already selected.
3. Type the content you want to include in the email in the Message
field.
4. Select the Assigned To and the person to CC.
5. Click Save and Close. A pop-up box is displayed briefly,
stating “Checking Email,” and then you are returned to the task list.
NOTE: If you do not see the pop-up box,
it may be blocked by your browser settings. You can modify these settings via
the browser’s Tools menu. Also check Spam blocker settings if messages do not
appear to be received successfully via email.
Audit logging
is turned on by default, so you will see that an entry has been made in the
History field of the task. The entry
will state the person and date and time that it was modified. You can modify this to add any fields to
include the message. (See 2List Item Emailer Wizard PropertiesHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties2.)
One topic for
which CorasWorks Support receives a number of calls is the Optional Email
Process. As described in the 3List Item
Emailer Wizard PropertiesHelp_D2HPrivate(-9,1795)List
Item Emailer Wizard Properties3, this allows you to
define different emails to be sent based upon the value in a particular column
of the email-enabled list. It directs the List Item Emailer web part to look at
the value in the identified column and, based on that value, send the
appropriate email message to the identified recipients.
NOTE: With the Optional Email Process,
emails will be sent only when the individual list item is opened and then
closed. Emails will not be sent based on a filter (e.g., Due Date) if the item
has not been opened, or if the item is opened and closed in Datasheet mode.
This topic
provides the code for a series of messages to be sent based upon the values
within the Status column of a task list. A different message will be sent to
the appropriate audience for each possible value. The messages will be
formatted using HTML, including code for using a table to format the data. Of
course, you can customize this example to fit your needs and the steps in your
processes.
There will be
a total of five steps to the process, one for each Status type, as defined in
the table below. This table shows the values and title of each message to be
defined.
Status Value |
Message Sent To |
Title of Notification |
Not
Started |
To:
Assigned To CC:
Person Creating Task |
Task
has been Assigned |
In
Progress |
To:
Assigned To CC:
manager@abc.com |
Task
has been Started |
Completed |
To:
Assigned To |
Task
has been Completed |
Deferred |
To:
Person Creating Task CC:
manager@abc.com |
Warning
– Task has been Deferred |
Waiting
on Someone Else |
To:
Person Creating Task CC:
Assigned To |
Warning
– Task is Waiting on Someone Else |
You can start
with the code for the Not Started message:
Status#;Not Started#;Assigned To#;Created
By#;Created By#;Task has been Assigned#;The following task has been assigned to
you.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
Look at this
code before you go any further to make sure you understand what it is doing. As
is stated in the 4List Item Emailer
Wizard PropertiesHelp_D2HPrivate(-9,1795)List
Item Emailer Wizard Properties4 topic, the format for
each entry in the Optional Email Process is:
Field#;Value#;Email To#;CC#;Email
From#;Subject#;Body
So, if you
look at the sample code above, it can be broken down as described here:
Parameter |
Usage |
Value in Process |
Field |
Column
name referenced by the process |
Status |
Value |
Value
within column |
Not
Started |
Email
To |
Destination
of the notification |
Assigned
To |
CC |
Another
address |
Created
By |
Email
From |
Source
of email |
Created
By |
Subject |
Title
of email message |
Task
has been Assigned |
Body |
Format
of email body |
HTML-encoded
body with column values |
This process
looks at the Status column. When the Status is set to “Not Started,” a
notification message will be sent with the following settings:
· It
will be sent to the value within the Assigned To column
· A
copy will be sent to the address found within the Created By column
· The
“Created By” person will also be listed as the originator of the message
· The
title of the message is “Task has been Assigned”
The body of the
email is HTML-encoded, using a table with rows and cells. Within the cells are
text and the values from the identified columns. So the body of the message
includes:
· Line
of Greeting: The following task has been assigned to you.
<br>
· Starting
of an HTML table: <table border=”1” width=”100%”>
· Creating
of Rows and Cells: <tr> <td width=”111”>…</td>
</tr>
· Value
Identifiers: <font face=”Arial” size=”2”>Task
Title</font>
· Column
Values: <*=Description*>
The message
that is sent has the formatting of a table that includes the values of the
columns. It is not required that the notification be formatted using HTML code,
but the resulting notification is placed within a table and is easy to read.
Now, you can
easily add the code for the remaining steps in the process (the other possible
status values) by copying, pasting, and modifying the sample code above.
If you want
to start with the sample code provided above for the Not Started, you can copy
and paste it for each step in the process. If you have your own code, copy and
paste that. Make sure you type <NEW> at the end of each process. So you
would copy the first set of code, type <NEW>, and then paste and make the
necessary modifications to the status, destinations, title, and body. Then
repeat.
For the
example described above, the final code looks like this. As the task moves
along through each status, a different message is sent.
Status#;Not Started#;Assigned To#;Created
By#;Created By#;Task has been Assigned#;The following task has been assigned to
you.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
<NEW>
Status#;In Progress#;Assigned To#;manager@abc.com#;Created By#;Task has been Started#;The
following task has been started.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
<NEW>
Status#;Completed#;Assigned To#;Created By#;Created By#;Task has been Completed#;The
following task has been completed.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
<NEW>
Status#;Deferred#;Created By#;manager@abc.com#;Created By#;Warning - Task has
been Deferred#;The following task has been deferred.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
<NEW>
Status#;Waiting on Someone Else#;Created By#;Assigned To#;Created By#;Warning -
Task is Waiting on Someone Else#;The following task is waiting on someone else.<br>
<table border=”1” width=”100%”>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Title</font></b></td><td><*=Title*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Assigned
To</font></b></td><td><*=Assigned To*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Description</font></b></td><td><*=Description*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Due
Date</font></b></td><td><*=Due Date*></td>
</tr>
<tr> <td width=”111”><b><font face=”Arial” size=”2”>Task
Link</font></b></td><td><a href=<*=ItemURL*>>Click
Here</a></td> </tr>
</table>
There are five sections of properties on XE "Web Part Properties:List Item Emailer
Wizard" the
LIE Wizard interface:
· 5Emailer
PropertiesHelp_D2HPrivate(-9,1604)Emailer
Properties5
· 6Audit
PropertiesHelp_D2HPrivate(-9,1605)Audit
Properties6
· 7Override
PropertiesHelp_D2HPrivate(-9,1606)Override
Properties7
· 8Optional
Email ProcessHelp_D2HPrivate(-9,1607)Optional
Email Process8
· 9Language
PropertiesHelp_D2HPrivate(-9,1619)Language
Properties9
· 10Response
PropertiesHelp_D2HPrivate(-9,1608)Response
Properties10
When this property is enabled, SharePoint is
used to send email. For most people, enabling
this property provides the most effective way of sending email, and it allows
the email to contain HTML elements.
The default is for this option to be turned
on, which allows the web part to pull configuration information from SharePoint. It uses the internal mail settings that SharePoint uses
when sending alerts. This is useful if
you have utilized an SMTP server that is not on the same machine as SharePoint.
It will not require you to enter the property hostname/IP for your email
server.
If this option is enabled, it will send the email as HTML, so you will
need to place an anchor tag around any URLs in the body of your message. For example:
Before: <*= ItemURL*>
After:<ahref="<*=ItemURL*>"><*=ItemURL*></a>
NOTE: This property
will be deactivated if you enter an email address in the Email From property or
identify server IP or host name in the Server Name property.
This is the Server Name or IP Address that handles all email SMTP
requests. If you have Use SharePoint Email enabled (see above), leave this
field blank. When this field is blank,
the web part will default to the SMTP Service that resides on the same server on
which SharePoint is installed. If you utilize this SMTP Service, make sure you
permit "Relay" for this server.
If you do not use SharePoint email, this property must be
filled in so the web part knows what email server to use when sending
messages. This value can be an IP address (ex: 10.13.99.30) or a server
name (ex: mailserver.coras.net). In either case, the address or name must
point to your internal email server.
This property is populated when a user name may be
referenced in the Primary or Secondary Recipient(s) Field properties (below).
When a user name is referenced, the domain for those users within the workplace
must be identified. This property allows the administrator to identify the
domain so the users do not have to each time they add or edit list items.
For example, rather than requiring the user to remember
and type companyxyz\jdoe, you would enter companyxyz in the Domain property,
and the user could simply type or select jdoe as a recipient.
This property is used to name the field (column) in the list item that
is used to determine the email address to send the email to (usually Assigned
To).
Traditionally, this column corresponds to the "User Lookup" column
within the list, and it is utilized to retrieve the user's email address. This
requires that the user's email address is entered into the "View Information
About Site Users" area of "Site Settings." To
append an email address to a selection box from within your list, place the
email address within brackets [ ]. Example: Approval Required
[approver@company.com] The web part will parse out the email address when the
notification is sent. You can also utilize a single or multi-line text
field that allows users to enter email addresses manually.
· If a user name is identified, the
domain must also be supplied. This can be done via the Domain property (see above).
The LIE Wizard will get the email address from SharePoint.
· Just as you can use this format to
identify an email address: John Doe [jdoe@companxyz.com] you can do the same
with the username. For example: John Doe [companyxyz\jdoe].
· Display names and Active Directory
(groups) are not supported.
· To use multiple values, simply
separate each with a semicolon (;).
· To use a cross-site group, the site
must be set up with unique permissions and the cross-site group must be given
rights to that site.
This property is used to name the field (column) in the list item that
is used to determine the secondary email address(es) to send the email to
(usually CC). The same rules and abilities apply here as to the Primary
Recipient(s) Field above, including the ability to reference a user name or email
address.
NOTE: If you have
Use SharePoint Email enabled, the To and CC selections will both be placed in
the To field of the email.
This property is used to define the subject of the email
that is sent to the user. This can be a
static value or it can be driven by one or more list variables If you want this to include the list name,
use this: <*=List*>
This property is used to define the body of the email to be sent
to the user.
CorasWorks populates the Email Body property with a default
message so you have something to start with, but it can be changed. If you enable the “Use SharePoint Email”
option above, you can include HTML or plain text characters. Any columns in the list can be used,
including custom columns you have created.
As an example, the email body documenting recent updates to
a project could read:
The summary for Project ID: <*Project ID*> has
been updated by <*Modified By*> on <*Modified*><*Return*><*=Return*>
Please note the formatting of variable names.
· List fields should
be encapsulated like this: <*=columnname*>
· Carriage returns
should be encapsulated like this: <*=Return*>
· Other key columns
and syntax:
· Message:<*=Return*><*=Message*><*=Return*>Links:
<*=Return*>
· This returns the
hyperlinked words Record, List, and Workspace:
· <a
href="<*=ItemURL*>"> Record </a><*=Return*>
<a href="
<*=SiteURL*>/<*=ListURL*>"> List
</a><*=Return*> <a href="
<*=SiteURL*>"> Workspace
</a><*=Return*><*=Return*>
· This returns the URL
Strings:
· Item:
<*=Return*><a
href="<*=ItemURL*>"><*=ItemURL*></a>
<*=Return*><*=Return*>
· List:
<*=Return*><a
href="<*=SiteURL*>/<*=ListURL*>"><*=ListURL*>
</a><*=Return*><*=Return*>
· Workspace:
<*=Return*><a
href="<*=SiteURL*>"><*=SiteURL*></a>
Where:
· <*=Return*> =
Carriage Return
· <*=Title*> =
The List Item Title from the list item as set up in the List Item Title property
· <*=CreatedUser*>
= The user who created/modified the list item
· <*=CurrentDate*>
= The date/time when the list item was created/modified
· <*=List*> =
The List Title for the list
· <*=ItemURL*> =
The direct URL to the list Item
NOTE: If you
have enabled either “Send SharePoint Email” or “Send Email As HTML,” you will
need to modify the ItemURL to include an anchor tag. This allows you to hyperlink a field to the
actual item. For example, to hyperlink
the task title, add the following line to the email body:
Link: <a
href="<*=ItemURL*>"><*=Title*></a> <*=Return*><*=Return*>
In this example, the <a
href="<*=ItemURL*>"> handles the encoding of the hyperlink,
while the second <*ItemURL*> tag places the actual URL for the link in
the message. This helps in cases where the user’s email application does not
support hyperlinks.
When sending the user directly to a document within a
library, use the <*=Encoded Absolute URL*> code.
This table provides another way of looking at how to format
the Email Body.
To Display This |
Use This Coding |
Appearance in
Notification |
Value from
Column |
<*=fieldname*> |
Same as
item in list |
Carriage
Returns |
<*=Return*> |
Single line
break |
ID Number
of Item |
<*=
ID*> |
4 |
Site URL* |
<*=SiteURL*> |
http://<<domain>>/<<site
structure>> |
Name of
List/Library |
<*=List*> |
Provides
name of list (i.e. – Tasks) |
URL of List
Within Site URL |
<*=ListURL*> |
Lists/Tasks |
Time/Date
of Last Modification |
<*=Modified*> |
3/10/2006
12:52:27 PM |
User Last
Modifying Item |
<*=Modified
By*> |
Bob Harris |
Time/Date
of Item was Created |
<*=Created
* > |
3/10/2006
12:27:50 PM |
User
Creating Item |
<*=Created
By*> |
Robert
Jones |
Time
Notification was Sent |
<*=CurrentDate
*> |
3/10/2006
12:52:27 PM |
“From” Name
of Sender |
<*=CreatedUser*> |
Frank
Stephens |
Link to the
Item** |
<*=ItemURL*> |
http://<<domain>>/<<site
structure>>/ |
* There is no way to get the name of the site
into the notification message, short of typing it into the “Email Body” field.
** To go directly to the item for editing,
change the value within the “Destination Page” field in the LIE Wizard web part
(or the “Display Form Name” within the LIE web part properties) from dispform.aspx
to editform.aspx.
The value you define here is placed in the “From” line of the email
message. The property is typically left
blank, in which case it defaults to the currently logged in user.
Alternatively, it can be hard-coded (ex: support@corasworks.net). For example, you could specify a manager’s
reply-to address for users to send immediate issues or concerns. If you choose
to hard-code an email address, the Email Server Name/IP Address field must be
completed and the "Use SharePoint Email" option must be disabled.
Issues sometimes arise when there is a mismatch between the
server that sends the email and the return email address in the message,
causing the email to be caught in the Spam filter.
This optional property is used to identify the name of the
email-enabled list. It is utilized by the web part to check the list for
modified items that require an email to be sent. This should be the same name
as the name of the folder that contains the checkemail.aspx file.
This property is typically left blank, in which case the web part will
automatically detect the list name from the list URL. This
alleviates the need to change this value repeatedly if you create a list
template and give your new list a different name.
NOTE: If you
leave this property blank and the list name has been changed since it was
originally created, the list name will no longer match the URL and the auto list detect feature will not function. Also note that
if your list name includes a colon or opening or closing parentheses, these
characters will not make it into the URL and the web part will fail.
This property defines the action to be taken when a
hyperlink in the email is clicked. The
default action is to go to dispform.aspx, which displays the list item’s
information and does not allow editing.
However, this value can be set to any form you want to use to display the
list item. If you want the list item to be immediately sent into Edit Mode,
type "editform.aspx" here.
This property contains the title for the list item that is
sent in the email body. It defaults to "Title,"
which is what the Tasks template utilizes as the Title column, but you can use
any column in the list as the title. For
instance, to enable this for Contacts, you can set this property to "Last
Name" and the value in the Last Name column will be included in the email
message body.
If this option is selected and an error occurs, the error
will be sent to the Application Event Log on the server. The format will tell
which list is causing the error and the error message. It will also provide
trace information that can be used to resolve the error. This is disabled by
default.
11Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties11
This property is used to identify the name of the column
that will be used to store the text for each entry of the audit history. The default is “History.” This must match a multi-line text column name
in the list to allow more than 255 characters to be saved. If this option is left
blank, no audit log will be saved.
This property
is used to define the information to be written to
the audit history field for each entry.
It should be formatted in the same manner as the Email Body. You can use any text and variables
from any of the column in the list, just make sure the column names here match
the ones in your list. The default
format is:
Modified By: <*=Modified By*><*=Return*>Modified On:
<*=Modified*><*=Return*><*=Return*>
If the audit field type does not support
something you define here, you may see the code in the audit history instead of
the value you were expecting.
If you enable Set Audit Column To Read Only, this field will
be invisible to the edit/new item screens, but still visible in the All Items
view.
NOTE: Audit
History is NOT supported for document or picture libraries because SharePoint
limits a multi-line field in libraries
to 254 characters.
If this box is selected, an audit history will be written
every time an item is accessed, regardless of whether an email was sent or an
edit was saved. The default is for this
option to be turned off.
This property
sets the Audit column to read-only, so it can only be
edited by the List Item Emailer (LIE). If you enable this, the Audit column from that
point on will only be visible in a view or a roll-up; the column will be locked
and you will longer be able to see or edit it in a list (version 3.5 only).
Use this option with caution. It cannot be turned off once it has been
enabled.
TIP: Enabling the option to set the Audit column
to read-only can help your organization comply with Sarbanes-Oxley XE "Sarbanes-Oxley" regulations by providing a static record of
notification activity.
12Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties12
This property applies to Issues lists only. SharePoint uses the same ID for all responses
to a particular issue. When this option
is turned on, the web part looks at the type of list being used and if it is an
Issues list, makes sure it behaves as expected.
It makes sure that the item being looked at is the most recent entry for
the issue.
Toggle this property on to render to the browser any errors
that occur after the LIE has been activated. This means that errors will be displayed in
the small notification window, so you need to make sure that "Ctrl A"
- Select All and "Ctrl C" - Copy are ready to be handled because the
window is only open for three seconds:
· As soon as the
window opens, move your mouse to the window and click inside the window
· Type Ctrl-A to
select all text
· Once all text is
selected, type Ctrl-C to copy the selected text
· Open Notepad and
paste the results
This can be used as an alternative to writing errors to the
Application Event Log. It provides the
same details, but does not require administrative access as the Event Log does
and errors can usually be located faster.
By default, the List Item Emailer will set the Send Email
field to Yes when you leave the newform.aspx page or the editform.aspx page,
unless you turn this option on. If this
option is turned off and you type information on the page and then leave it
without saving, it will still send an email to the person identified in the
Assigned To field because Send Email will be set to “Yes.”
This is useful for Issues lists, as when Send Email is reset
to Yes, it creates a new record for that Issue list item. With Issues lists, every change to a column
is saved as a new line item. So whenever
the LIE makes its changes and saved, it creates another new line item in the
list.
This property allows you to send attachments stored within a
list item as attachments in an email, instead of a link. If you are using the List Item Emailer within
a document library, the document will be sent as an attachment within the email,
negating the requirement to link back to the record in your message.
This only applies if you are utilizing the SMTP option of
the List Item Emailer; it will not function with the Use SharePoint Email
property.
Enable this property to allow emails to be sent as HTML
instead of Mime. This can be used with any email program that supports SMTP;
you do not have to use Microsoft Exchange®. When this switch is turned off, emails are
sent as text messages.
If you turn this option on or off, you may need to review
the Email Body settings and edit them to include or exclude certain HTML
properties. Specifically, if you enable this option and the “Use SharePoint
Email” option, you will need to modify the item’s URL setting within the “Email
Body,” setting it to be a hyperlink. If this is not done, the resulting
notification may not have a link back to the item.
13Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties13
The Optional Email Process section allows you to define
different emails to be sent based upon the value in a particular column of the
email-enabled list. It directs the List Item Emailer web part to look at the
value in the identified column and, based on that value, send the appropriate
email message to the identified recipients.
The message and recipients can be different for each
possible column value. This enables you to develop a process whereby
information is validated and sent to users.
NOTE 1: Any
values entered here will replace the values found within the Emailer Properties
section of the List Item Emailer Wizard.
NOTE 2: With the
Optional Email Process, emails will only be sent when the individual list item
is opened and then closed. Emails will not be sent based on a filter (e.g., Due
Date) if the item has not been opened, or if the item is opened and closed in
Datasheet mode.
NOTE 3: See “A Sample Optional Email Process”
for an example of how to define an optional email process.
In past releases, if there were any situations where a
process not identified in the Optional Email Process or the Subject and/or
Body sections were left blank, an email would be sent that used the values
from within the List Item Emailer’s Emailer Properties section. For
example, if your organization utilizes five different task status values and
the Optional Email Process identified four of them, an email would be sent for
the fifth task status using the default settings.
This is no longer the case. If you choose to utilize the
Optional Email Process, then all possible processes, along with the Email
Subject and Body, must be identified. If part of the Optional Email Process
is missed, an email will not be sent for that process.
This property is used to enter the coded process to be
followed. The format for each entry in the Institute Email Process field is as
follows:
Field#;Value#;Email To#;CC#;Email From#;Subject#;Body
The parameters for each entry are defined below. Each
parameter must be separated by “#;” If
you reference multiple email addresses within a parameter, they must be separated
by a semicolon (;). If you choose to
skip an optional field, use #;
If you want to define an email message for more than one
field value, use the <NEW> tag. This denotes the end of an individual
email process and tells the LIE that a new process is beginning. Do not place a
<NEW> tag before the first process. This element is case-sensitive.
NOTE 1: Do not
use the + or ‘ characters within the Optional Email Process area. These
characters are not compatible with the web part. The # character is only
permitted as a parameter separation tool.
NOTE 2: The
values identified in the settings below replace the values found within the
corresponding fields in the Emailer Properties section. The definitions below
detail which fields are replaced with each section of the process string. If
any optional values are not defined in the Email Process section, they will
default to the values in the Emailer Properties section.
(Required) The name of the field that controls the process
(email) to be used.
(Required) The value in the above field that triggers the
email to be sent.
(Required) The field or email address to which the email
should be sent. If you name a field, it will look up the email address in that
field. Alternatively, you can hard-code an address here. If you choose to
hard-code, you can identify multiple email addresses, separated by a semicolon
(;).
NOTE: The ability
to identify multiple email addresses is available only in the Optional Email
Process, and only in the Winter 2006 and later releases.
(Optional) The field or email address to which the email
should be copied. The same rules apply here as to the Email To parameter.
NOTE: This
parameter should be defined in the same manner as the Email To field above.
That means that if you want to use a field name here, you must also use a field
name for the Email To parameter. If you hard-code an email address here, you
must also do so above.
This parameter is for future development. At this time, it
will pull the value from the Email From web part property in the Emailer
Properties. If that is empty, the email will come from the user saving the item.
(Optional) The subject for the message to be sent. This cannot be set to a field value.
(Optional) The body for the message to be sent. If this is
blank, the Email Body web part property (Emailer Properties) will be utilized. The
same rules apply here as to the Email Body property.
Note that any field within the list can be used as part of
the email message’s body, whether it is formatted as HTML or plain text.
Status#;Not Started#;Assigned To#;projectmanager@company.com
<NEW>
Status#;In Progress#;Assigned To#;projectmanager@company.com#;#;Task In
Progress - <*=Title*>#;The following task has been
started<*=Return*>Title: <*=Title*><*=Return*>By:
<*=Modified By*><*=Return*>On: <*=Modified*>
<NEW>
Status#;Completed#;Assigned To#;projectmanager@company.com#;#;Task Completed -
<*=Title*>#;The following task has been completed<*=Return*>Title:
<*=Title*><*=Return*>By: <*=Modified By*><*=Return*>On:
<*= Modified*>
In this example, the Email Subject and Email Body are stored
in the corresponding properties in the Emailer Properties section of the web
part properties.
This coding will cause the following to be done:
· If
Status = Not Started, send an email to the assigned individual and cc
it to the Project Manager from the person who created the task, with the
subject and body that are stored in the web part’s Email Subject and Email Body
properties.
· If
Status = In Progress, send an email to the assigned individual and cc
it to the Project Manager from the person who modified the task. The subject will be "Task In Progress -
Task Title" and the body will be:
The following task has been started
Title: (Task Title)
By: (Person who modified Task)
On: (Time Task was changed)
· If
Status = Completed, send an email to the assigned individual and cc
it to the Project Manager from the person who modified the task. The subject will be "Task Completed -
Task Title" and the body will be:
The following task has been completed
Title: (Task Title)
By: (Person who modified Task)
On: (Time Task was changed)
· If
Status = Deferred, do nothing
· If
Status = Waiting on Someone Else, do nothing
For more examples of the type of information you can use in
a pre-configured email notification, see “Another Way of Looking at This,”
above. Also see “A Sample Optional
Email Process.”
14Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties14
This section contains one property, Language Translation. This
property allows the administrator to alter the web part’s default settings that
are language-dependent.
This property allows the administrator to alter the web
part’s default settings that are language-dependent. It is comprised of the
elements listed below. Each element must be separated by a semicolon (;).
· Send Email
· Modified
· Modified By
· Yes
· No
· Current (Used with Issues lists to
identify the most recent entry on a topic)
Example: Send Email;Modified;Modified By;Yes;No;Current
15Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties15
The Response Properties section allows you to configure a
customized web part response to the user. By default, a pop-up window displays
“Checking Email” whenever an email notification is sent.
This property is used to modify the web part’s response to
the user to utilize HTML or XML. If you utilize this property, it overrides any
text defined in the CheckEmail.aspx page, and any other item displayed on the
page such as web parts, text, and images.
If you want to take the response a step further and include
the web part status messages, enable the Render Error in Output property, set the Response Type (described below) to HTML, and include the <%Output%> variable in your
HTML. (The status message output is not XML-safe.)
Example:
To display the current output in HTML with “Checking Email”:
<html><body><br/><br/><font
size=”3” face=”arial”><b>Checking
Email</b></font><br/></body></html>
Property Setup:
<Response
xmlns=”CorasWSC.List.Item”><![CDATA[HTML]]></Response>
This property allows you to change the type of response
displayed by the web part to the user. Valid choices include:
· text/html
(default)
· text/xml
· text/plain
Property Setup:
<ResponseType
xmlns=”CorasWSC.List.Item”><![CDATA[text/html]]></ResponseType>
16Back To TopHelp_D2HPrivate(-9,1795)List Item Emailer
Wizard Properties16
If you have any questions that are not answered here, please
refer to the Support area in CorasWorks Central.
You can do this in two ways:
· You
can specify a distribution group email address which would be set up on your
Exchange Server
· You
can establish the Assigned to and/or CC column as a choice column, then
identify email addresses (for either individuals or distribution groups) as the
choices. Select the option to display the choices as checkboxes that allow
multiple selections. Now you can select more than one email address, and the
LIE will send the email to all of the selected addresses.
This could be due to several reasons:
· An error is
occurring do to an incorrect setup of the web part. Please verify all
properties correspond to the correct item in the list or email server and try
again. You will know if an error is occurring if the "Send Email"
field does not change to "No" after you have saved the list item.
· Your email server is
not permitting the email be sent through it. Please make sure you specified the
correct email server and try again.
· You did not select
"Yes" for the "Send Email" field.
· You did not specify
a Title within the list item that references the "Title" type field
set up in the web part’s custom properties.
· The list item was added or edited
in Datasheet mode. Email notifications are triggered when the checkemail.aspx
is used and the pop-up is displayed. If the checkemail.aspx is not called, as
is the case when Datasheet mode is used, the email will not be sent.
· You do not have an email address
assigned in the SharePoint system.
· You are signing in to WSS with an
AD account rather than a SharePoint-created account, so there will be no email
address assigned (Site Settings/Go to Site Administration/View User information).
This is also an issue for SPS (Site Settings/Manage Security and Additional
Settings/Show User Information).
This can also occur if your email server is capturing Spam
email message from your SharePoint Server. If you utilize an email address
which does not correspond to the Domain (URL) of the server (e.g.,
yourdomainname.com), then your email server may not permit it since your DNS
states that the email address domain you specified does not correspond to the
IP Address of the domain from which you are sending.
This can occur if your Email Server is capturing SPAM email
message from your SharePoint Server. If you utilize an email address which does
not correspond to the Domain (URL) of the server (ex. corassolutions.com), then
your Email Server may not permit it since your DNS states that the email
address domain you specified does not the correspond the IP address of the
domain you are sending from.
If you enable both “Use SharePoint Email” and “Send Email as
HTML,” you will need to modify the item’s URL setting within the “Email Body”
field, setting it to be a hyperlink. If you do not do this, the resulting
notification may not have a link back to the item.
Emails are sent based upon the default behavior of the form
pages. The CheckEmail.aspx page (the small window that is open whenever
an item is saved) automatically runs whenever the NewForm.aspx or EditForm.aspx
pages are exited. If that page has a value of "Send Email"
equal to Yes, an email is sent. So, if the user does not want to send an email,
they should set the “Send Email” value to No before exiting the page.
This can also occur for another reason. If you open a new
item and then either close it or use your browser’s Back button, the LIE will
look at the last item that was either edited or created and if the Send Email
setting is set to Yes, it will send an email for that item. To prevent this
from occurring, access the web part properties and locate the Reset Send Email
to No property in the Override Properties section. This property is disabled by
default. Place a check mark in the box to enable it.
If this error occurs before entering the list, it indicates
that the list name located within the "List Name" text box is
incorrect. Please correct it and try again.
If this error occurs after entering the list, it indicates
that the Subject or Body values being used are incorrect. Please check to make
sure that the values you are trying to collect exist within the list and try
again.
This indicates that the user trying to send an email does
not have permission to view the list shown in the email.
This indicates that the user specified in the "Assigned
To" is not a valid user for the site. This can be seen by trying to view
the user within the "Manage Users" administration area.
This can occur if the email server settings are set
incorrectly. You will need to confirm that the "Email Server" text
box is correctly set and that the email server is able to send messages. This
can also occur if the user who tried to send the email does not have an email
address assigned to their account and the "Email From" text box is
empty. Please also confirm that your email server permits relay from your
current SharePoint Server.
Email notification does work in an SPS environment. However, as was stated earlier in this
document, there is a SharePoint limitation that prevents list templates from
working with SPS. The pre-enabled lists
and libraries are for use with WSS or in WSS site collections under a
portal. If you want to email-enable a
list for use with SPS, you will need to add a few fields to the list. (If you are a PASM customer, see procedures
in the How To: Email-Enable a List or
Library document in the Premier section of the CorasWorks Central
site.) Once that is done, you will need
to use FrontPage to make the modifications described in the Capabilities Guide.
Here are some hints and tips that CorasWorks Support has
found valuable in troubleshooting email problems.
· Make sure the field values you
identify correspond exactly to the field names in your list.
· Display Error in Message Window – The Display Error in Message
Window option, in the Override Properties section of the Wizard, can be very
useful as a troubleshooting tool. If you
are experiencing errors and everything looks right, you can add the List Item
Emailer web part to any page (default.aspx, for example) and configure it to
point to the list you are working on. It will tell you if it has an error, but
with more detail than the error log, every time you refresh the page. It will
tell you if the error is before entering the list (which means that the list
name is wrong) or after entering the list (which denotes an incorrect or empty
field value). If it does not throw an
error, after checking all the settings and correcting mistakes, copy the
settings into the web part in the checkemail.aspx.
· Enable the “Use SharePoint Email” option – For most people, the “Use
SharePoint Email” web part property provides the most effective method of
sending email. It allows the web part to
query the SharePoint configuration and use the email information defined there. It will also allow the email to contain HTML
elements.
There are three reasons why email will be sent as straight Mime rather than
HTML:
· You
have an email address specified in the Email From field.
· You
have an IP address specified in the Server IP address line
· You
have not checked the 'Use SharePoint
Email' box
· Not Receiving Email Notifications – If some users receive the
emails and others do not, make sure that the user has an email address assigned
in the SharePoint system.
· If the user is signing in to WSS with an AD account
rather than a SharePoint-created account, there will be no email address
assigned, (Site Settings/Go to Site Administration/View User information). This
is also an issue for SPS (Site Settings/Manage Security and Additional Settings/Show
User Information).
· The following issues were fixed
regarding email notifications and documents in folders, as long as the site utilizes inherited permissions:
o Email
notifications were not sent for documents uploaded into folders of an
email-enabled library, but they were sent for documents loaded into the root
folder
o If
documents were uploaded into a folder and there were documents in the root, a
notification would be sent for the last document placed in the library root by
the same user
o If
a folder was created in the root and the next action taken was to upload a
file to a folder, you could see by rendering to output that the ID of the
item the LIE was trying to send an email for was the ID of the newly created
folder
· The LIE’s optional process logic no
longer ignores the value supplied for the From field in the optional process
definition. In the past, the LIE would only use the value specified as the
Email From on the Checkemail.aspx page. This issue has been addressed. However,
you need to make sure you are using an
SMTP server in place of SharePoint Email for this to work.
· Support for emails sent to a
cross-site group, as long as the sites do
not use permission inheritance. To use cross-site groups, the site must be
set up with unique permissions and
the cross-site group must be given rights to that site.
· Initial release