Hitachi Vantara Pentaho Community Wiki
Skip to end of metadata
Go to start of metadata

Description

Use the Mail job entry to send a text or HTML email with optional file attachments. This job entry is used at the end of a job run in most instances. It can be used to announce both a job failure or success. For example, it is not uncommon at the end of a successful load, to send an email to a distribution list announcing that the load was successful and include a log file. If there are errors, an email can be sent to alert individuals on a distribution list.

Important: No email messages are sent when a job crashes during a run. If you are bound by service level agreements or quality of service agreements you may not want to use this job entry as a notification method.

The Mail job entry requires an SMTP server. You can use authentication and security as part of the connection but you must have the SMTP credentials.

You can attach files to your email messages such as error logs and regular logs. In addition, logs can be zipped into a single archive for convenience.

Options

Addresses tab

Option

Description

Job entry name

The unique name of the job entry on the canvas. A job entry can be placed on the canvas several times; however it will be the same job entry

Destination Address

The destination for the email; you can specify multiple addresses if you separate them with a space.

Best practice: Do not maintain your distribution list within a job. Rather, have your email administrators set up a list so that you can send to a specified list each time you create the job. Operational functions such as Email contents, routing, people, and so on should be managed outside of Pentaho Data Integration.

Cc:

An identical copy of the message is also sent to all the addresses listed in the Cc: field. To enter more than one address in the Cc: field, separate them with a space.

BCc:

Send to a recipient whose email address does not appear in the message

Sender name

Name of the person sending the email

Sender address

Email address of the person sending the email

Reply to

Email address of the person to which to send a reply

Contact person

The name of the contact person to be placed in the email

Contact phone

The contact telephone number to be placed in the email

Server tab

Option

Description

SMTP Server

The SMTP server address

Port

The port on which the SMTP Server is running

Use Authentication

Enable to use authentication to the SMTP Server

Authentication user

SMTP user account name

Authentication password

SMTP user account password

Use Secure Authentication?

Enable to use secure authentication

Secure Connection Type

Select authentication type (SSL, TSL)

Email Message tab

Option

Description

Include date in message?

Enable to include date in message

Only send comment in mail body?

If not enabled the email will contain information about the job and its execution in addition to the comment

Use HTML in mail body

The message is sent in HTML format

Encoding

Select encoding type

Manage Priority

Enable to manage priority. Note: The support of this flag is depending on the mail server.

  • Priority
  • Importance
  • Sensitivity

Subject

Enter the subject of the mail into this field.

Comment

Enter the comment within the body of the mail into this field.

Attached Files tab

Option

Description

Attach files to message?

Enable to attach a file to your email message

Select file type

The files to send are defined within the internal files result set. Every file in this list is marked with a file type and you can select what type of file you want to send (see also the tips at the end of this document):

  • General
  • Log
  • Error line
  • Error
  • Warning

Zip files to single archive?

Enable to have attachments achived in a zip file

Name of the zip archive

Define the filename of your zip archive

Filename

Name of a single image file to add. Note: This works only when Use HTML format is defined in the EMail Message tab.

Content ID

Automatically entered

Image

The full path to image (used when embedding multiple images) Click Edit to edit the path; click Delete to delete the path to the image

Content ID

The image content ID (used when embedding multiple images) Click Edit to edit the content ID; click Delete to delete the Content ID

Tips

How to attach a particular file to the e-mail


You can attach "Result Files" of a particular type(s) to the e-mail, either individually or as a single ZIP archive by checking the option "Attach files to message" and selecting the types to attach under "Select the result files types to attach".
What is a Result File and how to create one? Well, just about any file created during a transformation may become a Result File, you only need to mark it as such. There are several ways to do that:

  1. When creating a file with a step that supports it, allow it to mark the file as a Result File.
    For example the "Text file output" step has the check-box "Add filenames to result" on the File tab for that purpose. The file type will be General.
  2. Use the step "Set files in result" from the Job category to mark a file as a result file of a particular type. This steps expects the file name to be in a field (you can use e.g. "Generate Rows" in combination with "Add constants" to produce a row containing the file name).

Attaching transformation's log

You may easily attach a log file with log of a transformation run by the job prior to sending the mail as follows (suppose we have the job Start -> Transformation -> Mail):

  1. In the Transformation job entry's options, check "Specify logfile?" and enter a name and extension for the file. You can also specify the desired log level.
  2. In the Mail job entry's options, check "Attach files to message" and select (at least) the file type "Log".
  3. The next time the mail is send, it will have the transformation's log attached.
  • No labels