GitHubContribute in GitHub: Open doc issue|Edit online

LDIF Parser for file endpoint

Use the LDIF Parser to read and write data that is in the LDAP Data Interchange Format (LDIF). The LDIF format is used to specify a set of directory entries or a set of changes to be applied to directory entries, but not both. An LDIF file consists of a series of records that are separated by line separators.

To access the LDIF Parser configuration parameters:

  1. Add a File endpoint.
  2. On the File endpoint configuration page, click Parser and select LDIF Parser from the list.
  3. Expand the Parser section to view the parameters.

Parameters

DN Attribute Name
Specify the attribute name to use for an LDIF dn line. The default value is $dn.

Version Number
Select this check box to display a version attribute in the beginning of the output (required by RFC2849). This check box is selected by default.

Comment
Use this field to add your comments. The comment is not considered while parsing data.

Detailed Log
Select this check box to generate log messages with detailed debug information.

You can also configure the following advanced parameters. Under the

Parser section, expand

Advanced to view these parameters.

Binary Attributes
Specify a comma delimited list of attributes that must be treated by the parser as binary attributes.

Character Encoding
Specify the character encoding to use for reading or writing. The default value is UTF-8.

For more information, go to the IBM® Security Verify Directory Integrator documentation and search for Character Encoding conversion.

Note: A conforming LDIF file must always have Character Encoding set to UTF-8. Character Encoding is also applied for encoding or decoding BASE64 encoded strings. BASE64 encoding looks like garbled text if you do not know how to decode it.

Only Descriptive Records
Select this check box to write only descriptive records. An LDIF file might contain change records or descriptive records. A change record describes a change that is needed for an entry. It can be identified by a changetype line, which is the second line immediately after the dn line. A descriptive record describes an entry. A correct LDIF file contains either only change records or only descriptive records.

By default, this check box is not selected.

Support language tags
Select this box if you want the parser to support language tags. When information is represented in multiple languages, the server associates language tags with attribute values.

For detailed information about the LDIF Parser, go to the IBM® Security Verify Directory Integrator documentation and search for LDIF Parser.