Joget DX Available for Download

Check out Joget DX, the next generation successor to Joget Workflow for faster, simpler digital transformation.

Skip to end of metadata
Go to start of metadata

Introduction

Export Form Email Tool is a process tool that allows you to send out an email with a PDF attachment of the form..

Apart from configuring the normal email plugin, the only other configuration you will need to do is to select the form to be attached and the desired file name for the PDF attachment.

You can also use the Export Form Email Tool in Post Form Submission Processing to send out an email when the user submits the form on:

  • Data creation, or
  • Data update, or
  • Both Data creation and Data update.

Export Form Email Tool Properties

Configure Export Email Tool

NameDescriptionScreens (Click to view)
Form

Form to be used to generate pdf file.

Record row will be matched with current process instance ID.


Figure 1: Export Form Email Tool Properties

File NameIntended pdf file name to appear in Email attachment.
Hide fields without valueWhen checked, any field without value keyed in will not appear in the generated pdf file.
Show unselected options for multi options fieldWhen checked, unchecked/unselected options will appear in the generated pdf file in elements like Select Box, Radio Button.


Email Info

NameDescriptionScreens (Click to view)
To (Specific email address)Recipient fully qualified address.


Figure 2: Email Info

To (Participant ID)

Participant ID(s) according to the process flow it resides in.

Multiple values can be accepted by separating them with semicolons.

When To (Specific email address) and To (Participant ID) are both populated, email will be sent to both.

CC

Fully qualified address is expected.

Multiple values can be accepted by separating them with semicolons.

CC: lets you send a copy of a message to someone who's interested, but is not the primary recipient.

BCC

Fully qualified address is expected.

Multiple values can be accepted by separating them with semicolons.

Both Cc and Bcc forward a copy of the message to everyone you've listed. The main difference between Cc or Carbon copy and Bcc (Blind carbon copy) is that, with the latter, the recipients do not get to know each other.

SubjectEmail Subject.
MessageEmail Message.
HTML Content?Check if "Message" is intended to be a HTML content.


Email SMTP Settings

If you leave the SMTP settings below empty, Joget will read the default SMTP configuration values from the General Settings > SMTP Settings page.

NameDescriptionScreens (Click to view)
From

Sender email address.


Figure 3: Email SMTP Settings

SMTP Host

Email Server SMTP Host

SMTP Port

Email Server SMTP Port

Typically, port 465 for SSL security option and 587 for TLS

Security
  • None
  • TLS
  • SSL

Alternatively, you can click on the "hash" symbol to allow the input of hash variables.

SMTP Username

Email Server Account Username

SMTP Password

Email Server Account Password

Quick Test

Hit on the "Send Test Email" button to quickly validate and test out your email settings.

Advanced

NameDescriptionScreens (Click to view)
Formatting (CSS)

CSS to be included when generating pdf file.

The Advanced > Formatting (CSS) field gives you formatting options (font size and color) for the output. 

Available CSS Classes:


*
- Wildcard. Everything in the form.
 
.form-section
- Container of a section
 
.form-section-title
- Container of section title
 
.form-column
- Container of column
 
.form-cell
- Container of field
 
.label
- Label of field
 
//Sub Form
.subform-container
- Container of a Subform
 
.subform-title
- Container of Subform title
 
.subform-section
- Container of section in Subform
 
.subform-section-title
- Container of section title in Subform
 
.subform-column
- Container of column in Subform
 
.subform-cell
- Container of field in Subform
 
.header
- Container of configured header
 
.footer
- Container of configured footer


Figure 5: This figure illustrates the CSS classes used in the form layout.


Example
//Change all word to blue color
*, .form-cell{
  color:blue;
}
 
//Change all word to smaller size
*, .form-cell{
  font-size:10px;
}
 
//Change all label format to underline
.label{
  text-decoration:underline;
}
 
//Transform all header format to uppercase
.form-section-title{
  text-transform:uppercase;
}


Font & Unicode 

There are a few fonts (added by default) that you can use in CSS formatting.  They are:


serif, sans-serif, monospace, Courier, TimesRoman


For Unicode content, you can use the following fonts for Asian languages (i.e., Chinese, Traditional Chinese, Japanese, Korean):


STSong-Light, MSung-Light, HeiseiMin-W3,  HYGoThic-Medium


Note : "STSong-Light" gives the best result for Chinese; "MSung-Light" for Traditional Chinese; "HeiseiMin-W3" for Japanese; and "HYGoThic-Medium" for Korean.


*{font-family:HYGoThic-Medium;}


Example for adding non supported font:

Method 1: Add the following CSS into Export Form Email Tool > "Formatting (CSS)" field:


@font-face {
    src: url(http://localhost:8080/THSarabun.ttf);
    -fs-pdf-font-embed: embed;
    -fs-pdf-font-encoding: Identity-H;
}
*{font-family: 'TH SarabunPSK';}

Download the THSarabun.ttf font file and copy it to "[Tomcat Directory]/webapps/ROOT" folder.

Method 2: From Joget v6.0.16, it now supports adding additional font for datalist pdf export and FormPdfUtil by adding the font file to folder "/wflow/fonts" directory and configure the font in "fonts.csv" file in the same directory with format "font family name, file name, encoding". For the sample, kindly refer to the fonts.csv file.


Figure 4: Advanced





Header (HTML)Header in HTML to be included when generating pdf file.
Repeat header on every page?If checked, the Header (HTML) will be included in every subsequent pages in the generated pdf file.
Footer (HTML)Footer in HTML to be included when generating pdf file.
Repeat footer on every page?If checked, the Footer (HTML) will be included in every subsequent pages in the generated pdf file.

Related Tutorials


  • No labels