Mail

Description

Mail is a step in the Utility Plugin both for Process Studio Workflows and Process Studio Processes. Mail step is used to send a text or HTML email with optional file attachments. 

Most commonly Mail is used as a process entry at the end of a process. It can be used to announce a process 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.

Note: No email messages are sent when a process crashes during a run. If you are bound by service level agreements, you may configure Email Notification settings in AutomationEdge.

Configurations

Addresses Tab:
No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	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 process. Rather, have your email administrators set up a list so that you can send to a specified list each time you create the process.
3	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.
4	BCc:	Send to a recipient whose email address does not appear in the message
5	Sender name	Name of the person sending the email
6	Sender address	Email address of the person sending the email
7	Reply to	Email address of the person to which to send a reply
8	Contact person	The name of the contact person to be placed in the email
9	Contact phone	The contact telephone number to be placed in the email

Server Tab:
No.	Field Name	Description
1	SMTP Server	The SMTP server address. SMTP server is mandatory. You can use authentication and security as part of the connection but you must have the SMTP credentials and enable Use Authentication checkbox below.
2	Port	The port on which the SMTP Server is running
3	Use Authentication	Enable Use Authentication checkbox to authenticate to the SMTP Server. In this way you can use authentication and security as part of the connection to SMTP server.
4	Authentication user	SMTP user account name.
5	Authentication password	SMTP user account password.
6	Use Secure Authentication?	Enable to use secure authentication.
7	Secure Connection Type	Select authentication type (SSL, TSL).

Email Message Tab:
No.	Field Name	Description
1	Include date in message?	Enable checkbox to Include date in message
2	Only send comment in mail body?	Enable to Only send comment in mail body.
3	Use HTML in mail body	Enable to Use HTML in mail body
4	Encoding	Select encoding type
5	Manage Priority	Enable to manage priority. Note: The support of this flag is depending on the mail server.  Priority Importance Sensitivity
6	Subject	Enter the subject of the mail into this field.
7	Comment	Enter the comment within the body of the mail into this field.

Attached files Tab:
No.	Field Name	Description
1	Attach files to message?	Enable to attach a file to your email message. 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.
2	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:  General Log Error line Error Warning
3	Zip files to single archive?	Enable to have attachments archived in a zip file
4	Name of the zip archive	Define the filename of your zip archive
5	Filename	Name of a single image file to add. Note: This works only when Use HTML format is defined in the EMail Message tab.
6	Content ID	Automatically entered
7	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
8	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

No.	Field Name	Description
1	Step Name	Name of the step.  This name has to be unique in a single workflow.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	PDF 1 Path	Specify the file path of the first PDF file to be merged.
2	Button: Browse…	Clicking on this button brings up the dialog to browse the PDF file which is to be merged.
	PDF 1 Password:
3	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
4	Password	Provide PDF password if the pdf is password protected.  If checkbox above is enabled Password field appears as Text box and you may provide a static value or variable.  Else if checkbox above is disabled Password field appears as a drop down containing fields from previous steps. You may select the field containing the password value. If the pdf is not password protected and a password is provided it is ignored.
	PDF 2 Path	Specify the file path of the second PDF file merged.
	Button: Browse…	Clicking on this button brings up the dialog to browse the PDF file which is to be merged.
	PDF 2 Password:
	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
	Password	Provide PDF password if the pdf is password protected.  If checkbox above is enabled Password field appears as Text box and you may provide a static value or variable.  Else if checkbox above is disabled Password field appears as a drop down containing fields from previous steps. You may select the field containing the password value. If the pdf is not password protected and a password is provided it is ignored.
5	Output PDF Path	Specify the file path with filename to store the merged PDF file.
6	Button: Browse…	Clicking on this button brings up the dialog to browse the path of the output PDF.
7	Output PDF Password:
8	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
9	Password	Provide a password for the output PDF if desired and you wish to password protect the file. Password is encrypted and not stored in the workflow (.psw) file.  If checkbox above is enabled Password field appears as Text box and you may provide a static value or variable.  Else if checkbox above is disabled Password field appears as a drop down containing fields from previous steps. You may select the field containing the password value.

Common Buttons:
No.	Field Name	Description
	Buttons:
1	OK	On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
2	Cancel	On click of this button, it will cancel the window and do not save any values

