Versions Compared

Key

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

Table of Contents

...

Introduction

This is an Audit Trail plugin that intercepts assignment completion event. This plugin can be configured to store form with form data in .pdf extension of a completed assignment in the server or/and send out the attachment as email.

Plugin Info

Marketplace link: https://marketplace.joget.com/jw/web/userview/mp/mpp/_/vad?id=email-audit-pdf-plugin-v1

Plugin Type: Audit Trail Plugin

...

  1. Upload the downloaded jar file through Manage Plugins.
  2. Go to your desired App -> Properties & Export -> Set Plugin Default Properties and choose PDF Audit Trail.
  3. Configure the properties fields.

Screenshots

  1. Sample email sent out.
    Image RemovedImage Added
  2. Sample pdf file generated.
    Image RemovedImage Added
    With the option Store File Locally checked, PDF file created will be stored in wflow/app_formuploads/pdf-audit/[Process Instance ID] folder.
    Image RemovedImage Added
    This is the listing of files for a specific process instance.
    Image RemovedImage Added

Plugin Properties

...

. Example: smtp.gmail.com

Typically

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

On

. On Google email account, use your full email address.

. Password submitted will be encrypted for security reason.

Convenient

 Convenient toggle to enable/disable local file storing. File will be stored at app_formuploads\pdf-audit\[PID]\[AID].pdf

Convenient

 Convenient toggle to enable/disable Email sending.

LabelDescription
SMTP Host

Email Server SMTP Host

Info
titleExample
SMTP Port

Email Server SMTP Port

Info
Security
  • None
  • TLS
  • SSL
SMTP Username

Email Server Account Username

Info
SMTP Password

Email Server Account Password

Info
Store File Locally

When checked, PDF file of the form submitted will be saved to the server.

Info
Send Email

When checked, PDF file of the form submitted will be sent out.

Info

Email

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

If

 If you wish to give the performer of the activity a copy of the PDF, you may check this.

LabelDescription
From

Sender email address.

Info
titleExample

no-reply@your-company-name.com

To (Specific email address) 
Recipient fully qualified address.
CC

Fully qualified address is expected.Multiple  Multiple values can be accepted by separating them with semicolons.

Info
Send Separate Email to Performer

When checked, a copy of email will be sent out to the actual performer himself/herself.

Info
Subject
Email subject
Email Message
Email Message
Include Activity Information in Email message

When checked, additional information will be prepended to the email message.

Image RemovedImage Added
HTML Content?
Check if "Message" is intended to be a HTML content.

...

NameDescription
Formatting (CSS)

CSS to be included when generating pdf file.The  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


Image Modified
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;}
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.
Include Activity Information in PDF

When checked, activity information will be prepended to the top of the pdf file.
Image RemovedImage Added


Activity Exclusion

...