Versions Compared

Old Version 1

changes.mady.by.user Aadrian Zarin

Saved on

compared with

New Version Current

changes.mady.by.user PT

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Introduction


English

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.

...

Configure Export Email Tool

Image RemovedImage Added

Figure 1: Export Form Email Tool Properties

NameDescription
Form

Form to be used to generate pdf file.

Record row will be matched with current process instance ID.

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

Image RemovedImage Added

Figure 2: Email Info

...

Tip

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

Image RemovedImage Added

Figure 3: Email SMTP Settings

NameDescription
From

Sender email address.

Info
titleExample

no-reply@your-company-name.com

SMTP Host

Email Server SMTP Host

Info
titleExample

smtp.gmail.com

SMTP Port

Email Server SMTP Port

Info

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


Digital Signature

Image Added

Figure 4: Digital Signature Settings

NameDescription
Key Store File Path (P12)File path of the .pfx (or .p12) file under the "wflow" folder in your Joget DX installation folder.
Key Store PassphraseThe .jks file's Passphrase.
Issuer AliasThe digital certificate's or signature's Issuer name (alias).

Error Handling

Image Added

Figure 5: Error Handling Settings

NameDescription
Number of Retry When Fail to Send Out EmailNumber of Retries when the email is failed to be sent.
Retry Interval (Seconds)Frequency of retries in seconds.



Info
titleQuick Test

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

Advanced

Image RemovedImage Added

Figure 46: Advanced Settings

NameDescription
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:


Code Block
*
- 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.


Code Block
titleExample
//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:


Code Block
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):


Code Block
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.


Code Block
*{font-family:HYGoThic-Medium;}


Example for adding non supported font:

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


Code Block
@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.

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.


Configure Email Attachments

Image Added

Figure 7: Attachment Settings

Image Added

Figure 8: ICS Attachment Settings

NameDescription
FormFile attachment source form.
Form Upload Fields

Field ID: File attachment field ID(s) in the Form selected above.

Embed: Click the checkbox to embed the image attachment in the email and display the image using HTML, for example:

<img src="cid:#form.table.FileUpload?url#" />
Files

This attribute allows one to define the file attachment freely by defining a system path or absolute URL.

Name

Description

PathSource file path & filename.
Type
  • System Path
  • URL
File NameFile name to be used in Email attachment.
Embed

Click the checkbox to embed the image attachment in the email and display the image using HTML, for example:

<img src="cid:cat.jpg" />

See Send Datalist as attachment in Email Tool for more information.

Attach ICS File

Check this option to prepare an event and attach as an ICS file in the email.

When this attribute is checked, one will need to populate the details for the calendar ICS file in the fields below.

Important: The organizer or sender email must not be the same as your destination/recipient email. If sender and recipient emails are the same, you will not see the "Add to calendar" box in your email.

Related Tutorials

...