Troubleshooting LDAP integration via MID Server

  • Release version: Washingtondc
  • Updated February 1, 2024
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Troubleshooting LDAP integration via MID Server

    This guide addresses common issues encountered when integrating LDAP via the MID Server and provides troubleshooting steps through the External Communication Channel (ECC) Queue.

    Show full answer Show less

    Key Features

    • Test Connection Issues: Use the Test connection related list to verify LDAP connections. Successful tests will show true in the ECC Queue for the topic name LDAPConnectionTesterProbe.
    • Browse Issues: Use the Browse related list to view LDAP directory records. Successful operations will also show true in the ECC Queue under the topic name LDAPBrowseProbe.
    • Load Import Issues: For data uploads, check ECC Queue for LDAPProbe and LDAPProbeCompleted messages. The Name column indicates the total records returned and the highest record number in the batch.
    • LDAP Paging: Ensure the paging size on the LDAP server is set to at least 1000; adjust the MID Server property glide.ldap.maxresults accordingly.
    • Binary Data Import: To import binary data, include the binary attribute in the MID Server property glide.ldap.binaryattributes, such as jpegphoto for user photos.

    Key Outcomes

    By following the troubleshooting steps outlined, ServiceNow customers can effectively diagnose and resolve LDAP integration issues, ensuring smooth data connection and import processes. Regular monitoring of the ECC Queue will aid in identifying errors and confirming successful operations.

    You may encounter issues in the following areas while integrating LDAP via MID Server.

    You can troubleshoot these issues by viewing the outputs found in the External Communication Channel (ECC) Queue (Discovery > Output and Artifacts > ECC Queue).

    Test Connection Issues

    When defining OUs within the server, there is a Test connection related list that is used to verify the LDAP connection. When you click this link, the ECC Queue should show a single output message with a topic name of LDAPConnectionTesterProbe. After the test has completed on the MID Server, the ECC Queue should show an input message with the same topic name. If the Name column for the input message shows true, the test was successful. Drill down into the record to view the payload and ensure it does not contain error messages.
    Figure 1. Test Connection

    Browse Issues

    When defining OUs within the server, there is a Browse related list that is used to view the LDAP directory records that the OU definition returns. When you click this link, the ECC Queue should show a single output message with a topic name of LDAPBrowseProbe. After data has been returned from the MID Server, the ECC Queue should show an input message with the same topic name. If the Name column for the input message shows true, the test was successful. Drill down into the record to view the payload and ensure it does not contain error messages.

    Load Import Issues

    When uploading data (for example, using the Test Load 20 Records feature), the ECC Queue should show a single output message with a topic name of LDAPProbe.

    After data has been returned from the MID Server, the ECC Queue should show another input message called LDAPProbeCompleted. The Name column for this input message shows the total number of records returned.

    An additional input messages, also named LDAPProbe, is displayed. The Name column for this input message displays the highest record number in the batch. If the total number of records returned is 258 and the batch size is 200 (the default), two LDAPProbe (200, 258) incoming messages will be received, and one LDAPProbeCompleted (258) incoming message will be received.

    Drill down into the record to view the payload and ensure it does not contain error messages.
    Figure 2. Import Load
    Also keep an eye out for an output message called LDAPProbeError.
    Figure 3. Error message

    Click the link in the Name column to view the details of the error.

    LDAP paging

    LDAP paging does not work if the paging size on the LDAP server is less than 1000. Set the MID Server property glide.ldap.max_results to a value less than or equal to the LDAP server paging size.

    LDAP fails to import binary data

    To import binary data via LDAP, such as a user photo, you must include the binary attribute in the MID Server property glide.ldap.binary_attributes. For the user photo example, the attribute may be jpegphoto.