Documentation forServer & Application Monitor

MAPI User Experience Monitor

This predefined SAM component monitor sends an email from an SMTP mail server to your Microsoft Exchange Server Mailbox and measures the time it takes to complete the round trip. You can use this component monitor to monitor the performance of Outlook. This response time is measured in milliseconds.

The Exchange Server machine uses port 135 for client connections to the Remote Procedure Call (RPC) endpoint mapper service. After a client connects to a socket, the Exchange Server machine allocates two random ports to use to communicate with the directory and the information store. For details, see Network Ports Used by Key Microsoft Server Products (© 2020, Microsoft Corp., available at docs.microsoft.com, obtained on January 22, 2020).

This SAM feature does not currently support polling via Orion Remote Collectors.

To comply with Federal Information Processing Standards (FIPS), JMX monitoring is disabled when FIPS mode is enabled on the Orion server, starting in SAM 2020.2.

Requirements

Install the Microsoft Exchange Server MAPI Client and Collaboration Data Objects package (© Microsoft Corp., available at https://www.microsoft.com/en-us/download, obtained on January 22, 2020) on the Orion server.

Use a credential with rights to the Orion server, that has an Exchange account on the MAPI server, and is linked to the mailbox to be monitored.

Statistic

This component monitor does not compute a statistic. The response time is the difference between the time SAM sends the email and the time it is received by the client.

How the template works

  1. This component monitor waits for the email. If it does not arrive within 20 minutes (the default job timeout), SAM marks the monitor as Down.
  2. This component monitor follows this workflow:
    1. Sends an email to the user mailbox via SMTP. The email has a unique temporary subject name that starts with APM_prefix.
    2. Connects to the user mailbox through MAPI, then searches the emails by Subject.
    3. If it does not find the email it is looking for, it waits and then searches again. It stops if it finds the email, the timeout is reached, or the maximum number of attempts is reached.
    4. If it finds the email, the monitor deletes it from the user inbox.
    5. The monitor collects the total round-trip time for the email and compares it with the thresholds set.
    6. Once it knows the round-trip time, status is given according to where it falls with regard to the thresholds set.
      If the email is not found within the timeout or the maximum number of attempts, or SMTP or MAPI reported an error, SAM marks the monitor as Down.
  3. If the monitor successfully connected via MAPI, SAM deletes the email from the user inbox. If the SMTP call succeeded but MAPI failed, email remains in the inbox.

    It is not currently possible to use the monitor without SMTP and send the email from the same server the monitor is running on via MAPI.

Field descriptions

Description

A default description of the monitor. You can override the default description by adding to or replacing the text, which is automatically saved. The variable to access this field is ${UserDescription}.

Changing the default description to specify what will be monitored can be helpful when receiving alerts and notifications later.

Enable Component

Determines if the component is enabled. Disabling the component leaves it in the application in a deactivated state not influencing either SAM application availability or status.

Credential for Monitoring

Select a credential that:

  • Has rights to log into the Orion server.
  • Has an Exchange account on the MAPI server.
  • Is the user for whom the mailbox will be monitored.

Click a credential in the list, or use the <Inherit credential from node> option. If the credential you need is not in the credentials list, add it in the Credentials Library. See Understand the Credentials Library for details.

Send Email From

Specify the From address of the test email message.

Send Email To

Specify the recipient of the test email message. The recipient should have a mailbox on the MAPI server you are monitoring.

MAPI Profile Name

Specify the name of the MAPI profile

SMTP Server

Specify the SMTP server that sends the test email message.

SMTP Port

Specify the port number used for SMTP sessions. The default value is 25.

Use Credentials for SMTP

Select this check box to use the user name and password from the Credentials for Monitoring field to connect to SMTP servers that support or require authentication.

SMTP Encryption

Select an encryption protocol to connect to the SMTP server: SSL or TLS.

Response Time Threshold

Set the warning or critical threshold conditions based on the response time. The response time is the time in milliseconds it takes SAM to determine that a component is not Down and retrieve any statistical data. See Application Monitor Thresholds.

User Notes

Add notes for easy reference. You can access this field by using the variable, ${UserNotes}.