Help Center


Knowledge Base


[DOC:Netmail Documentation]

Documentation for Netmail Archive 5.4.
Documentation for [Netmail Archive 5.3] and [earlier versions of Netmail] is also available.

Skip to end of metadata
Go to start of metadata


The Configuration tab of each Netmail Archive cluster displays software version, messaging server type, and network address information about Netmail Archive. The Configuration tab also allows you to edit the settings for your Index Server(s), to test your Index Server connectivity, and to configure your default log settings. For more information about configuring default log settings, see Specifying Default Log Settings.

In the Netmail Administration Console, select the Archive > Clusters > <Cluster Name> object in the tree. By default, the Configuration tab is displayed.

Reviewing Product Information

The About section on the Netmail Archive Cluster Configuration tab displays software version, messaging server type, and network address information about Netmail Archive.

Software Version

Under Software version, you can verify which version of Netmail Archive is installed on your system.

Network Address

Under Network Address, the IP address of the Netmail Archive server which is running the Netmail Administration Console service to which you are connected (typically the Master archive server) is listed.

Messaging Server Type

This field displays the mail system type to which Netmail Archive is connected, Novell GroupWise or Microsoft Exchange. For Microsoft Exchange deployments, this field will show the version of Exchange that was specified during installation. You can use the dropdown list to select a different messaging server type. Your choices are:

  • Exchange 2007 SP1
  • Exchange 2010
  • Exchange 2010 SP1 and up or 2013
  • Office 365

Index Servers

Netmail Archive features a powerful Index Server that performs indexing and enables searching of archived data to allow you to quickly retrieve archived email. During the Index Server portion of the Netmail Archive installation, you specified various network communication ports to be used by the Index Server(s). After installing the Index Server(s), you must configure the Index Servers settings on the Configuration tab in the Netmail Administration Console to inform your archive servers how to connect to the Index Server(s). For most installations, the default ports are used. Select No index server if you are not using an Index Server.

Master IP

Under Master IP, indicate the IP address where you installed your Master Index Server.

Base Port

Under Base Port, enter the port number configured as the base port of your Master Index Server (default is 10000).

Gateway Port

Under Gateway Port, enter the port number configured as the gateway port of your Master Index Server (default is 10011, or if you altered the base port, it will default to the base port value plus 11).

Document Cap

As more and more archived data is indexed, your indexes grow as well. Larger indexes require more processing when they are added to or searched. As such, each Index Server has an operational maximum number of documents that can be indexed before performance starts to significantly degrade. The number of documents varies depending on an Index Server’s resources (mainly RAM and CPU).

To avoid overloading any Index Server, Netmail Archive allows you to specify a limit to the number of documents which can be submitted to it for indexing. Once an Index Server has reached its cap, its existing indexes can still be searched, but no new data will be submitted to it for indexing.

Under Document Cap, enter the maximum number of documents allowed for to be submitted for indexing by your Master Index Server. The default value is set to 50 million documents. You can increase this limit if you reach the limit and see that your Index Server still has spare CPU and memory capacity during index operations, or you can decrease the limit if your Index Server is maxing out on resources before reaching the current cap.

Update Only

If you have an Index Server that you believe has reached maximum capacity or you simply do not want it to receive any more index data, then the Update Only setting will allow you to manually flag that Index Server so that it does not receive any more data for indexing. The server will still be updated when archived data is deleted or re-indexed, hence the setting name of Update Only. Selecting Update Only will apply this setting to your Master Index Server.

Worker Servers

The Worker Servers field allows you to add, edit, or remove Worker Index Servers (or nodes). You must add an entry for a Worker Index Server whenever you add a new Worker server to the index cluster.

  • Add: Click Add to add a new index server. In the Index Node Configuration dialog box, enter the IP address and the Document Cap for the new Worker server. Select the Update Only option if you want to prevent any more data from being submitted to this Worker server for indexing. Click Save.

Note: You must restart the Netmail services on the Master node after adding a new Worker Index Server.

  • Edit: To edit an existing index node entry, highlight the index node in the list of available nodes, and click Edit. Edit the fields in the Index Node Configuration dialog box as required, and then click Save.

  • Remove: To remove an index node, highlight the index node in the list of available nodes, and click Remove. This should only ever be done if you have actually removed the Worker Index Server from your index cluster.

Testing Index Server Connectivity:

Click Test connections to index servers to verify that the Master Archive server can successfully contact your Master Index Server using the settings provided. When you are finished configuring your index servers, Click Save to save your configuration settings.

Default Log Settings

In addition to providing the means to test the logging database connectivity, the Configuration tab of the Cluster object also allows you to configure your default log settings, schedule regular logging database maintenance, and specify default notification settings.

Logging Server Connection String

During the Netmail Archive installation, you were prompted to enter the ODBC connectivity settings for Netmail Archive to use when connecting to the reporting database. This connection string appears in the textbox under Logging Server Connection String. To verify the connection string, click Test. If the test fails, you may have to edit the connection string by entering a new string in the available textbox.

Important: All Archive nodes must be able to connect to the reporting database, and so the connection string must be valid for all nodes. Ensure that you do not use a loopback IP address or “localhost” entry as the Server part of the connection string. Instead, use an IP address or hostname for the database server which can be resolved from all nodes. For a single node archive cluster where the database resides on the only node, a loopback address or localhost entry may be used.

Enable Logging

This option is used in troubleshooting scenarios to add a significant amount of extra logging information to the database when a job runs. The trace information is subsequently downloadable from the database in the form of a Trace Report .csv file. Due to the amount of extra information logged, this option should typically be disabled unless requested by Netmail Support.

Purge Log After [x] Days OR [x] GB

To avoid having your reporting database grow larger and larger over time, Netmail Archive purges data from the database on a daily basis based on the age of the data or the size of the database. This setting allows you to designate the number of days data will reside in the database before it is purged.

Run Maintenance At

This option allows you to set the time of day, in hours and minutes (HH:MM), when you want the database purge to take place.

Purge Log DB Now

Click Purge Log DB Now if you want the database purge to take place immediately.  This will immediately begin the database purge.

Tracking Settings

This option has the precise ODBC connection string used to connect to the reporting database.

Enabling Notifications

On the Configuration tab, under Default Notification Settings, specify the email address of the administrator who will receive the logging notifications for the Address Book Sync job as well as the address that will be inherited on the Log Settings tab of any newly created job.

If configured on the Log Settings tab to do so, a job will send a notification email to the specified email address upon job completion. This email contains job details, its start and end times, and attachments in both XML and HTML formats containing a summary report. This summary report contains information about the job extracted from the reporting database, and is designed to provide administrators or operators with a quick view of the success of the job.

Important: After specifying your options on the Configuration tab, click Save to save your settings. If you do not click Save, your settings will not be saved.

  • No labels
Write a comment…