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

Netmail Archive uses a logging database for accumulating information on the execution of Netmail Archive jobs. By default, this database is stored in the PostgreSQL database system, which is installed and set up at Netmail Archive deployment time. Other database types are supported, but the type of database system used does not affect the reporting mechanism. It is the information stored in this database which is used to compile Job Reports.

For Job Reports to work correctly, it is essential that the logging database is successfully set up and that the Netmail Archive archive servers can successfully connect to it. This can be tested within the Netmail Administration Console by navigating to the Clusters > <Cluster Name> object, scrolling down the Configuration tab, and clicking the Test button next to the Default Log Settings, as shown in the screenshot below.


On this page:

Any failure at this stage indicates a problem with the connection string or the underlying database, and assistance should be sought to help identify the cause.

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.

This option is enabled and disabled on a job-by-job basis on the Log Settings tab of the job. In the Default Log Settings section, this setting dictates the default value that will be inherited by any newly created jobs, as well as enables or disables Trace logging for the Address Book Sync system job.

Purge Log After [x] Days

To avoid having your reporting database grow larger and larger over time, Netmail Archive purges older data from the database on a daily basis. 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.

Tracking Settings


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 a 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…