Back to series

This video shows how you can configure Active Directory Sync in RightFax

The Sync module is an XML/XSLT based tool that allows RightFax administrators to create and update users from Active Directory (domains, groups, and organizational units) and LDAP compliant data sources.

Features of the Sync Module include:
Synchronization data is not stored in Active Directory.
Support for multiple domain environments.
LDAP support.
Robust real-time logging and diagnostics.
Nested groups are not automatically included when synchronizing from parent groups.
Synchronization is managed as a standalone service.

To configure, select the Windows account from which to run the Sync module. If synchronizing with Active Directory, the account must be a member of the Active Directory Domain Users group.

Note: The Sync module cannot be configured from a remote computer and must be configured directly on a RightFax Server.

To get started

In EFM, under the server, click Services, and in the right pane, double-click RightFax Sync Module. The RightFax Sync Module Configuration opens.

Click Service Account to select a Windows account from which to run the Sync module.

Defining data sources and destinations

You can define as many data sources and destinations as you need. After you define a data source or destination, a tab for that source or destination is added in the Sync Module Configuration window.

To define a new data source

On the General tab, click Sources & Destinations. The Sync Sources and Destinations window opens.

Click New. The Define Source or Destination window opens.

In the Type box, select either:

Active Directory (Source) for an Active Directory source
LDAP (Source) for an LDAP-compliant source.

In the Name box, type a unique name for the source. This name becomes the label of the associated tab, preceded by the code AD - for Active Directory sources, or LDAP - for other LDAP-compliant sources.

Click OK.

To define a new destination database

On the General tab, click Sources & Destinations. The Sync Sources and Destinations window opens.

Click New. The Define Source or Destination window opens.

In the Type box, select OpenText RightFax (Destination).

In the Name box, type a unique name for the destination database. This name becomes the label of the associated tab, preceded by the code RF- for RightFax.

Click OK.

To configure a data source

In the Sync Module Configuration window, click the tab for the source you want to configure. Active Directory sources have the prefix AD-, LDAP sources have the prefix LDAP-. For the purpose of this video, we will be using an Active Directory source.

Defining filters

When synchronizing with Active Directory, nested groups and OUs are NOT automatically included. This allows for finer control of which groups and OUs to include.

To define a filter for an AD source

On the Filters tab for the source, click New. The Define Filter window opens.

Next to the Domain box, click Browse, select the domain, and then click OK.

As needed, next to Organizational Units, click Browse and then select the check boxes next to the units.

As needed, in the Included Groups box and the Excluded Groups box, add or remove groups you want to include and exclude. For information about selecting groups, in the titlebar of the Select Groups window, click ?, and then click one of the buttons.

Click OK.The filter appears on the Filters tab of the source.

Defining the output

For both AD and LDAP sources, you can change the output for new and modified and for deleted users. The Output tab for an AD source also includes a section for defining the output for disabled users.

To define the output for new/modified users

Click the Output tab for the source.

Under New/Modified Users, define a collection of any number of Active Directory text-based properties that will be used update the RightFax database. To select a predefined collection of typical properties for Windows or Exchange users, click Default Windows Properties or Default Exchange Properties respectively. Default property collections cannot be edited, but you can make a copy of the default to create a new collection.

For the purpose of this video, we will stick with the default setting here, which is “Default Exchange Properties”.

Configuring a destination database

For each destination database, you must configure how the data is brought into the RightFax database.

To configure a destination database

In the Sync Module Configuration window, click the tab for the destination you want to configure.

On the Server tab, in the Server Name box, enter the RightFax server name.

Click RightFax Account and select a RightFax account that has Administrative Access permission and is dedicated solely to the Sync module. The Sync module uses this account to create and delete users on the RightFax server.

Important If you do not use NT authentication, the RightFax account password will be saved as an encrypted registry item on the RightFax server. To avoid this, use NT authentication.

On the Users tab, enter a RightFax user account to use as a template or model for creation of new synchronized users. New users inherit all settings associated with the specified user. You can set up multiple RightFax/Destination profiles, each with a different model user. This allows for customization, such as having different users synchronized into different RightFax groups, or with different RightFax permissions.

Under Incoming User Account Mapping, select the Attempt to map onto existing RightFax users check box if you want the Sync module to check for potential user matches before creating new RightFax users.

Under Modified User Account Mapping, specify how the Sync module will handle modified users:

Select the Replace empty routing code with RightFax User Template's routing code check box to replace the pre-existing routing code of a RightFax user whose fax number was deleted in the Active Directory with the RightFax User Template's routing code. You will not have to manually change the routing code.

Select the Allow sync to change RightFax UserIDs check box to automatically change the User ID of a RightFax user whose ID was changed in the Active Directory. You will not need to manually modify the User ID.

Creating mappings

After you have defined and configured data sources and destinations, you must map sources to destinations to specify which sources will update each destination database. Mappings define how and when sources and destinations are synchronized.

You can define as many mappings as you need and use sources and destinations in more than one mapping. For example, you can synchronize a single Active Directory source into two different
RightFax servers, or two different sources into a single RightFax server.

To create a new mapping

On the General tab, click New. The Sync Mapping window opens.

In the Source and Destination boxes, select your source and destination.

Under Transform File, click Browse, open \RightFax\Capasync\Config, and select the transform file
relevant to your environment. The transform file is responsible for transforming data generated by the source into an XML file translated by the destination. This file together with the RightFax
User Template can be edited to create a custom synchronization template.

Under Schedule, specify when synchronization is to occur.

Click OK.

Verifying user synchronization

Users created or updated by the Sync module appear in EFM and Web Admin with a sync badge next to the icon. In RightFax 16 EP4, the Sync Badge looks like a green dot. In earlier versions of RightFax, this may appear as a blue dot.