Active Directory Connection¶

Introduction¶

An Active Directory connection, created using the Active Directory connector, establishes access to the on-premises version of Active Directory. These activities, once configured, interact with Active Directory through the connection.

Create or Edit an Active Directory Connection¶

A new Active Directory connection is created using the Active Directory connector from one of these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The Global Connections page (see Create a Global Connection in Global Connections).

An existing Active Directory connection can be edited from these locations:

• The design component palette's Connections tab (see Design Component Palette).
• The project pane's Components tab (see Component Actions Menu in Project Pane Components Tab).
• The Global Connections page (see Edit a Global Connection in Global Connections).

Configure an Active Directory Connection¶

Each user interface element of the Active Directory connection configuration screen is described below.

• Connection Name: Enter a name to use to identify the connection. The name must be unique for each Active Directory connection and must not contain forward slashes (/) or colons (:). This name is also used to identify the Active Directory endpoint, which refers to both a specific connection and its activities.

• Authentication: When selected (default), shows additional settings. For documentation, see Establishing a Connection and Additional Configurations Properties:

  • Server: Enter the server.

  • Port: Enter the port.

  • User: Enter the user. A user can be defined using either down-level logon name format or distinguished name format. For example: Domain\user1 or CN=user1,CN=Users,DC=Domain.

  • Password: Enter the password.

  • Use SSL: When selected, specifies to use SSL.

  • Base DN: Enter the base domain name in distinguished name format. For example: DC=Domain.

  • Auth Mechanism: Select the authorization mechanism, one of:

    • SIMPLE

    • DIGESTMD5

    • NEGOTIATE

  • Scope: Select the scope, one of:

    • WHOLESUBTREE

    • SINGLELEVEL

    • BASEOBJECT

  • LDAP Version: Select the LDAP version, one of:

    • 2

    • 3

• SSL: When selected, shows additional settings. For documentation, see Establishing a Connection and Additional Configurations Properties:

  • SSL Server Cert: Enter the SSL server certificate.

• Use Proxy Settings: Select to use Private Agent proxy settings.

• Advanced Configurations: When selected, shows the Advanced Configurations Properties table, which is used to add additional configuration properties as key-value pairs.

  Click the add icon to add a row to the table below and enter a key-value pair for each property.

  To save the row, click the submit icon in the rightmost column.

  To edit or delete a single row, hover over the rightmost column and use the edit icon or delete icon .

  To delete all rows, click Clear All.

  Important

  Fields in the Advanced Configurations table display the variable icon only in edit mode. For these fields' variable values to be populated at runtime, the agent version must be at least 10.75 / 11.13.

• Test: Click to verify the connection using the specified configuration. When the connection is tested, the latest version of the connector is downloaded by the agent(s) in the agent group associated with the current environment. This connector supports suspending the download of the latest connector version by using the Disable Auto Connector Update organization policy.

• Save Changes: Click to save and close the connection configuration.

• Discard Changes: After making changes to a new or existing configuration, click to close the configuration without saving. A message asks you to confirm that you want to discard changes.

• Delete: After opening an existing connection configuration, click to permanently delete the connection from the project and close the configuration (see Component Dependencies, Deletion, and Removal). A message asks you to confirm that you want to delete the connection.

Next Steps¶

After an Active Directory connector connection has been created, you place an activity type on the design canvas to create activity instances to be used either as sources (to provide data in an operation) or as targets (to consume data in an operation).

Menu actions for a connection and its activity types are accessible from the project pane and design component palette. For details, see Actions Menus in Connector Basics.

These activity types are available:

• 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.