Generate Email Process

  1. Help
  2. Email Process Designer
  3. Generate Email Process
email attachment

Table of Contents

Overview

The Email Process Designer allows for the creation of email processing tasks that can be associated with button controls. For example, the system can send notification emails when a user creates a new record, edits an existing record, or generates a PDF from the application.

This page aids in defining the properties that will make up the email's contents, as well as the target(s) of the email.

Properties

The section below will outline the properties for the email process.

Name

The Name is simply a friendly identifier provided to the email process to help you subsequently identify this process in contrast with other email processes.

Enabled

Indicates whether the email process is enabled.

This can be configured as Always or Never to indicate whether the email process is statically enabled or not.

Alternatively, if any Boolean Single Named Ranges (SNR) exist (i.e. ranges pointing to a single cell that evaluates to TRUE or FALSE), then the enabled-ness of the email process can be configured to reflect the value of that named range using the 'By Value Of' setting.

Subject Line Type

This input will allow you to choose whether the subject line will be static text or defined as an output from your workbook.

The corresponding values are as follows:

  • Static - The subject line will be a static piece of text that you define now in the Subject Line Static Value textbox, which will become visible upon selection.
  • ByValueOf - The subject line will be dynamic, based on a Single Named Range (SNR) from your workbook. You can select this named range from the Subject Line Named Range Sequence ID dropdown list, which will become visible upon selection.

Send To Type

This input will allow you to choose whether the target recipient of the email will be a single series of static users or dynamically defined by the value of a named range within your workbook.

The corresponding values are as follows:

  • Static - The recipient will be a static series of users defined immediately from the Send To Static Value textbox, which will become visible upon selection. Only users defined in the SpreadsheetWeb system can be selected.
  • Dynamic - The recipient will be dynamic, based on a Single Named Range (SNR) from your workbook. You can select this named range from the Send To Named Range Sequence ID dropdown list, which will become visible upon selection. The value of this range should evaluate into either (1) a single, well-formed email address, or (2) a series of well-formed email addresses, delimited by semicolons (;).

Carbon Copy Type

This input will allow you to choose whether you will have any carbon copy recipients on the email, as well as whether they will be a single series of static users or dynamically defined by the value of a named range within your workbook.

This functions precisely as the Send To Type field, except it includes an option for None, which will not CC any users.

Blind Carbon Copy Type

This input will allow you to choose whether you will have any blind carbon copy recipients on the email, as well as whether they will be a single series of static users or dynamically defined by the value of a named range within your workbook.

This functions precisely as the Send To Type field, except it includes an option for None, which will not BCC any users.

Body Type

This input will allow you to define whether the contents of the email should be static in a pre-defined format or whether they should be retrieved dynamically from a Single Named Range (SNR).

The corresponding values are as follows:

  • Static - The contents of the email can be defined immediately using the rich-text editor that will become available for the body upon selection. This editor will allow you to format your text, insert media, hyperlinks, and tables. You can also modify the custom CSS by opening the code editor via the button.
  • Dynamic - The recipient will be dynamic, based on a Single Named Range (SNR) from your workbook. You can select this named range from the Body Named Range Sequence ID dropdown list, which will become visible upon selection.

Static Body Type - Custom Content Injection

With the Static Body Type option, you can also dynamically inject named range values into your email contents, just as you would with a Content Control in the User Interface Designer.

The value of calculated and input named ranges can be injected directly into the HTML contents of a content / label control.

All dynamically injected variables will be nested between {{ }} brackets. To begin the process of injecting a variable into the contents, simply begin entering the curly brackets and some helpful hints will show up to guide you through the process.

Single Named Ranges

Upon opening the curly brackets, you will note a list of Single Named Ranges (SNR). Selecting one of these from the hints will populate the content control with the named range's name.

If you would like no formatting to be applied, you can simply close the two brackets and the value will be injected as an unformatted value.

Alternatively, several formatting options are available when injecting the value of a Single Named Range (SNR). To utilize any of the formatting options, simply type in a colon character (:) after the named range's name to see a list of supported data types.

These data types (Integer, Decimal, DateTime or Text) are necessary for the determination of the actual format, so select one that fits the assumed value of the Single Named Range (SNR). Text data type is different from the others since it will get the formatted value directly from the PSC. Text data type has an optional paramater None for format which has no effect on the output.

Upon selecting the data type, add an additional semicolon character (;) to begin defining the desired format for the output value. The .NET formatting standards apply to this format and are outlined below.

See below for some examples.

{{NamedRangeName:Decimal;C2}}

  • When NamedRangeName = 12, the formatted value will be $12.00.
  • When NamedRangeName = 1.2345561, the formatted value will appear $1.23.
  • When NamedRangeName = 'ABC', the formatted value will appear blank.