No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
	Fields:
1	Name	Specify the name of the field that is to be checked/compared against a value
2	Value to turn to NULL	The value to be checked for replacement with null.

No.	Field Name	Description
1	Step Name	Name of the step.  This name has to be unique in a single workflow.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Input PDF Path	Specify the file path of the PDF file to be converted to the image.
2	Button: Browse…	Clicking on this button brings up the dialog to browse the PDF file which is to be converted to specified image format.
	PDF Password:
3	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
4	Password	Provide PDF password if the pdf is password protected. Password is encrypted and not stored in the .psw file. Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is optional.  If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. If the pdf is not password protected and a password is provided it is ignored.
5	Pages	Page numbers of the pdf that are to be converted to the provided image format. This can be given as a comma separated integer value or range of page numbers (e.g. 1,2,4,10-15)
6	Output Image Format	Format of the output image. Allowed values are ‘JPG’, ’PNG’, ’JPEG’, ’BNP’
7	Resolution in DPI	Resolution in DPI for the output image to be downloaded. Resolution in DPI should be a positive integer and should not exceed 1200.
8	Output Folder Path	Specify the path of the folder where images for each page in the pdf are to be downloaded.
9	Button: Browse…	Clicking on this button brings up the dialog to browse the path of the output folder.

Output Tab:
No.	Field Name	Description
	Output Fields:
1	Number of Pages	Specify an output field to hold the number of PDF pages converted to image on successful plugin execution
2	Non-available Pages	Output field to hold the page numbers of non-available PDF pages on successful plugin execution (page numbers will be displayed in comma separated integer values).
3	Error Pages	Output field to hold the page numbers of erroneous PDF pages on successful plugin execution (page numbers will be displayed in comma separated integer values).

Common Buttons:
No.	Field Name	Description
	Buttons:
1	OK	On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
2	Cancel	On click of this button, it will cancel the window and do not save any values

No.	Field Name	Description
1	Step Name	Name of the step.  This name has to be unique in a single workflow.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Input PDF Path	Specify the path of the PDF file to be converted to text and to be stored as a text file. Alternatively, click the Browse button to browse the file path.
2	Button: Browse…	Clicking on this button brings up the dialog to browse the PDF file to be converted to text format.
	PDF Password:
3	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
4	PDF Password	Provide PDF password if the pdf is password protected. Password is encrypted and not stored in the .psw file. Password is entered using a widget. The widget handles both Text (static value or environment variable) and Combo (drop down containing values from previous steps). This field is optional.  If checkbox above is enabled Password field appears as Text box. Else if checkbox above is disabled Password field appears as a drop down to select fields from previous steps. If the pdf is not password protected and a password is provided it is ignored.

Output Tab:
No.	Field Name	Description
	Output Fields:
1	Result	Specify an output field to hold converted text upon successful plugin execution.

Common Buttons:
No.	Field Name	Description
	Buttons:
1	OK	On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
2	Cancel	On click of this button, it will cancel the window and do not save any values

No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	Operation	Choose an operation from the drop down list: Copy, Move or Delete
3	Create target parent folder	Enable this checkbox to create the target parent folder. Otherwise it throws an exception when the target parent folder does not exist.
4	Overwrite target file	Enable this option to overwrite the target file if it already exists. Otherwise it will not be overwritten and silently ignored.
5	Add target filename to result	Enable Add target filename to result checkbox to add the copied, moved or deleted files to result files.
6	Set simulation mode	Enable this checkbox to execute the step only for simulation purposes. No action will be taken at the end and no file will be copied, moved or deleted.
7	Source filename field	Specify a field that contains the complete path to the source file for copy or move or the file to be deleted.
8	Target filename field	Specify a field that contains the complete path to the target file. This field must not be given in the Delete mode.

No.	Field Name	Description
1	Step Name	Name of the step.  This name has to be unique in a single workflow.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Input PDF Path	Specify the path of the PDF file to retrieve form data. Alternatively, click the Browse button to browse the file path. Note: The pdf must be an editable PDF forms. PDFs that are split using any PDF split utility cannot be used.
2	Button: Browse…	Clicking on this button brings up the dialog to browse the PDF file to retrieve form data.
	PDF Password:
