Connector Guides › Connector Xpress Guide › Screens and Dialogs › Operation Bindings – Stored Procedure Editor

Operation Bindings – Stored Procedure Editor

This dialog lets you specify the parameters for a stored procedure style operation binding.

This dialog contains the following fields:

• Available object classes

  Displays the available mapped object classes in the following formats:

  • Object class format

    Format: DisplayName [connectorMapToObjectClassName]

    Example: User Account [inetOrgPerson]

  • Ambiguous object classes format – Displayed as a single item in the following format:

    Format: DisplayName [connectorMapToObjectClassName1 | connectorMapToObjectClassName2 | …]

    Example: Default Container [organizationalUnit | organization]

  Note: If you choose any ambiguous object class for the concurrent Opbinding, the LDAP object class name is always used in the Opbinding xml content. As a result, Connector Xpress clears the Use Native Name check box and makes it unavailable.

• Added object classes

  Lets you specify the object classes you want to add to this script operation binding.

• Execute this procedure

  Specifies when you want the connector to execute the stored procedure.

• Description

  Describes the operation binding.

• Abort operation if procedure fails

  Specifies how errors are handled. For example, if the timing is set to Before or After, and this check box is selected, exceptions are thrown and the operation aborts if any errors occur. If this check box is cleared the connector logs the error but the operation continues if an error occurs.

  If the timing is set to Instead Of, and an error occurs, the connector always throws exceptions and aborts the operation when executing the operation binding.

  When the timing is set to Instead Of this field is set to true by default, and cleared by default when the timing is set to After.

• Use native name

  Specifies that the connector uses connector-map-to attribute names for the binding rather than DYN LDAP attribute names.

• Lookup Level

  Specifies whether the attributes or the deleted object are cached for the opbinding to function and controls the lookup of all an object's values. Caching is typically done preemptively for Post delete operations.

  The default for scripts is Full. For methods, the framework verifies all the parameters mapped for the Post delete stored procedure and selects Full or Exists depending whether non-contextual attributes are present or not, respectively.

  Note: The LookUpLevel attribute is important to the handling of Post delete stored procedure operation bindings, as attribute values may need to be cached before the target object is deleted.

  • Full

    Specifies that all attribute values are cached. This is the default for scripts.

  • Exists

    Specifies that the Java Connector Server checks that the object being deleted exists. If the object does not exist, the Java Connector Server throws an LdapNameNotFoundException.

  • None

    Specifies that the method or scripting payload is responsible for determining whether the target object exists. If you select Full or Exits, the framework determines whether the target object exists automatically. This means that the Java Connector Server passes the call on, and that the script or stored procedure you call should determine if the object exists.

• Procedure

  Specifies the stored procedure you want to run before, instead of, or after a selected operation.

  • In / Out

    Indicates the type of parameter.

  • In

    Specifies that the parameter or type passes the value into the stored procedure.

  • InOut

    Specifies the stored procedure passes the value both in and out.

  • Out

    Specifies that the stored procedure passes out the value.

  • Parameter

    Specifies that the name of the parameter as specified in the store procedure's definition.

• Data Type

  Displays the SQL type for the named parameter.

• Attribute

  Specifies the attribute that maps to the parameter for the stored procedure.

  Note: The values in this list with asterisks on either side are runtime context values for the specified operation. For example, the Distinguished Name for the account targeted by an operation or operation-specific value such as the "new name" in a MODIFY RN rename operation. The remaining values are the attribute values you previously mapped for the specified class.

  • *Name*

    Defines the target object's most nested RDN value.

  • *DN*

    Defines the target object's full distinguished name.

  • *ErrorStatus*

    Specifies that the connector uses the attribute to pass a descriptive error string back from a stored procedure. This can cause failure if strict completion is true for the binding.

  • *AddModify_AttrsAsXML*

    Specifies that the entire Add or Modify operation is passed in as a single XML string.

  Note: This can be useful for stored procedures bound to ADD or MODIFY operations where the endpoint has good in-built XML support. The entire request can be passed in a single XML string that can then be broken down within the stored procedure, if desired.

  • *ModifyRn_NewRdn*

    Defines the new RDN.

  • *Move_NewParentName*

    Defines the new parent name.

  • *MoveRename_NewParentName*

    Defines the new parent name.

  • *MoveRename_NewRdn*

    Defines the new RDN.

  • *CLASS*

    Defines the name of the object type.

  • *OPERATION*

    Defines the name of the operation, for example, Add, Delete.

  • *ALIAS*

    Defines the alias for the script.

  Note: If you select more than one object class, only the union set of attributes for those object classes and the runtime attributes (such as *NAME*, *DN*) is available in this field.

• Multivalued

  Specifies that the parameter can have multiple values and needs a flattening style.

• Flattening Style

  Specifies a flattening method used to represent multiple values in a single string literal. If the attribute is multivalued, use the Flattening Style column.

• Flattening Mode

  Displays the flattening mode for multivalued parameters where changes can be expressed in terms of values ADDed or REMOVEd, or alternatively, by passing in the complete new list of values (REPLACE).