Formatted e-mails must be carefully composed to ensure that the e-mail listener successfully processes e-mails and that the system performs the necessary actions. You can use specific keywords in the body of the e-mail message to compose a correctly formatted e-mail.
There are two sets of keywords that you can use, depending on whether you want to implement attribute-value pair formatting or XML formatting. The following table specifies the keywords that apply when using attribute-value pairs or XML.
Keyword | Format type | Required | Purpose |
---|---|---|---|
#MAXIMO_EMAIL_BEGIN | Attribute-value pairs | Yes | The keyword marks the beginning of formatted e-mail content in an e-mail message. |
#MAXIMO_EMAIL_END | Attribute-value pairs | Yes | The keyword marks the end of formatted e-mail content in an e-mail. |
LSNRAPPLIESTO | Both | Yes | A value must be provided. The value represents a business object upon which an operation is performed. |
LSNRACTION | Both | Yes | A value must be provided. The value can be CREATE, UPDATE, CHANGESTATUS or QUERY. The value specifies the operation to be performed on the business object. |
LSNRWHERECONDITION | Both | No | The keyword is used only in e-mails that query a business object. The value represents a valid SQL where condition that is to be applied on the business object. |
LSNRRESULTCOLUMNS | Both | No | The keyword is used only in e-mails that query a business object. The value represents one or more columns from the business object. The values are returned in the response e-mail to the query. |
&AUTOKEY& | Both | No | The keyword is used as a value for an attribute or an XML tag for e-mail messages that are intended to create business objects. If this keyword is used, the particular attribute is autokeyed using standard system. |
&SYSDATE& | Both | No | The keyword is used as a value for an attribute or an XML tag for e-mail messages that are intended to create business objects. If this keyword is used, the value for the particular attribute is a standardized date format as derived from the underlying system database. |
<MAXIMOEMAILCONTENT> </MAXIMOEMAILCONTENT> |
XML | Yes | This tag is used only in XML formatted e-mails to specify the contents of the e-mail message. This tag serves as the root of the XML document being composed in the e-mail message. |