3	Checkbox: Accept Value as variable/static	Leave checkbox unchecked to accept PDF Password from a field in the previous steps using a drop down list. Else enable checkbox for Password field to appear as Text box.
4	PDF Password	Provide PDF password if the pdf is password protected. Password is encrypted and not stored in the workflow(.psw) file.  If checkbox above is enabled Password field appears as Text box and you may provide a static value or variable.  Else if checkbox above is disabled Password field appears as a drop down containing fields from previous steps. You may select the field containing the password value. If the pdf is not password protected and a password is provided it is ignored.

Output Tab:
No.	Field Name	Description
	Tabular Output Fields:
1	PDF Field Name	Click on this column field to bring up a dialog with the list of available form fields in the PDF. Select form fields in the table. The data type is String. This field is mandatory.
2	Output Field Name	Specify the name of an output field to hold the PDF form field value. The data type is String. This field is mandatory.

Common Buttons:
No.	Field Name	Description
	Buttons:
1	OK	On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
2	Cancel	On click of this button, it will cancel the window and do not save any values

No.	Field Name	Description
1	Web Browser Name	You can select any one Web Browser Name from the given list,  Basically you must select the same Web Browser Name which was selected in Start Browser Step.
2	Key combination	Checkbox is selected if all the keys specified in the table are to be pressed together.  This option is applicable to all the keyboard events in the table.
3	Event list*	Specify the event to be triggered from the list: Mouse, Keyboard, String
4	Value*	Specify a Value of the event.

*Event list 

The table below contains the description of each Event list option.

No.	Field Name	Description
1	Mouse	Mouse event
2	Keyboard	Keyboard single keystroke event
3	String	All the keys for the characters in the value are pressed one after the other

*Value 

The table below contains the description of valid Values.

1. Mouse
   

No.	Value	Description
1	Left	Left mouse click
2	Right	Right mouse click

2. Keyboard
   

No.	Value	Description
1	Type the character on the keyboard to be pressed on separate rows in the table	All the keys are pressed and released in sequence. Following is a list of Special Keys allowed as values, Ctrl, Shift, Alt, Caps Lock, Esc, Enter, Left (Left Arrow), Up (UP Arrow), Right (Right Arrow), Down (Down Arrow), Cancel, Tab, Home, End, Insert, Delete, PageUp, PageDown, Backspace. All alphabets (understood as lower case) and numbers are allowed, for upper case letters you need to provide shift and the alphabet.
2	‘Key combination’ checkbox is selected	All the keys in the table are pressed together and then released at once. This option is applicable to all the keyboard events in the table.

General Tab:
No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	Server name / IP address	Specify the server or IP address of the machine on which you want to execute a command.
3	Server port	Specify the TCP/IP port on which ssh protocol lives on the server.  The default is 22.
4	Timeout	Specify the timeout in seconds.  If set to a number larger than zero you can specify a non-default connection timeout.
5	Username	Specify the username to log in with
6	Password	Specify the password to use
7	Use key	Enable this option if you want to log in using a private key
8	Private key	The private key file.  The private part of a private/public RSA key-pair (see: ssh-keygen)
9	Passphrase	Specify the optional pass-phrase used when the key-pair was generated
10	Proxy host	Specify the proxy server host to use (name or IP address)
11	Proxy port	Specify the proxy server port to use
12	Proxy username	Specify the proxy user name
13	Proxy password	Specify the proxy password
14	"Test connection" button	Click to see if the supplied credentials are sufficient for logging into the SSH server.

Settings Tab:
No.	Field Name	Description
	Output:
1	Response fieldname	Specify the name of the String output field that will contain the text passed to the standard output channel (stdout) by the specified commands. This information can then be picked up by the step and passed in a field to subsequent steps.
2	Error response field name	The name of the String output field that will contain the text passed to the standard error channel (stderr) by the specified commands. This information can then be picked up by the step and passed in a field to subsequent steps.
	Commands:
3	Get commands from field	Enable this option if you want to execute commands specified in an input field
4	Commands field name	Select the input field that will contain the commands to execute
5	Commands	Field allows you to specify the commands to execute.
6	Wait for response	Specify the Wait for response time in seconds. If it is more than zero seconds, the step waits to get the command output for the specified seconds.  Internally, it checks for a response after every 15 seconds. If the command output does not receive a response in the specified time, then the step exits with an error.

