Skip to Content

Active Directory Connector

Summary

The Active Directory connector establishes access to the on-premises version of Active Directory.

Important

We recommend using the Active Directory v2 connector to connect to the on-premises version of Active Directory as it improves the usability of the connection configuration UI and allows for additional configuration properties.

The Active Directory connector provides an interface for creating an Active Directory connection, the foundation used for generating instances of Active Directory activities. These activities, once configured, interact with Active Directory through the connection.

The Active Directory connector is accessed from the design component palette's Connections tab (see Design Component Palette).

Note

This connector can be used only with Private Agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection Documentation

In addition to the Active Directory connection, see the comprehensive Active Directory connection details page. Configuration details such as these are included on that page:

  • Getting Started: Initial steps for establishing a connection.
  • Advanced Features: User-defined views and SSL configuration.
  • Data Model: The data model that the connector uses to represent the endpoint.
  • Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity Documentation

Together, a specific Active Directory connection and its activities are referred to as an Active Directory endpoint:

Active Directory activity types

  • Query: Retrieves records from a table at Active Directory and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at Active Directory and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at Active Directory and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at Active Directory and is intended to be used as a target in an operation.

Prerequisites and Supported API Versions

The Active Directory connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private Agent.

Refer to the connection data model documentation and the Active Directory documentation for information on the schema nodes and fields.

Troubleshooting

If you experience issues with the Active Directory connector, these troubleshooting steps are recommended:

  1. Click the Test button in the connection configuration to ensure the connection is successful and to ensure the latest version of the connector is downloaded to the agent (unless using the Disable Auto Connector Update organization policy).

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging for Private Agents to generate additional log files and data.

  4. Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.ActiveDirectory" level="TRACE"/>

  5. Check the agent logs for more information.