Edit Event Service Screen > Configuration Tab > Incoming Email screen

Changes the configuration for an incoming e-mail event service.

Figure: Edit Event Service > Incoming E-mail > Configuration tab

Edit Event Service Incoming E-mail Configuration tab

Good to Know

  • This feature is not available for AgilePoint OnDemand.
  • The Event Service AgileConnector must be added via the AgilePoint Server Configuration utility before using the Event Service.

How to Start

  1. In Manage Center, click System System icon > Events Service.

    Open Event Service screen
  2. On the Events Service Screen, click Expand Expand icon for your event service.
  3. Click Edit.
  4. Click the Configuration tab.

Fields

Field NameDefinition

Incoming E-mail Filter Options

Description:
Filters the incoming e-mail based on the sender name.
Allowed Values:
  • Selected - Filters the incoming e-mail based on the sender name.
  • Deselected - Does not filter the incoming e-mail.
Default Value:
Deselected

Check for new messages every

Description:
Does a check for new messages in the e-mail account each specified minute.
Allowed Values:
  • Selected - Does a check for new message in the e-mail account for each specified minute.
  • Deselected - Does not do a check for new messages.
Default Value:
Deselected

Leave Mail on Server

Description:
Stores the e-mail on specified server.
Allowed Values:
  • Selected - Stores the e-mail on server.
  • Deselected - Does not store the e-mail on server.
Default Value:
Deselected

Email Subject

Description:
Specifies a variable that stores the subject of the e-mail that starts the process instance. This variable name is entered as plain text or Xpath.

When the specified e-mail account receives an e-mail, the data associated with this variable is stored. It can then be used in the process with the specified variable.

Allowed Values:
  • One line of text (a string) that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • Email Subject - An example of the variable name format. The variable names can include spaces.
  • /pd:AP/pd:formFields/pd:EmailSubject - An example of an Xpath in the process schema.

Sender

Description:
Specifies a variable that stores the sender of the e-mail that starts a process instance. This variable name is entered as plain text or Xpath.

When the specified e-mail account receives an e-mail, the data associated with this variable is stored. It can then be used in the process with the specified variable.

Allowed Values:
  • One line of text (a string) that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • Sender - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:Sender - An example of an Xpath in the process schema

Attachment Location

Description:
Specifies a folder to store email attachments for the email event service on the AgilePoint Server machine.

This folder is used if an email that starts a process instance has file attachments.

Allowed Values:
  • An absolute path with a folder name - Specifies the full path on the AgilePoint Server machine where email attachments are stored for the email event service. You can specify the absolute path with the folder name. If this folder does not exist, the event service creates the folder, and its parent folders in the path, the first time a process instance is created with the event service.
  • A string that can include spaces - If you enter a text string, this specifies the folder name only. In this case, the folder is created in the path C:\Windows\System32\[specified folder name] on the AgilePoint Server machine.

    If this folder does not exist, the event service creates the folder the first time a process instance is created with the event service.

Default Value:
None
Example:
  • C:\Event Service\My Attachments - When the email event service starts a process instance, the file attachments for the email that starts the process are stored in the specified path on the AgilePoint Server machine. If the path does not exist, the Event Services creates any folders in the path that do not exist.
  • My Attachments - When the email event service starts a process instance, the file attachments for the email that starts the process are stored in the folder C:\Windows\System32\My Attachments. If the My Attachments folder does not exist, Event Services creates this folder under the default path, C:\Windows\System32.
Limitations:
Email attachments can only be used in AgilePoint NX OnPremises or AgilePoint NX PrivateCloud. For information about how to transmit files with emails in AgilePoint NX OnDemand (public cloud), refer to Why Are E-mail Attachments Disabled in AgilePoint NX OnDemand?.

Mail Body

Description:
Specifies a variable that stores the body of an e-mail that starts a process instance. This variable name is entered as plain text or Xpath.

When the specified e-mail account receives an e-mail, the data associated with this variable is stored. It can then be used in the process with the specified variable.

If the message body does not have content, the value of this variable is null.

Allowed Values:
  • One line of text (a string) that can have spaces.
  • A valid Xpath to a node in your AgilePoint schema. Do not include the characters, ${}.
Default Value:
None
Example:
  • Email Body - An example of the variable name format. The variable names can include spaces
  • /pd:AP/pd:formFields/pd:EmailBody - An example of an Xpath in the process schema

Enable Incoming Email Event

Description:
Specifies if the incoming e-mail trigger is active.
Allowed Values:
  • Selected - The incoming e-mail trigger is active.
  • Deselected - The incoming e-mail trigger is not active.
Default Value:
Deselected

Update

Function:
Changes the information of the incoming e-mail event.