Modifiable DWP Properties

CorasWorks web parts have a number of properties that can be modified by manually editing the DWP file associated with this web part. You can edit a DWP file by exporting the web part to a location of your choice, making the desired changes, and then uploading it back onto your site.

The properties described here allow you to change the function and display of the web part. Please keep in mind the XML namespace of the web part you are changing, or these properties will not be enabled within the web part.  XML namespaces for all CorasWorks web parts are provided in the For Developers help topic.

Also note that some of these properties some may require the use of a "<", ">", or "&" symbol. If that is the case, you will need to replace these characters with their encoded equivalents of "&lt;", "&gt;", and "&amp;" respectively.

These properties are only viewable in the DWP if the default settings have been changed.

ABody (String)

The body of the log that is stored in the list. Currently by default it implements "You have been assigned the following item; Title: <*=Title*><*=Return*>Modified By: <*=Modified By*> <*=Return*>Modified On: <*=Modified*> <*=Return*>------------------------<*=Return*>

 

<*=Return*> - Carriage Return

<*=Title*> - Title Field of List Item

<*=ModifiedBy*> - The user to Created/Modified the List Item

<*=Modified*> - The Date/Time when the List Item was Created/Modified

To alter this property change the text as you want it be presented in the Email. Place in the above tags to present information about the list item to the user. Place in the <*=Return*> to execute a Carriage Return in the body of the email message.

ALog (Boolean)

Log all accesses and/or changes to a list item even if an email is not sent to a user.

ATitle (String)

The list field that will be used to store the Audit Log. This should be a Multiple Line Text Field to allow more than 255 characters to be saved. This function is not available for Document Libraries as the max size of a Multiple Line Text field is 1000 characters. If this option is empty no audit log will be saved.

DFName (String)

The *.aspx page that displays the list item's information. By default this field will be filled in with "dispform.aspx" but can be set up to any form you want that will display the List Item. If you want the List Item to be sent immediately into Edit Mode, type "editform.aspx."

EBody (String)

The body of the email to be sent to the user. Currently by default it implements "You have been assigned the following item; <*=Return*>Title: <*=Title*> <*=Return*> Assigned By: <*=CreatedUser*> <*=Return*>Assigned On: <*=CurrentDate*> <*=Return*>List:<*=List*> <*=Return*>Item URL: <*=ItemURL*> <*=Return*><*=Return*>"

 

<*=Return*> - Carriage Return

<*=CreatedUser*> - The user to 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. This will include the "Display Form Name" that you specified in the "Display Form Name" property.

To alter this property change the text as you want it be presented in the Email. Place in the above tags to present information about the list item to the user. Place in the <*=Return*> to execute a Carriage Return in the body of the email message.

EField (String)

The Field that corresponds to the "User Lookup" field within the list that is utilized to retrieve the user's email address. This requires that the User's email address has been entered into "View Information About Site Users" area of "Site Settings" to send an email to this user.

If you want to append an email address to a choice select box from within you list you can do so by place the email address within a "[" and "]". Example (Approval Required [approver@company.com])

EField2 (String)

The Field that corresponds to the "User Lookup" field within the list that is utilized to retrieve the user’s email address. Utilize this property if you want to CC a user or assign responsibility to the list item to two individuals.

If you want to append an email address to a choice select box from within you list you can do so by place the email address within a "[" and "]". Example (Approval Required [approver@company.com])

EFrom (String)

The Email Address users will recognize as an email from the SharePoint Server. You can also specify a Manager reply-to address for users to immediately respond to for issues or concerns. If this entry is empty, this web part will default to the email address of the user who is currently logged-in and has created/modified a list item that has been emailed to a user.

ErrorEmail (Boolean)

Should errors occur, selecting this option will send an error to the Application Event Log on the server. The format will tell which list is causing the error and the error message and trace information that can be used to debug the error.

EServer (String)

The Server Name or IP Address which handles all email SMTP requests. If this entry is empty, this web part will default to the SMTP Service which resides on the same server with SharePoint installed. (If you decide to utilize this SMTP Service, please make sure you permit "Relay" for this server.)

ESubject (String)

The subject of the email sent to the user. By default, this implements "List Notification - <*=List*>".

<*=List*> - List Title

You can edit this property as necessary and, if you want the List Title to be presented in the Subject, implement the above tag to have it sent within the subject.

HistoryReadOnly (Boolean)

This setting allows you to change the history field to a read-only field that can only be edited by the List Item Emailer. Once you have enabled this, the history field from that point on only be visible in a view or a roll-up. After this has been changed, you can no longer edit this field and it will be locked.

LTitle (String) (2.5 Only)

The List Item Title field that is sent in the Email body. This is a required field and must be set as such in the List. By default, this is set to "Title," which is what the "Tasks" template utilizes as the Title field. But if you want to enable this for Contacts, you can set this to "Last Name" and the Last Name will be sent into the email message body.

Optional - Email Process

