LDAP Agent Settings Editor

The LDAP Agent now ships with an LDAP Agent settings editor which is launchable via the Windows Start menu. The program runs with elevated privileges, so when a user starts it, they will be prompted by UAC. This limits the running of the program to solely administrators of the computer the LDAP Agent is installed on.

The editor has several functions:

At the top is the agent status which in this case shows running. To the right of it are three buttons for start, stop, and restart of the service. If you press one of those buttons the program will take the action on the LDAP Agent and also update the status to indicate running or stopped.

Sometimes during an install, data may have been entered incorrectly or may need to be changed. If that is the case, then the environment URL, Evo directory, access token, secret, sync interval, or sync groups may be changed. The “Apply” button is how the settings are saved. If the agent is running, they will be commanded to shut down the service before applying the settings. The secret is used in cryptography and is stored in a secure place on the computer. To enable viewing the secret, the user must check the “Reveal Secret” checkbox.

Adding/deleting synced groups or renaming the existing groups should be easy. Please follow these steps below.

1. Launch the LDAP Agent Settings.

2. Stop the LDAP Agent service.

3. If you want to rename the group(s), please go ahead and do that at this step using your on-prem AD. If you don't want to re-name any group, please process to step 4.

4. Select the correct group(s). Hold Ctrl key to select more than one group.

5. Select "Apply" to save the changes. Then turn on LDAP service.

6. It's done! Now you can go to Evo portal to check the status of the groups or accounts.

Done!

Note:

1. Re-naming group will not add/remove any users in the group.

2. Removing group will remove all users in the groups.

The program contains a “Connection Test…” button which performs the following connection tests on the running agent. The settings editor issues a command to the running agent and the agent performs these tests:

The editor has the capability to collect event logs and other settings relevant to performance of the LDAP Agent which will allow Evo Support and Engineering to troubleshoot the problem. Clicking on the “Build Log Archive” button causes a zip file to be saved to the users desktop and the user will be prompted to copy that zip file to the clipboard—to email or paste to another location. The following data is collected and saved in the zip file in JSON files which are viewable by the operator.

An example file name is: Evo_evotestdomainad_230504_133150.zip. If we break it down, we see that it has the format of Evo_{Evo directory name}_{yymmdd}_{hhmmss}.zipThis allows it to have a roughly unique name.