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

In the tree menu on the left-hand side of the Netmail Administration Console, select Archive > Clusters > <Cluster Name>. By default, the Configuration tab is displayed. The Configuration tab displays software version, 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(s), and to set your default log and notification settings. For more information on using the Cluster Configuration tab to configure Netmail Archive, see Netmail Archive System – Configuration Tab.

For now, click the Address Book Sync tab.

The Address Book Sync tab lets you specify your Address Book Cache settings.

Address Book Cache

Netmail Archive reads information from the address book of your mail system into an Address Book Cache stored in the Netmail Archive configuration held in eDirectory. This cache is subsequently used by Netmail Archive to store additional information about the mail system accounts and to allow you to allocate these accounts to Netmail Archive jobs, such as archive jobs. The Address Book Cache is updated by a periodic process which reads the mail system address book.

The settings under Address Book Cache control how often the Address Book cache is updated and how Netmail Archive connects to your mail system to read the address book.

Cached Address Book Update Settings: By default, following installation, Netmail Archive is pre-configured to run the address book cache update every day at 06:00 hours, so as not to compromise the performance of your email system during peak hours. This timing can be amended by adjusting these settings.

  • In the Run cache update process at field, set the time in hours and minutes (HH:MM) when you want to update your Netmail Archive Address Book Cache. It is recommended that you schedule the cache update process to run during overnight or evening hours to avoid using valuable CPU resources during the day.
  • In the Update cache every [x] days field, set the frequency, in days, for how often you want the cache update process to run. If you update your address book frequently, you may want to schedule regular cache updates.

Configured Address Book Server: These settings define the connection that is to be used to read your system address book. They are configured initially during the installation of Netmail Archive.

  • In the EX User field, enter an Exchange mailbox account to be used when connecting to the Exchange system. It is recommended that Netmail Archive uses a dedicated mailbox, belonging to the dedicated Active Directory account above, which was created at installation time. Again, specify the account in the format DOMAIN\userid (Down-Level logon name).
  • In the EX Password field, enter the password for the EX User account specified.
  • In the EX Path field, enter the Exchange Web Services (EWS) URL for a local Exchange CAS server running the EWS interface (by default, all Exchange CAS servers are be enabled for EWS).  This CAS will be used to the send the report after each job completes. It is also the default CAS used for all Netmail Archive connections.
  • In the EX Email field, enter the email address to which you want job reports sent upon job completion.
  • The Load users from file option allows you to import an existing user list by specifying the Path where the file is saved.

Important: After making any changes to these options, click Save to save your settings. If you do not click Save, your settings will not be saved. The cache update will occur at the scheduled time. To update the cache immediately, choose Run Now.

Note: Netmail does not support email addresses with a leading underscore character (e.g., _username@email.com). The Address Book Sync job will return an error if tries to process such an account.

Tip: If your system meets the required system recommendations, you should be able to process approximately 4000 users per minute.

Updating the Address Cook Cache Manually

Netmail Archive will automatically run an Address Book Sync when you start the Netmail Archive services on your Master archive server. If you change the Address Book Cache settings, or if you wish to run the update process manually for any other reason, select Run Now on the Address Book Sync tab to update the Address Book cache immediately.

Monitoring the Address Book Sync Job

When you run the update process manually, or if you wish to confirm the automatically scheduled execution, you can use the Monitor feature of the Netmail Administration Console to track the execution of the update process. In the tree menu, click the Archive object, and then select the Monitor tab. The Monitor tab tracks the jobs currently being processed by your archive nodes.

On the Monitor tab, expand the Cluster node objects by clicking the + icon. A SyncAB Trigger should appear in the Running Job ID column of the Master node. You can monitor the status of the job and the elapsed time of the job.

Confirming that the Address Book Sync has Run Successfully

Once the Address Book Sync job is complete, you can confirm that it executed successfully in one of two ways:

1. Job Report: In the tree menu on the left-hand side of the Netmail Administration Console, select Archive > Clusters > <Cluster Name>, and then select the Report tab. The Report tab displays the job report for the Address Book Sync job. You should see a recent entry for the most recent execution and a Succeed count matching the number of accounts synchronized. For more information about the Report tab, see Reporting with Netmail Archive.

2. Archive Agent Job - User Selection List: In the tree menu, select Archive > Clusters > <Cluster Name> > Agents > Archive > Sample Archive Job. This will display the Job Settings tab of a sample archive job. Under the User List list box, click Select to open the User List window. Leaving the All option next to Type selected, click List Users. Assuming the Address Book Sync process completed successfully, the list of mail system accounts from the cache will be loaded into the selection list on the left-hand side.

  • No labels
Write a comment…