Background

Aspen Workflow integrates with SMTP-based email systems via our Notes and Actions module.

 

Note Emails

Note emails are notes entered into the system, with at least one email addresses entered into the "Email Note To:" field.  
  • These emails are delivered by the SQL Job "Email Note List", 
  • This job is scheduled to run every 10 minutes by default,
  • The only recipients of the email are the addresses listed in the Email Note To field.  The person adding the note is not, by default, included on the recipients list for the email.
  • If a reminder date is entered, the note is excluded from this job.  See Reminder Emails below.

Thus, note emails should be delivered within 10 minutes or so of adding the note.  

Reminder Emails

Note reminders are notes entered into the system, with a Reminder Date set.
  • These emails are delivered by the SQL Job "Email Reminder List", 
  • This job is scheduled to run daily at 5:00am,
  • The recipients include the people assigned to the Matter, Process and Task that the note is entered into, the person adding the note, and any additional addresses listed in the Email Note To field.

Action Emails

Action emails are queued for delivery whenever the action executes.  For example, an Action set up to send an email when completing a task might queue an email for delivery to the person assigned to the process, with a document attached.

In order to Action to generate Emails and attachments, the following system parameters may be required:

  • emailConnectionString
  • emailDefaultAddress
  • emailServerURL
  • emailUploadPath 

 

Troubleshooting Emails - Basic

Troubleshooting email problem in the following order:
  1. Ensure the MSSQL Email Note List, Email Reminder List and Email Actions jobs have been created, scheduled, and are executing on a regular basis.
  2. Ensure the database in question is being processed by the appropriate job.  For notes, the Main() clause of the job should include a line to process the appropriate database.  For actions, a step in the job must include EXECUTE pQueueEmail for the subject database.
  3. Ensure there are in fact email to be sent.  When sending a note-based email, the Note.EmailSent column is populated only if the email COM component successfully sends the mail to an SMTP server.  Thus, if the EmailSent column is not NULL, the SMTP COM components successfully delivered the note to a SMTP server.

    When sending an action-based email, the ActionQueue.ExecuteDate column is populated only if the aspen.document COM component successfully sends the mail to an SMTP server.
  4. If the email COM component is caching the emails for performance (e.g. using the ASPQMail NT Service), ensure the caching services are running properly.
  5. Ensure the destination SMTP server is correct and accepts non-authenticated emails.
  6. Ensure the recipient email addresses are valid email addresses.

Troubleshooting Emails - Actions

Aspen Workflow uses the "Aspen.Document" COM object to process Action emails.  The stored procedure pQueueEmail calls this COM object for each row in the ActionQueue table where ExecuteDate is NULL.  This pQueueEmail stored procedure is normally executed by the Email Actions job every 10 minutes.

Troubleshoot action emails as follows:

  1. Ensure the action has been created.

  2. Ensure the ActionQueue table is populated.  Pick a Matter, MatterProcess and MatterTask (if necessary) that should have caused the action, and ensure the appropriate trigger steps have occurred.  For example, if the action is based on completing a task, pick a task and complete it.  The ActionQueue table should have a row added to it reflecting the MatterID, MatterProcessID and MatterTaskID causing the action.

  3. Check the ExecuteDate column in the ActionQueue table.  If the action has not been executed, EXECUTE pQueueEmail manually.

    Note:  you can re-try actions simply by updating the ActionQueue.ExecuteDate to be NULL.  For example, if you want to retry ActionQueueID 274, you can enter the following:

    UPDATE ActionQueue SET ExecuteDate = NULL WHERE ActionQueueID = 274.

  4. Monitor the output of pQueueEmail.  If there is an error in generating the email, it will be one of the following:

  • ErrorSource1:  failed to set the ConnectionString property on the COM object
    This indicates that pQueueEmail is setting an invalid connection string in the COM object, so the COM object cannot connect to the database. 
  • ErrorSource2:  failed to set the Person property on the COM object
  • ErrorSource3:  failed to set the ServerURL property on the COM object
    The ServerURL identifies the website that document attachments will be generated from.  Aspen.Document uses ASPHTTP to connect to and retrieve the document body from this server.
  • ErrorSource4:  failed to set the DocumentID property on the COM object
    This is generally caused by setting an invalid document for the COM object.
  • ErrorSource5:  failed to merge the specific document
    Auto-merged documents must be either HTML or RTF documents.  This error could be cause by an invalid PathASP for an HTML document, invalid PathURL for an RTF document, or an attempt at merging a Word document.
  • ErrorSource6:  failed to send the email
    This is typically cause by the use of an invalid or inaccessible SMTP server.
  1. Monitor the recipient list of the email.  The recipient list is determined by executing the following SQL:

    EXECUTE pQueueRecipientList @ActionID, @MatterID, @MatterProcessID, @MatterTaskID, @RecipientList OUTPUT

See Also