How modify instructions work with incoming email


The following figure presents a sample scenario that demonstrates how to send Modify instructions in an email message:

Using incoming email to modify requests

23.2_modify_instructions_incoming_emails.png

Scenario

  1. The administrator at Apex Global completed the following tasks to enable the Email Engine to modify entries in the AR System server:
    • Associated the incoming and outgoing mailboxes.
    • Enabled the incoming mailbox to accept Modify instructions.
    • Created and sent security keys to trusted users of AR System, for example, the IT department.
      For more information, see Allowing-and-securing-modify-actions-through-incoming-emails.

      The incoming and outgoing mailboxes in the Email Enginecan be one physical mailbox, performing both the incoming and outgoing functions.

  2. Joe User has a problem with his PC. He needs an IT engineer to install the latest service patch and has submitted an entry on the HD Incident form (Request ID 000000000000055).
    Francie Frontline, who has administrator privileges, is working on Joe's ticket. She needs Joe to verify his current PC configuration and modify his ticket with updated information.
    She sends an email to Joe that includes the following mandatory parameters:
    • Key
    • Action: Modify
    • Form name
    • Server name
    • Request ID
      Her email to Joe must contain at least these items for Modify instructions to work properly. She also includes names of fields that Joe can modify.
      After she sends her email, a copy of the email is stored in the Messages form and the email is sent to Joe.
  3. Joe User replies to the email. He updates the work log label-value pair in the email, for example, Worklog !536870922!: I'm running Service Patch 6
    Because he has used email to submit and query AR Systementries, he knows how to include additional fields to update information about the new department he was transferred to, for example, !Department!: Product Marketing.
  4. The Email Enginereceives the reply from the mail server and verifies that Francie's original email exists in the Email Engine(in the AR System Email Messages form) and that the sender's email address is contained in the recipient field of the original email. It then parses the modify instruction in Joe's email, and modifies the ticket in the HD Incident form.
  5. The Email Enginereturns the results to the sender, Joe User.
    If the email had failed, for example, Joe modified the encryption value or he tried to use a different Request ID, the Email Enginereturns an error message that indicates faulty parameters or other problems.

Limitations to sending a Modify instruction

Consider the following limitation when using email to modify entries:

  • The Email Enginedoes not support the Modify All operation. Only one entry can be modified with one Modify instruction. However, you can include multiple Modify instructions in one email message if you include the full login information (server, login, and password) for each entry that you want to modify, as in the following example:

    Server: polycarp
    Login: Francie Frontline
    Password: Key:1234
    Action: Modify
    Schema: HD Incident
    Request ID: 000000000000003
    !536870913!:
    Server: polycarp
    Login: Francie Frontline
    Password: Key:1234
    Action: Modify
    Schema: HD Incident
    Request ID: 000000000000004
    !536870913!:
  • You can combine the modify instruction with submit or query instructions in a single message, provided multiple instructions (modify with submit or query) have been sent from the administrator.
  • Users cannot add new instructions when replying to a message containing modify instructions.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*