•Login to GSMS portal using valid login credentials.
•Navigate to Company Setup in the left navigation panel.
•Select Synchronisation > Synchronisation Summary.
•If Sync-settings are already configured, this page will display them as summary. Now let’s create a Sync item using LDAP (Active Directory) Plug-in.
You should be in Company Setup > Synchronisation > Synchronisation Summary page as explained in section above.
•Click on New button.
•New Synchronisation page will appear as shown below:
•Enter fields as described below:
Parameter |
Description |
|---|---|
Enable Directory Sync |
Optional, Enable or disable the defined sync settings based on needs. |
Name |
Mandatory, Enter a unique name for sync settings. |
Protocol |
Mandatory, Options:
•FTP •FTPS •SFTP •LDAP • Select any of the above protocol that will be utilized while running LDAP queries from the remote server. If LDAP is selected, extra settings appear on the screen that is addressed in next step. |
Host |
Mandatory, Enter host address. |
Port |
Mandatory, Enter the port for connecting to Active Directory Plugin server. |
Username |
Mandatory, Enter the credentials for authenticating against the Active Directory Server. For example “dc=admin, dc=com”. |
Password |
Mandatory, Enter the credentials for authenticating against the Active Directory Server |
FTP File Name |
Mandatory if selection or protocol is FTP, FTPS, SFTP. Enter the filename along with the path to be retrieved for AD-Plugin Sync. |
LDAP Base Distinguished Name |
Mandatory, Base DN defines the starting point or the absolute point of the LDAP tree for each search. For example “dc=admin, dc=com”. |
LDAP Attributes |
Mandatory, Enter the attributes to be returned as response to query results. This should be a comma-separated list of fields in the order of expected retrieval. |
Retrieval Frequency |
Mandatory, Select frequency for data retrieval. Options:
•Daily •Weekday •Weekend •Weekly •Fortnightly •Monthly
|
Start Date |
Mandatory, Start date for file retrieval & LDAP sync. Format DD/MM/YY. |
Start Time |
Mandatory, Start time for file retrieval & LDAP sync. Format HH:MM. |
Description |
Optional, Enter a description of the sync settings. |
•If users select LDAP as a protocol in the Sync settings, additional fields appear on the screen. Below is the description of those fields.
Parameter |
Description |
|---|---|
LDAP Encryption |
Select preferred encryption from the dropdown menu. Options:
•Plain Text •SSL •TLS |
LDAP Authentication |
Select authentication mechanism for LDAP. Currently, supported option is Simple. |
LDAP Query |
Enter a query to filter the search results and retrieve selective information. Table 1.1 provides more explanation and hints in order to help users set the data. |
•Click Save.
•Once you have filled in all the fields with the help of above parameter table, the Synchronisation Information will look similar to the below screen:
•As soon as Sync-information is created, a Test Connection button appears on the screen.
•Click on Test Connection to verify the LDAP (Active Directory) Plug-in sync settings. Return of first 10 DN entries indicates a successful connection. In case of errors, please attempt again. Clicking the Test Connection is only to verify the connection and does not trigger the sync-mechanism so it can be attempted multiple times if needed.
Now, we have successfully configured LDAP (Active Directory) Plug-in sync settings. Next step is to enable the sync at Customer-level.