No.	Field Name	Description
1	Step Name	Name of the step.  This name has to be unique in a single workflow.

Input Tab:
No.	Field Name	Description
	Input Fields:
1	Input PDF Path	Specify full file path of the PDF file to be split. The data type is String. This field is mandatory.
2	Browse…	Click to browse the PDF file which is to be split.
3	PDF Password	Provide the Password if the PDF is password protected. The data type is Secure String.
4	Start Page	Specify the page number starting which the PDF is to be split. Start Page is a positive integer.
5	End Page	Specify the page number up to which the PDF is supposed to be split. End Page is a positive integer.
6	Split At Every X Page	The number specifies where to split the pages i.e., this will split the document after every X pages. Split At Every X Page is a positive integer.
7	Output Folder Path	Specify the Path of the folder where split PDFs are to be downloaded. The data type is String. This field is mandatory.
8	Browse…	Click button to browse the path of the output folder.

Common Buttons:
No.	Field Name	Description
	Buttons:
1	OK	On click of this button. It will check the field values.  If any required field values are missing then it will display validation error message. If all the required field values are provided then it will save the field values.
2	Cancel	On click of this button, it will cancel the window and do not save any values

No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	Reference connection / Compare connection	Database connections from which the reference/compare table data will come.
3	Reference schema field / Compare schema field	Specify the field that contains the schema names for the reference/compare table.
4	Reference table field / Compare table field	Specify the field that contains the actual table names. This means that you could compare two tables with a different name, as long as they have the same column names.
5	Key fields field	Specify a field that contains a comma separated list of the fields that make up the 'primary' key of the table(s) you are comparing. The primary key is needed because without this information the two tables cannot be correctly joined.
6	Exclude fields field	Specify the field that contains a comma separated list of columns that you want to exclude from the comparison. E.g. because they exist in the first table, but not in the second.
7	Number of errors field	Specify the name of the output column that will contain the total number of errors found for the comparison of your tables.
8	Number of reference table records field	Specify the name of the field that will contain the actual number of records found in the reference table.
9	Number of compare table records field	Specify the name of the field that will contain the actual number of records found in the compare table.
10	Number of left join errors field	Specify the name of the field that will contain the number of records that are only present in the reference table.
11	Number of inner join errors field	Specify the name of the field that will contain the number of records that show a difference between common records.
12	Number of right join errors field	Specify the name of the field that will contain the number of records that are only present in the compare table.
13	Error handling key description input field	Specify the output field names that will be used by the error handling of this step to describe the key(s) on which an error occurred.
14	Error handling reference value input field	Specify the output field names that will be used by the error handling of this step to describe the reference value that caused an error.
15	Error handling compare value input field	Specify the output field names that will be used by the error handling of this step to describe the compare value that caused an error.

No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
2	Log level	Choose the log level to use.  Note: Logging will occur in processes or workflows run at any logging level at or above the level specified here.  So, setting this value to Minimal will cause a log entry to be written in a process or workflow run in Minimal logging, Basic logging, Detailed logging, etc. logging levels, but NOT Nothing at all or Error logging only.
3	Print header	Enable checkbox to print field names as well as data values.
4	Limit rows	Enable "Nr. of rows to print" checkbox to Limit the number of rows to print in logs.
5	Nr. of rows to print	Specify the number of rows to print when option "limit rows" is checked.
6	Write to log	Specify the text to use in the logging line(s)
7	Fields	Specify the field that should we written to the log.

No.	Field Name	Description
1	Step name	Specify the name of the step as it appears in the workflow workspace. This name has to be unique in a single workflow.
	Settings:
1	Create target parent	Check this option to create the target parent folder
2	Overwrite target file	Enable check box to overwrite target file if present.
3	Add zip filename to result	Check this option to add the zip filename to the internal result set and make available to next step.
4	Source filename field	Specify the field that contains the source
5	Target filename field	Specify the field that contains the target zip filename
6	Keep source folders	Check this option to keep the source folder within the target zip filename
7	Base folder fieldname	Specify the field that contains the base folder that is removed from the filename within the zip (used by the option keep source folders)
8	After zip	Select from: (Do Nothing/Move source file/Delete source file)
9	Move to folder fieldname	If ‘Move source file’ is select in ‘After zip’ above provide fieldname containing folder name to move zip file.