Skip to Content

LDAP Delete Entry Activity

Introduction

An LDAP Delete Entry activity deletes entries in an LDAP endpoint and is intended to be used as a target to consume data in an operation. After configuring an LDAP connection, you can configure as many LDAP activities as you like for each LDAP connection.

Create an LDAP Activity

An instance of an activity is created from a connection using an activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an Activity Instance in Component Reuse.

An existing activity can be edited from these locations:

Configure an LDAP Delete Entry Activity

Follow these steps to configure an LDAP Delete Entry activity:

Step 1: Enter a Name and Specify Settings

LDAP Delete Entry Activity Configuration Step 1

Tip

Fields with a variable icon Variable icon support using global variables, project variables, and Jitterbit variables. Begin either by typing an open square bracket [ into the field or by clicking the variable icon to display a list of the existing variables to choose from.

  • Name: Enter a name to use to identify the LDAP Delete Entry activity. The name must be unique for each LDAP Delete Entry activity and must not contain forward slashes (/) or colons (:).

  • DN: Enter the distinguished name of a single entry to delete. The entry must not have any children.

  • Continue on Error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

  • Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

  • Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Review the Data Schemas

LDAP Delete Entry Activity Configuration Step 2

  • Data Schema: The request and response data schemas for LDAP are displayed. If the operation uses a transformation, the data schemas are displayed again later during the transformation mapping process, where you can map to target fields using source objects, scripts, variables, custom values, and more.

    The LDAP connector uses the Apache Directory LDAP API version 1.0.1. This API supports all types of LDAP servers, not just ApacheDS. Refer to the Apache LDAP API 1.0.1 Documentation and documentation on the specific LDAP server for information on the schema fields.

    These are the schema fields shown in the example screenshot above:

    • Request:

      Request Schema Field/Node Notes
      json The format of the request schema
      deleteEntry-request The Directory Services Markup Language (DSML) request
      request The request to the LDAP server
      item A request item
      dn The distinguished name representing a position in a hierarchy

    • Response:

      Response Schema Field/Node Notes
      json The format of the response schema
      deleteEntry-response The Directory Services Markup Language (DSML) response
      response The response from the LDAP server
      item The response item
      success A boolean indicating if the request was successful
      errorDetails The error details
      errorMsg An error message returned by the LDAP server

  • Refresh: Click the refresh icon Refresh icon or the word Refresh to regenerate schemas from the LDAP endpoint. This action also regenerates the schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

  • Back: Click to temporarily store the configuration for this step and return to the previous step.

  • Finished: Click to save the configuration for all steps and close the activity configuration.

  • Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next Steps

After configuring an LDAP Delete Entry activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure an operation's operation settings, which include the ability to chain operations together that are in the same or different workflows.

After an LDAP activity has been created, menu actions for that activity are accessible from the project pane in either the Workflows or the Components tabs, and from the design canvas. See Activity Actions Menu for details.

LDAP Delete Entry activities can be used as a target with these operation patterns:

Other patterns are not valid using LDAP Delete Entry activities. See the validation patterns on the Operation Validity page.

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.