Creating an Inbox that Creates a Generic Business Object
About Creating Generic Business Objects from Email
This feature allows you to configure the Neurons for ITSM email service to handle any generic business object except for service requests. You create an inbox for each business object type. So for example, all emails that are to create a task go to the task inbox, all emails that are to create a change go to the change inbox, etc.
To create a new business object from an email, you must include all of the mandatory fields in the email body.
Neurons for ITSM does not support HTML content in emails that are sent to create a generic business object.
To create a generic business object from an email, first create an inbox to which users can send emails in order to create or update the business object. When creating the inbox, define the business object type (specified by the Email Processor parameter in Creating an Inbox) as Other.
You define field and value pairs for data in the body of the email that tell the email listener what to do. Use a configurable field value separator to separate the key from the value. Use a configurable record marker to separate the information for multiple records within a single email.
Creating an Inbox for Creating Generic Business Objects from Email
You must create an inbox for each business object type that you want to be able to create from an email. Follow these steps:
- Log in to Neurons for ITSM.
- Open the Email Config workspace. The mailbox configuration appears.
- From the Inbox tab, click New. A blank Inbox Configuration window appears.
- Enter information into the fields. For information about the fields not listed here, refer to About Creating Incidents from Emails.
Field | Description |
|---|---|
Email Processor | The name of the business object to create. Choose Other. |
Name | The name of the business object. |
Unique Key | The field to identify the unique record, such as ChangeNumber. |
Create Incident On Error | Specifies if the application should create an incident if there is a problem creating the generic business object. |
Record Marker | A symbol that separates multiple record information within an email. For example, if you enter # as the record marker, information in the email body preceding a # symbol creates one record and information after a # symbol creates another record. When inserted in a message body, this record marker (for example, the # symbol) allows you to create multiple records from the body of a single message. NOTE: If one or more records in the email do not contain all of the required fields, the application logs an error, even if some of the records contain all of the fields. |
Field Value Separator | A symbol that separates record fields in an email. For example, if you enter ? as the field value separator, information in the email body preceding a ? symbol creates one field of a record and information after a ? symbol creates another field. NOTE: If the value contains the symbol used as the field value separator, preface the field value separator with the \ symbol. For example, if the field value separator is $ and the value for the record is "The cost is $400", add the \ symbol so that the value is "The cost is \$400". This tells Neurons for ITSM to ignore the $ symbol in the value. Otherwise, the application gives an error. |
Inbox that Creates an Incident
- Click Save.
Examples
See the following examples:
Sending an Email to Create a Generic Business Object
Sending an Email to Create a Generic Business Object
Based on the mailbox created above, "Summary$Test incident creation"' means that the text "Test incident creation" is stored in the Summary field. The $ symbol is the field delimiter.
Sending an Email to Create Multiple Generic Business Objects
To create multiple generic business objects from one email, use the symbol specified in the Record Marker field to separate the information for each business object instance.
The following email results in the creation of two change objects and assumes that the value specified in the Record Marker field is "^". (Note the use of the record marker "^" in the email body.)
Sending an Email to Create Multiple Business Object Records
For more information about the syntax used in the ProfileLink field in the example, refer to Using Relationship Specifiers.
Sending an Email to Update a Generic Business Object
You can update an existing business object by sending an email with the business object type and business object ID as the subject and the updated information in the email body, using key/value pairs.
Sending an Email to Update a Generic Business Object
As an alternative, you can update business objects using the business object type "other" with detailed field values. The email configuration is the same as shown above.
The following email updates two change records. Note that in the mailbox configuration, the value for the Unique Key field is ChangeNumber.
Sending an Email to Update Multiple Generic Business Object Records
