Default language.

Best practices to configure BMC Remedy Email Engine


These configuration checklists and performance tuning considerations are best practices for AR System Email Engine 9.1, 18xx, 19xx, and 20xx releases and helps users configure Email Engine for best throughput.

Email Engine configuration testing focuses on the following tuning areas:

  • Email Engine process
  • Outgoing Email processing
  • Incoming Email processing

Consider the following points for the testing purposes:

  • Exchange server 2016 is the in-house test environment included in the setup.
  • Ten million records are pre-populated in the AR System Email Messages form for outgoing tests.
  • Five thousand email records are waiting in the Inbox for incoming tests.

Important

All recommendations mentioned in this section should be taken as a starting point. 

We recommend that you conduct testing based on your workload and adjust the settings as necessary.

These best practices are based on high loads of incoming and outgoing messages on a single Email Engine mailbox.

Use the Email Engine Throughput utilityto test the performance in the test environment before and after making changes.

The following table lists the results by using the default and best practice configuration:

Test

Count of emails

Time taken
(in hh:mm:ss)

Throughput (mails processed/min)

Incoming (default)

5000

5:10:57

16.08

Incoming (best practice)

5000

1:08:04

73.46

Outgoing (default)

500,000

23:05:14

360.95

Outgoing (best practice)

500,000

10:52:38

766.12

Email Engine process tuning considerations

The following table provides recommendations for tuning the Email Engine process:

Setting name

Recommendation

Default

Location

JVM Heap Size

Xms256m -Xmx1024m

  • Xms256m
  • Xmx1024m

Registry (Windows)  
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\BMC Remedy Email Engine - <Server Name>\Parameters. 


Emaild.sh (UNIX)   JAVAOPTS

JVM Options

  • XX:+DisableExplicitGC
  • XX:NewRatio=2
  • XX:+UseCompressedOops **
  • XX:+UseConcMarkSweepGC **

837px

Registry (Windows)

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\BMC Remedy Email Engine - <Server Name>\Parameters.

Add a new JVM Option Number <x>  and update JVM Option Count.

For example:

rtaImage.png

Emaild.sh (UNIX) JAVAOPTS

com.bmc.arsys.emaildaemon.MailboxPollingUnitIsMinutes

False

True

Centralized Configuration > com.bmc.arsys.emaildaemon

**Denotes unsupported JVM parameters for Java11 ref# KA000275836

Back to top

Outgoing Email processing tuning considerations

The following table provides recommendations for the outgoing email tuning process:

Setting name

Recommendation

Default

Location

com.bmc.arsys.emaildaemon.SendEmailSetSize

2000

100

Centralized Configuration > com.bmc.arsys.emaildaemon

com.bmc.arsys.emaildaemon.OutgoingMessagesQueueSize

2000

100

Centralized Configuration >com.bmc.arsys.emaildaemon

com.bmc.arsys.emaildaemon.NumberOfSenderThreads

16

4

Centralized Configuration > com.bmc.arsys.emaildaemon

Polling Interval (Outgoing)

15 seconds

10 minutes

ARSystem Email Mailbox Configuration

Modify Index on AR System Email Messages form Ixxx_0_18093

Add C1 to the front of the setting name

Missing C1

Dev Studio

Back to top

Incoming Email processing tuning considerations

The following table provides recommendations for the incoming email tuning process:

Setting name

Recommendation

Default

Location

com.bmc.arsys.emaildaemon.IncomingConnectionRecycleSize

1000

100

Centralized Configuration > com.bmc.arsys.emaildaemon

com.bmc.arsys.emaildaemon.IncomingMessagesQueueSize

1000

100

Centralized Configuration > com.bmc.arsys.emaildaemon

Polling Interval (Incoming)

30 seconds

10 minutes

AR System Email Mailbox Configuration

For answers and resolutions to the most common questions on the Email Engine, see BEST FAQ on AR System Email Engine Issues.

Back to top

Measuring the throughput of BMC Remedy Email Engine

You can measure the throughput of BMC Remedy Email Engine through the email.log file.

Important

Information in this section may not apply to BMC Remedy versions 21.05 or later, which runs in a container environment. For information about troubleshooting BMC products in containers, see Article Number 000385088.

The Email Throughput utility is a low-risk, simple Java tool that analyzes your log file. The Email Engine's email log file includes information about the process of sending emails that it makes it possible to measure the throughput over time. 

The utility runs directly against the email.log and produces a CSV file report and summary statistics. This CSV file can be processed with Microsoft Excel or any other tool to generate a graph of the results. 

Important

This utility analyzes only the outgoing emails and does not report incoming messages.

The following video explains about the Email Throughput utility and its uses:


icon_play.pnghttps://youtu.be/uwZyzktoUlA

To run the utility, extract the contents of the attached zip file into its folder, such as C:\Utilities\EmailThroughput.

There are multiple ways to execute the utility:

  • You can use File Explorer to drag and drop your email.log onto the batch file (EmailThrouput.bat)
  • From the Windows command prompt, you can execute the batch file manually with the following command:
    EmailThroughput <inputfile>
    <inputfile> is the name of the log file, such as email.log.
  • From a Windows or Linux command prompt, you can execute the following Java command:
    java -jar EmailThroughput.jar -i <inputfile>
    <inputfile> is the name of the log file, such as email.log.

In every case, the utility will generate an output file named ThroughputAnalysis.log.

This output file contains some header information about the utility, a CSV report, and a final statistical analysis.



 

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