MAPI Device Engines

MAPI Device Engines enable AlarmPoint to send notifications to and receive responses from service providers using the MAPI email protocol. Note that MAPI is a Windows-only protocol and requires that you install a MAPI email client on the system running the Device Engine. Because MAPI clients usually have a user interface and may popup dialog boxes from time to time, it is recommended that you use SMTP/POP or SMTP/IMAP for email instead.

Note: When using MAPI with Microsoft Outlook, ensure that you install the latest patches for Outlook, available from the Microsoft web site. If you are using Microsoft Outlook 2007, ensure that you have applied Service Pack 1 (SP1).

For most protocols, the connection is transient, and each notification contains the required provider information. MAPI providers are different in that they require that connections are constantly established. In AlarmPoint, this means that the provider configuration must be performed at the Device Engine level, rather than the Protocol Provider level.

Expanded MAPI Logging

To assist in troubleshooting MAPI issues, additional logging has been added for the library file used by MAPI Device Engines. Any activity that occurs in alarmpoint_mapi.dll is written to a log file located at:

<AlarmPoint>/logs/mapi_dll_log.txt
 

The maximum size for this log file is 10MB, after which it is rolled over into a single backup file named mapi_dll_log1.txt.

MAPI Device Engine details

Detail

Description

Name

Name used to identify this Device Engine.

Description

Brief description of this Device Engine (optional).

Notification Polling

How often (in seconds) the Device Engine polls the notification node for new alerts. Must be a whole number greater than or equal to 10 and less than or equal to 300.

Concurrent Threads

Number of requests or tasks that this Device Engine can run at the same time. Your Active Licenses control the maximum number of available threads.

Logging

For an explanation of Device Engine logging, see MAPI Device Engines.

Profile

Your MAPI mail profile. (To configure profiles in Windows, click Start > Settings > Control Panel > Mail.)

Password

If required, the password for the specified mail profile.

Mailbox Polling Interval (sec)

How often, in seconds, the Device Engine checks the mailbox for responses.

Notification Key

String included in the body of the notification that identifies the original alert or notification to which the User is responding.

Normally this key is enclosed with delimiting characters; e.g., the default value, <%Notification Key%>.

If the delimiting character sequence is not guaranteed to be unique, the Device Engine may make an incorrect match, causing an exception and response failure.

If no delimiters are present, the first word of the response will be used as the notification key. If the delimiters occur more than once in the body of the notification, the first instance is used as the notification key.

Response Key

String included in the body of the notification that identifies the beginning of the response portion of the User’s return message.

Choice Message

Portion of notification message describing the User’s response options.

Response Message

Instructions to the recipient on how to respond to the notification.

To use MAPI with AlarmPoint:
  1. Log on with a Domain user account with Admin rights on the computer (this Domain user must have full access to the MAPI mailbox you are planning to use with AlarmPoint).
  2. Install Outlook on the system and configure the email Profile using the Domain account.
    1. When creating the Profile, ensure that the Use Cached Exchange Mode check box is clear.
  3. Start Outlook and confirm that you can send and receive email using the newly created profile (you must be able to send and receive email with Outlook before AlarmPoint will be able to use the new profile to do so).
  4. Click Start > Control Panel > Mail > Show profiles and verify the Profile name (required for for AlarmPoint).
  5. Create the MAPI Device Engine in AlarmPoint using the Profile name verified in the previous step.
  6. Create a Protocol Provider of type MAPI, specifying your desired settings.
  7. Create a User Service Provider that contains the Protocol Provider.
  8. Stop the AlarmPoint Node service, and then set the Log On properties to log on as the Domain account used in steps 1 to 3.
  9. Start the Node Service.
  10. To test the MAPI setup, create an AlarmPoint User with an Email Device, and then send a validation message to the Device.