Trigger a Process Based on an Incoming Email

The trigger a process based on an incoming email allows you to automatically trigger an AgilePoint process based on an incoming email.

To trigger an AgilePoint process based on an incoming email, do the following.

Navigation

  1. On the Enterprise Manager Main Page, click Events Service.
  2. On the Event Service page, click Incoming Email > Add.

Instructions

  1. On the Inbound Email Event Configuration page, complete the following fields as required.
    Field Name Definition

    Description

    Definition:
    Specifies the description of the email trigger.
    Allowed Values:
    Multiple lines of text.
    Default Value:
    None
    Custom Attributes:
    No

    Domain

    Definition:
    Specifies your email authentication domain.
    Allowed Values:
    A valid domain name.
    Default Value:
    None
    Custom Attributes:
    No

    User Name

    Definition:
    Specifies a user name you want to associate with an email event.
    Allowed Values:
    A valid user name.
    Default Value:
    None
    Custom Attributes:
    No

    Password

    Definition:
    Specifies the password for your email server.
    Allowed Values:
    A single line of text with no spaces.
    Default Value:
    None
    Custom Attributes:
    No

    Email Subject

    Definition:
    Specifies a custom attribute that contains to the subject of your email. When the email account specified receives an email, the data associated with this attribute is stored. It can then be referenced in the process using the specified custom attribute.
    Allowed Values:
    A valid custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Sender

    Definition:
    Specifies a custom attribute that contains to the sender of your email. When the email account specified receives an email, the data associated with this attribute is stored. It can then be referenced in the process using the specified custom attribute.
    Allowed Values:
    A valid custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Mail Body

    Definition:
    Specifies a custom attribute that contains to the body of your email. When the email account specified receives an email, the data associated with this attribute is stored. It can then be referenced in the process using the specified custom attribute.
    Allowed Values:
    A valid custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Mail Body Format

    Definition:
    Specifies the content format for the custom attribute that contains body of an email.
    Allowed Values:
    • HTML - Stores the content in HTML format.
    • TEXT - Stores the content in text-only format.
    • Both HTML & TEXT - Stores 2 copies of the content: 1 in HTML, and 1 in text-only format.
    Default Value:
    HTML
    Custom Attributes:
    No

    Attachment

    Definition:
    Specifies the name of a process attribute that stores the path and file name of the email attachment on the AgilePoint Server machine.

    The attachments are stored on AgilePoint Server in the format [Attachment Location]\[sender email] - [process instance ID]\[file name]

    Allowed Values:
    A text string with no spaces or special characters.
    Default Value:
    None
    Example:
    MyAttachments

    Attachment Location

    Definition:
    The base file path where attachments from the email event service are stored.

    When AgilePoint Server stores the files, it places them in an auto-generated subfolder.

    Allowed Values:
    A valid folder path (without the file name) on the AgilePoint Server machine.
    Default Value:
    None
    Example:
    C:\Files\MyAttachments

    Cc

    Definition:
    Specifies a custom attribute that stores the CC recipients of an email.
    Allowed Values:
    A custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Priority

    Definition:
    Specifies a custom attribute that stores the priority of an email.
    Allowed Values:
    A custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Received Date

    Definition:
    Specifies a custom attribute that stores the received date of an email.
    Allowed Values:
    A custom attribute.
    Default Value:
    None
    Custom Attributes:
    Yes

    Mail Server

    Definition:
    Specifies your email server type.
    Allowed Values:
    • MS Exchange
    • POP3
    • IMAP
    • EWS
    Default Value:
    POP3
    Custom Attributes:
    No

    Exchange Server Name

    Definition:
    Specifies the URL for your email server.
    Allowed Values:
    A valid email server URL.
    Default Value:
    None
    Custom Attributes:
    No

    Allow Duplicate Attachments

    Definition:
    Specifies how to handle multiple emails with the same attachment file.
    Allowed Values:
    • Deselected - Saves the first attachment file and ignores the subsequent attachments with the same file name and extension.
    • Selected - Saves all the duplicate attachment, and appends the incremented number at the end of the file name. AgilePoint Server kicks off a new process for each duplicate, as if it were a unique file.
    Default Value:
    Deselected
    Example:
    test.txt, test(1).txt, test(2).txt , test.png,test(1).png

    Process Template

    Definition:
    Specifies the process template for which you want the email trigger to create a process instance.
    Allowed Values:
    A process template name from the list.
    Default Value:
    None
    Custom Attributes:
    No

    Enable this schedule

    Definition:
    Specifies whether the email trigger is active.
    Allowed Values:
    • Deselected - Specifies that the email trigger is inactive.
    • Selected - Specifies that the email trigger is active.
    Default Value:
    None
    Custom Attributes:
    No