2023:Send Mail (Activity)

From Grooper Wiki

This article is about an older version of Grooper.

Information may be out of date and UI elements may have changed.

202520232.80

forward_to_inbox Send Mail is an Activity automates email notifications from Grooper based on events and conditions set by a settings Batch Process. Optionally, documents in the inventory_2 Batch may be attached to the generated email.

Send Mail will send one email for each document in scope.  It has mail merge support for "To", "CC", "Subject", and "Body".

Send Mail also supports attachments:

  • Content File: Optionally attach the document content.
  • Metadata: Optionally attach the document metadata.
  • Text Content: Optionally attach a plain text version of the document.


Glossary

u>Activity: Grooper Activities define specific document processing operations done to a inventory_2 Batch, folder Batch Folder, or contract Batch Page. In a settings Batch Process, each edit_document Batch Process Step executes a single Activity (determined by the step's "Activity" property).

  • Batch Process Steps are frequently referred by the name of their configured Activity followed by the word "step". For example: "Classify step".

Batch Process: settings Batch Process nodes are crucial components in Grooper's architecture. A Batch Process is the step-by-step processing instructions given to a inventory_2 Batch. Each step is comprised of a "Code Activity" or a Review activity. Code Activities are automated by Activity Processing services. Review activities are executed by human operators in the Grooper user interface.

  • Batch Processes by themselves do nothing. Instead, they execute edit_document Batch Process Steps which are added as children nodes.
  • A Batch Process is often referred to as simply a "process".

Batch: inventory_2 Batch nodes are fundamental in Grooper's architecture. They are containers of documents that are moved through workflow mechanisms called settings Batch Processes. Documents and their pages are represented in Batches by a hierarchy of folder Batch Folders and contract Batch Pages.

Send Mail: forward_to_inbox Send Mail is an Activity automates email notifications from Grooper based on events and conditions set by a settings Batch Process. Optionally, documents in the inventory_2 Batch may be attached to the generated email.

Text Templates

When configuring the "To", "CC", "Subject", or "Body" property, you have the option of using new text templates to dynamically construct your message.

When composing your template, typing the { character will open the Intellisense menu and provide a list of merge variables that can be used.

{Batch Name} Returns the name of the batch.
{Batch Process Name} Returns the name of the Batch Process.
{Content Type Name} Returns the name of the content type assigned to the current document.
{Document Name} Returns the display name of the document.
{Field} Returns the value of a field.
{File Extension} Returns the file extension associated with the current document.
{File Name} Returns the filename associated with the current document.
{Flag Message} Returns the flag message attached to the current document.
{Media Description} Returns a description for the MIME type associated with the current document, if one is available.
{Media Type} Returns the MIME type associated with the current document.
{Now} Returns the current local date/time.  An optional "Format" parameter defines the text prepresentation to be used.
Writing a "Body" template.
The resulting email