{{NamedRangeName:Decimal;P3}}

  • When NamedRangeName = 0.12, the formatted value will be 12.000%.
  • When NamedRangeName = 1.2345561, the formatted value will appear 123.457%.
  • When NamedRangeName = 'ABC', the formatted value will appear blank.

{{NamedRangeName:Decimal;00000}}

  • When NamedRangeName = 1234.5678, the formatted value will be 01235.
  • When NamedRangeName = 1.2345561, the formatted value will appear 00001.
  • When NamedRangeName = 'ABC', the formatted value will appear blank.

Predefined Formats

In addition to manual format setting you may also use one of the predefined Numeric or Date and Time Formatting:

Integer (Input value: 1234)

  • {{ValueInteger:Integer;00}} => 1234
  • {{ValueInteger:Integer;#,##0}} => 1,234
  • {{ValueInteger:Integer;00000}} => 01234
  • {{ValueInteger:Integer;##-##}} => 12-34

Decimal (Input value: 123456.78)

  • {{ValueDecimal:Decimal;0.0}} => 123456.8
  • {{ValueDecimal:Decimal;0.00}} => 123456.78
  • {{ValueDecimal:Decimal;#,##0.0}} => 123,456.8
  • {{ValueDecimal:Decimal;#,##0.00}} => 123,456.78
  • {{ValueDecimal:Decimal;0.##}} => 123456.78
  • {{ValueDecimal:Decimal;00.00}} => 123456.78
  • {{ValueDecimal:Decimal;0,0.00}} => 123,456.78
  • {{ValueDecimal:Decimal;0%}} => 12345678%
  • {{ValueDecimal:Decimal;0.0%}} => 12345678.0%

Datetime (Input value: 12/05/2018 11:25:07 pm)

  • {{NamedRangeName:Datetime;yyyy}} => 2018
  • {{NamedRangeName:Datetime;MM}} => 12
  • {{NamedRangeName:Datetime;dd}} => 05
  • {{NamedRangeName:Datetime;yyyy/MM/dd}} => 2018/12/05
  • {{NamedRangeName:Datetime;MM/dd/yyyy}} => 12/05/2018
  • {{NamedRangeName:Datetime;dd/MM/yyyy}} => 05/12/2018
  • {{NamedRangeName:Datetime;HH}} => 23
  • {{NamedRangeName:Datetime;mm}} => 25
  • {{NamedRangeName:Datetime;ss}} => 07
  • {{NamedRangeName:Datetime;tt}} => PM
  • {{NamedRangeName:Datetime;HH:mm tt}} => 23:25 PM
  • {{NamedRangeName:Datetime;HH:mm:ss tt}} => 23:25:07 PM

Text

  • {{NamedRangeName:Text;None}} : None is an optional parameter
  • {{NamedRangeName:Text}} : Will work the same as above

While formats are Culture invariant when making a selection from the list, the values shown will be different for the current application Culture. For example #,##0.0 format will be shown as in "Thousands Comma Delimiter, Decimal Period Delimiter" Culture, but it will be shown as # ##0,0 for the "Thousands Space Delimiter, Decimal Comma Delimiter" Culture setting. Once you make a selection, the value will be inserted in the contents will be the same for all Cultures.


Inserting Stubs Using the Stubs Button

Clicking the Stubs button on the top right of the content editor will open the Insert Stub menu where you can add document stubs with the help of a graphical user interface.

On the Insert Stub menu, you can select a named range, type, and format to automatically add the stub corresponding to your selections. If you want to use text format you can click Pull format from Excel checkbox.

After selecting the named range, type and format properties, or selecting the named range field and clicking Pull format from Excel checkbox press the Insert Stub button to insert the stub text into the content editor.

List and Table Named Ranges

These types of named ranges are entered in the same format as Single Named Ranges (SNR), except they do not support formatting of the output values. Using a List or Table Named Range within two sets of curly brackets will inject a full table into the content / label control.

This is best utilized when looking to test the values that exist within a named range, rather than for final presentation of a list or table named range. To present a readable and customizable format, utilize an Input or Output Grid control to display this type of data.

Record stubs

Record stubs are replaced with URLs related to the saved record when there is a save event associated with the same button as the Slack connector. The stubs that can be used are:

  • {{RecordLink}}: Replaced with View Record URL
  • {{RecordEditLink}}: Replaced with Edit Record URL.

Attachments

Any number of Print, Excel Export processes and File Upload inputs can be included in the attachment fields by selecting them in the last field. Here, we chose to include one PDF document and one Excel workbook.

SMTP Connector

If there are any validated Smtp Connectors in your application, then these settings can be utilized when sending the email (more details are available in the Connector Designer -> Smtp Connector section of the help pages).

The available SMTP settings will be selectable under the SMTP Connector input. The default value (empty) will utilize the global email settings that are defined under the Designer system configuration and Control Panel email configuration.