Checkpoint via mail is a processor that allows implementing a simple Checkpoint via email, performing the following main functions:
-
For each arriving job, send out an email message that includes the unique name prefix of the job and a list of possible "Checkpoint actions" (the names of the outgoing connections) – in addition to instructions on how to operate the Checkpoint by return email.
-
Monitor email messages coming back from users and parse those messages for the original information about the job and for the Checkpoint action selected by the sender.
-
When a matching response comes in, move the corresponding job along the specified outgoing connection.
Keywords
Keywords can be used with the search function above the elements pane.
The keywords for the Checkpoint via mail element are:
- Internet
- web
- network
- communication
- transfer
- interaction
- client
- user
Connections
Checkpoint allows any number of outgoing move connections. The name of each connection defines a "Checkpoint action".
Properties
Property |
Description |
|---|---|
Name |
The name of the flow element displayed in the canvas |
Subject |
The subject line for the message. |
To addresses |
The list of destination email addresses for the message. Email addresses are separated by a semicolon or by a newline. |
Include attached addresses |
If set to yes, the email addresses from the job's internal job ticket are added to the To addresses. |
Reply address |
The email address to which a receiver of the message should send a reply. If the value is empty or Default, the reply address specified in the User Preferences is used. |
Message format |
The format of the message body, either Plain text or HTML |
Body template |
The location of the template of the email body. If set to Built-in, the text can be set in the Body text property. Using the Include attached body text option, you can insert the body text attached to the job as part of its email info, after the body text. If you set Display metadata to "Yes", you can specify the Metadata fields using the Define metadata fields dialog box. If set to Fixed file, a Template file can be set, referring to a plain text or HTML file containing the template for the message body. If set to Associated with job, the Template dataset which is the name of the metadata dataset associated with the job containing a plain text or HTML template can be set. |
Attach files |
If set to yes, the incoming job is attached to the email message sent out |
Enable report viewing |
If set to yes, the metadata dataset indicated with the subordinate property is attached to the email message sent out |
Report dataset name |
The name of the dataset to be attached to the email message |
Report name suffix |
The name of the attached report is formed by adding this suffix to the name of the job, before the file name extension |
Report name extension |
The file name extension for the report. Select "Data Model" to automatically use xml, jdf or xmp depending on the data model of the exported data set. For the Opaque data model, the original backing file's extension is used. |
Allow multiple outputs |
If set to yes, the user can send copies of a job along more than one outgoing connection; otherwise the job is sent along exactly one of the outgoing connections |
Server type |
The type of server from which to retrieve email. Choices are "POP3" and "IMAP" |
Server address |
The URL or IP address of the server from which to retrieve email |
| Port | Specify the port to be used for communication with the server |
Accounts |
A list of accounts (names and corresponding passwords) from which to retrieve email |
Use secure password verification |
Defines whether to log in to the email server using secure password verification |
Server requires secure connection (SSL) |
Defines whether the email server requires a secure connection using the SSL protocol |
| Check every (minutes) | The frequency of checking the email accounts for new messages |
| Fail jobs after timeout |
If set to yes, jobs are failed after residing in the Checkpoint for a certain period of time (specified in the subordinate properties) Failed jobs are moved to the outgoing connection specified in the subordinate properties or to the problem jobs folder |
| Unit | Selects the unit for the subsequent property: Minutes, Hours, Days |
| Timeout delay | The timeout delay in the units indicated by the previous property (0 means ‘no timeout') |
| Fail connection |
The name of the connection to which failed jobs must be moved If this property value is empty or if the specified name does not match any of the outgoing connection names, failed jobs are moved to the problem jobs folder |
Reply syntax
The user's reply message must specify the job ID and the selected Checkpoint action(s) in a simple format. Specifically, Switch searches for the following character sequences:
"Job identifier:" followed by the job ID (as specified in the original email sent to the user).
"Action:" followed by one of the Checkpoint action names, or a list of comma-separated action names (in case multiple actions are allowed).
In both cases, the text is case insensitive. All other text in the message is ignored.
Examples
Mail sent to user |
|---|
Job identifier: 0044P Message text: Body text........ ...........end. Possible Checkpoint actions (please choose any): Accept Reject Email was triggered by this file : Test.txt Attachments: Job file: Test.txt --- Important information --- Reply message should contain the following lines: Job identifier: 0044P Action: action from the list above or comma separated actions list |
Reply from user |
|---|
Job identifier: 0044P Action: Accept ... |