The Email Process Property allows you define a filtered value to be confirmed before sending an email to specific individuals with a specific message. This can be different for each filtered value you choose. This enables you to develop a process whereby information is validated and sent to users.

NOTE: 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.

 

EmailProcess (String) - Will Deactivate Assigned To and CC

This property allows you to enter the coded process that must be followed.

 

Parameters

Email = Field#;Value#;Email To#;CC#;Email From#;Subject#;Body

New Entry = <NEW>

 

      Field (Required) = Name of the Field you want to filter on

      Value (Required) = The Value of the field that you want to filter on. Place """ around the value if you want to lock the value to what is stored there otherwise enter the value and it will execute if the value is found in the string. A quoted value will not function if your field is a choice, URL, or lookup

      Email To (Required) = The field or email address you want to send to. This functions in the same way as the User Lookup Field Property

      CC (Optional) = The field or email address you want to CC. This functions in the same way as the Sec. User Lookup Field Property

      Email From (Optional) = 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.

      Subject (Optional) = The subject for the message being sent. If this is blank then the Email Subject Property will be utilized. This functions in the same way as the Email Subject Property

      Body (Optional) = The body for the message being sent. If this is blank, the Email Body Property will be utilized. This functions in the same way as the Email Body Property.

 

<NEW> = If you have more than one filter to be used you can use this to separate each enabled email process. If you do not have more than one process this element is not required and should/must not be used.

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

OverrideIssue (Boolean)

This toggle is designed to allow you to enforce the LIE to recognize this list as an Issues Type List. This is only useful if you have created a new List Definition from the Issues List list definition. Since the name of the original base template changes, this is the only way to indicate that the new list definition will be recognized as an Issues type list and will be handled accordingly.

RenderError (Boolean)

Toggle this property on to render any errors to the browser after the LIE has been activated. Since most of the time this error will be displayed in the small notification window, you will need to make sure that you have "Ctrl A" - Select All and "Ctrl C" - Copy ready to handled. As soon as the window opens, move your mouse to the window and click inside the window. After this, execute the first command to select all text. Once all text is selected, execute the second command to copy the selected text. Open Notepad and paste the results.

ResetSendEmail (Boolean)

By default, the List Item Emailer will reset the Send Email field from Yes to No when a list item is saved. If you do not want this default instance to occur, you can toggle this property off to not reset the Send Email field. This is useful for an Issues List, as when Send Email is reset to Yes, it will create a new record for that Issue List Item.

SendAsHTML (Boolean)

This property allows you to ensure that emails sent using the List Item Emailer will be sent as HTML instead of Mime. This is the same using SharePoint Email, but you are still able to send attachments.

SendAttachments (Boolean)

This property allows you to send attachments stored within a List Item as attachments in an email. If you are using the List Item Emailer within a document library, the document will be sent as attachment within the email negating the requirement for you to link back to the record in your message. This only applies if you are utilizing the SMTP option of the List Item Emailer. This will not function with the Use SharePoint Email property.

TLName (String)

This property is used to identify the list name you want to email-enable. This should be the same name as the folder that contains the "checkemail.aspx" file. This is utilized by the web part to check the list for modified list items that require an email to be sent. You can also leave this field blank to have the list name automatically detected from your list’s URL. This alleviates the need to change this constantly should you create a list template and give your new list a different name.

Use Complex Filter Process (String)

This property was introduced in the Winter 2006 release to allow you to activate filter use in the Optional Email Process.

NOTE: If you choose to use this property, be aware that you must alter the process you have in place in the Enable Optional Email Process property. The change that is required is the use of a filter instead of Field#;Value.

An example would be checking the current status of a task. In the standard Email Process, you would utilize “Status#;Not Started” to confirm the process if the task has not started. With the new process, you are required to use “Status=’Not Started’”. You will notice this filter looks identical to that used in the Calendar, Chart, and Data Publisher web parts.

Usage Example:

Send an email to the Project Manager if a task is assigned and not started. Send it from the person who assigned the item, to the Project Manager with a Subject of “Task Not Started”. In the body of the message, place a URL to the current item:

Status=’Not Started’#;pm@companyxyz.com#;#;#;Task Not Started#;Task <*=ItemURL*> Not Started

Send an email to the Assigned To and CC the Project Manager if a task is assigned and in progress. Send it from the person who modified the item, to the Assigned To and Project Manager with a Subject of “Task Started.” In the body of the message, place a URL to the current item:

Status=’In Progress’#;Assigned To#;pm@corasworks.net#;#;Task Started#;Task <*=ItemURL*> Has Started

UseSharePointEmail (Boolean)

Toggle this property on to utilize SharePoint to send emails. This is useful if you have utilized an SMTP server that doesn't exist on the same machine as SharePoint. It does not require you to enter the property hostname/IP for your email server. This will send the email as HTML, so you will need to modify anything in the body of your message for URLs with an anchor tag around them. Example:
Before: <*=ItemURL*> 
After: <a href="<*=ItemURL*>"><*=ItemURL*></a>

 

Back to Top