|
Use the following settings to configure an email endpoint.
- Name:
- A mandatory setting that identifies the endpoint. Do not
include a < character because it truncates the
name displayed in Workspace. If you’re entering a URL as the name
of the endpoint, ensure that it conforms with the syntax rules specified
in RFC1738.
- Description:
- A description of the endpoint. Do not include a < character because
it truncates the description displayed in Workspace.
- Cron Expression:
- Enter a cron expression if the email must be scheduled by using
a cron expression.
- Repeat Count:
- Number of times the email endpoint scans the folder or directory.
A value of -1 indicates indefinite scanning. The default value is
-1.
- Repeat Interval:
- The scanning rate that the receiver uses for checking for incoming
mail.
- Delay when job starts:
- The time to wait to scan after the scheduler starts.
- Batch Size:
- The number of emails the receiver processes per scan for
optimum performance. A value of -1 indicates all emails. The default
value is 2.
- User Name:
- A mandatory setting, which is the user name that is used
when invoking a target service from email. The default value is
SuperAdmin.
- Domain Name:
- A mandatory setting, which is the user’s domain. The default value
is DefaultDom.
- Domain Pattern:
- Specifies the domain patterns of incoming email that the provider
accepts. For example, if adobe.com is used, only email from adobe.com is
processed; email from other domains is ignored.
- File Pattern:
- Specifies the incoming file attachment patterns that the
provider accepts. This includes files that have specific extensions
(*.dat, *.xml), specific names (data), or composite expressions
in the name and extension (*.[dD][aA][Tt]).
- Successful Job’s Recipients:
- An email address to which messages are sent to indicate successful
jobs. By default, a successful job message is always sent to the sender.
If you type sender, email results are sent to the
sender. Up to 100 recipients are supported. Specify additional recipients
with email addresses, separated by commas (,).
To turn off
this setting, leave the setting blank. In some cases, you want to
trigger a process and do not want an email notification of the result.
- Failed Job’s Recipients:
- An email address to which messages are sent to indicate failed
jobs. By default a failed job message is always sent to the sender. If
you type sender, email results are sent to the
sender. Up to 100 recipients are supported. Specify additional recipients
with email addresses, separated by commas (,).
To turn off
this setting, leave the setting blank. In some cases, you want to
trigger a process and do not want an email notification of the result.
- Inbox Host:
- The inbox host name or IP address for the email provider
to scan.
- Inbox Port:
- The port that the email server uses. The default value for
POP3 is 110 and the default value for IMAP is 143. If SSL is enabled,
the default value for POP3 is 995 and the default value for IMAP
is 993.
- Inbox Protocol:
- The email protocol for the email endpoint to use to scan
the inbox. The values are IMAP or POP3. The inbox host mail server
must support these protocols.
- Inbox Time Out:
- The time-out, in seconds, for the email provider to wait
for inbox responses.
- Inbox User:
- The user name that is required to log in to the email account. Depending
on the email server and configuration, this value may be only the user
name portion of the email or it may be the full email address.
- Inbox Password:
- The password for the inbox user.
- POP3/IMAP SSL Enabled:
- Select this setting to force the email provider to use SSL
to scan the inbox. Ensure that your mail server supports SSL.
- SMTP Host:
- The host name of the mail server the email provider uses
to send results and error messages.
- SMTP Port:
- The default value for the SMTP port is 25.
- SMTP User:
- The user account for the email provider to use when it sends
email notifications of results and errors.
- SMTP Password:
- The password for the SMTP account. Some mail servers do not require
an SMTP password.
- Send From:
- The email address (for example, user@company.com) used to
send email notifications of results and errors. If you do not specify
a Send From value, the email server attempts to determine the email
address by combining the value specified in the SMTP User setting
with a default domain configured on the email server. If your email
server does not have a default domain and you do not specify a value
for Send From, errors may occur. To ensure that the email messages
have the correct from address, specify a value for the Send
From setting.
- SMTP SSL Enabled:
- Select this setting to force the email provider to use SSL
to scan the inbox. Ensure that your mail server supports SSL.
- Failed Email Sent Folder:
- Specifies a directory in which to store results if the SMTP
mail server is not operational.
- asynchronous:
- When set to synchronous, all input documents are processed and
a single response is returned. When set to asynchronous, a response
is sent for each document that is processed.
For example,
an email endpoint is created for a service that takes a single Word document
and returns that document as a PDF file. An email can be sent to
the endpoint’s inbox that contains multiple (3) Word documents.
When all three documents are processed, if the endpoint is configured
as synchronous, a single response email is sent with all three documents
attached. If the endpoint is asynchronous, a response email is sent
after each Word document is converted to PDF. The result is three
emails, each with a single PDF attachment.
The default value
is asynchronous.
- Include the original email body as an attachment:
- By default, when you send an email to the LiveCycle server,
the original text of the message is included in the body of the
message. To instead include the text as an attachment, select this
option.
- Use the original subject line for result emails:
- By default, LiveCycle server uses the values specified in
the Success Email Subject and Error Email Subject settings as the
subject line when sending result email messages. To instead use the
same subject line as the original email sent to the server, select
this option.
- Success Email Subject:
- After you send an email to an email endpoint to start or continue
a process, you receive a return email message from the LiveCycle
server. If your email succeeds, you receive a success email. If
your email fails, you receive a failure email informing why it failed.
This setting enables you to specify the subject line of success
email messages sent for this endpoint.
- Success Email Body:
- Enables you to specify the body text of success email messages
sent for this endpoint.
- Error Email Subject Prefix:
- Enables you to specify the text used at the beginning of
the subject line of failure email messages sent for this endpoint.
- Error Email Subject:
- Enables you to specify the subject line of failure email messages
sent for this endpoint. This text is displayed after the Error Email Subject
Prefix.
- Error Email Body:
- Enables you to specify the first line in the body text of
failure email messages sent for this endpoint.
- Email Summary Info:
- Each success or failure message includes a section containing
the original email text that you sent to the LiveCycle server. This setting
specifies the text that appears above that section.
- Validate Inbox before creating/updating this endpoint:
- When this option is selected, the LiveCycle server checks
whether your SMTP/POP3 settings are correct before creating the
endpoint. When you click Add, a message displays, stating whether
the inbox account is valid. If this option is not selected, the LiveCycle
server creates the endpoint without validating the inbox.
- Operation Name:
- This setting is mandatory. A list of operations that can
be assigned to the email endpoint. The operation that you select
here determines which fields are displayed in the Input Parameter
Mappings and Output Parameter Mappings sections.
- Input Parameter Mappings:
- Used to configure the input that is required to process the
service and operation. The two types of input are literal and variable:
- Literal:
- The email uses the value that is entered in the field as
it is displayed.
- Variable:
- You can map a string from the email subject, body, header,
or sender's email address. To do this, use one of the following
keywords: %SUBJECT%, %BODY%, %HEADER%, or %SENDER%. For example,
if you use %SUBJECT%, the email subject content is used as the input
parameter. To pick up attachments, enter a file pattern that the
email endpoint can use to select the attached documents. For example,
entering *.pdf selects any attached document that
has a .pdf filename extension. Entering * selects
any attached document. Entering example.pdf selects
any attached document named example.pdf.
- Output Parameter Mappings:
- Used to configure the output of the service and operation.
The following characters in the output parameter mapping values
are expanded in the attachment filename:
- %F
- Represents the source file’s filename (not including an extension).
- %E
- Represents the source file’s extension.
- \
- Any occurrence of the backslash (\) is replaced with %%.
Note: If
the service request message includes multiple file attachments,
you cannot use the %F and %E parameters for the Output Parameter
Mappints property of the endpoint. If the services response returns
multiple file attachments, you cannot specify the same file name
for more than one attachment. If you do not follow these recommendations,
the invoked service create the names for the returned files, and the
names are not predictable.
The
following values are available:
- Single Object:
- The email provider does not have the source folder destination; results
are returned as attachments. The pattern is Result/%F.ps and
returns Result%%sourcefilename.ps as the
filename attachment.
- List:
- The pattern is Result/%F/ and returns Result%%sourcefilename%%file1 as
the filename attachment.
- Map:
- The pattern is Result/%F/ and the source
destination is Result%%sourcefilename%%file1 and Result%%sourcefilename%%file2.
If the map contains more than one object and the pattern is Result/%F.ps,
the response file attachments are Result%%sourcefilename1.ps (output
1) and Result%%sourcefilename2.ps (output
2).
|
|
|
