The Lucy LDAP Synchronization Tool is a Windows-based software for both a one-time sync or can be installed as a Windows service for periodic syncronization. It receives user data from your Active Directory environment, prepares and imports into a selected recipient group in Lucy.
Currently only recipients import is supported.
To install the Lucy LDAP Synchronization Tool, your computer must meet the minimum requirements below.
|Processor||1 GHz or faster 32-bit (x86) or 64-bit (x64)|
|Operating System|| Windows 7 (x86, x64) or later
Server 2012 R2 (x64) or later
*Operating system must have .NET Framework 4.5 or later installed
|Memory||1 GB RAM (32-bit) or 2 GB RAM (64-bit)|
|Disk Space||100 Mb or more|
In order to allow the tool to manage recipient groups in Lucy, you must add your current workstation IP address (or your public IP address if you use a remote Lucy server) to the API Whitelist. Learn more here.
The first step is to configure the connection to your Lucy server by entering the following information:
Click on "Test connection" to validate the credentials.
When finished, click Next to create a new recipient group or select an existing one.
Next, you need to configure the connection between the tool and your Active Directory by entering the following information:
When finished, click Next to select Active Directory groups.
Once your Active Directory settings are configured, select the Active Directory groups from which users will be imported into Lucy.
There are two options:
If an option Define filter for a single group is used, you may either select an existing group or create a new recipient group using the buttons "New recipient group" and "Delete recipient group".
Please keep in mind that deleting any recipient groups using the tool may affect the statistics in your campaigns. Deletion cannot be undone.
You can also use Search filter to find the specific group.
At this point select an LDAP group for synchronization or use Filter to build your own query.
You may use regular Active Directory search filters, for example: (|(objectClass=inetOrgPerson)(objectClass=user)). See Microsoft Documentation for more info.
Click on "Test filter" to see the first 10 users received from Active Directory.
When you have selected the Active Directory group, click Next to see the overall settings.
Multiple group synchronization can be proceeded with the latest version of the LDAP synchronization tool. Selecting multiple AD groups will add separate recipient groups to Lucy.
Check Active Directory groups and press Add
Attention! A new recipient group will be created in Lucy with the same name as the user group. If the recipient group already exists, new recipients will be added to it. Please note that Lucy will send emails for any new recipients added to the running campaign.
Once the synchronization process is finished, you can observe the debug log.
You can save the import settings to a file by clicking the "Save config" button. The file can be used the next time you import recipients. To do this, select the configuration file at the first step of the synchronization wizard.
Click on "Register service" to install the tool as a Windows service. When running as a Windows service, the tool performs the sync every 10 minutes ( not configurable in the current version).
To remove the service, run the tool once again and click "Remove service" on the Lucy connection settings step.
By default, the tool performs the following actions when specific events happen to users in your Active Directory (the actions are not configurable in the current version):
|Possible reasons:|| The account used is not an administrator
Login or password is invalid.
|Solution:|| Use an account with Administrator role.
Check your credentials or try another account
|Possible reasons:||Your IP address is not listed in the API whitelist|
|Solution:||Add your computer IP address to API whitelist. Learn more here.|
|Possible reasons:|| Active Directory server is not accessable from your computer (behind a firewall).
Invalid credentials or insufficient permissions.
|Solution:|| Run the tool while inside the corporate network or connect to it using VPN.
Check your account or use a different account.