Skip to main content

Create names with a NIM name generator

Names tab

Build one or more outputs from filter columns. Each output can use ordered methods, parts, conversions, and iterations to form the value a mapping needs.

At a glanceDirect link to At a glance

On the Names tab, choose a source filter, add an output in Names, and assemble its method from Parts. The Results pane previews values from the selected records before you save. Once the output looks right, use it in a mapping. Add a uniqueness check if the target value must avoid existing values, or combine multiple outputs under Multi-value names.

Part of the screenWhat it controls
ColumnsSource values available from the selected filter.
NamesNamed outputs, such as username or mail.
Methods and PartsOrdered candidate patterns and the source or literal text that forms each pattern.
ConversionChanges to one selected part, such as case, spacing, or length.
IterationAdditional candidates when the configured method needs them.
ResultsA preview of generated values for source records.

For example, a method can shorten Aaron to a, lowercase Bailey to bailey, and join the parts as abailey. Check the format and source data in Results before using the name in a target system.

Create a name generatorDirect link to Create a name generator

Choose the source filterDirect link to Choose the source filter

  1. Go to Processing > Name Generation and select Add.
  2. Enter a descriptive Generator Name and select Create.
  3. Select the Filter that returns the attributes needed to build the value. Its available columns appear in the Columns pane.

Step 1 of 3

Restrict a method by conditionDirect link to Restrict a method by condition

Use conditions when different groups of people need different name formats—for example, a department-specific username rule.

Choose a source column whose values are reliable for every group you intend to handle. Preview at least one record for each condition and one that should match no condition, so an unexpected blank or alternative value is visible before the generator is used in a mapping.

Enable condition-based methodsDirect link to Enable condition-based methods

  1. Edit the name generator.
  2. Select Use Condition Based On.
  3. Select the source attribute that decides which method applies, such as organizational_unit.

Step 1 of 3

Edit or remove a name generatorDirect link to Edit or remove a name generator

  1. Go to Processing > Name Generation.
  2. Select Edit Name Generator to update its filter, names, methods, or rules; use the relevant section above as a guide.
  3. Select Remove Name Generator and confirm to delete one that is no longer required.

caution

Before removing a generator, check mappings that may still use its outputs.

If you change the selected filter, review the generator's parts and preview again: available columns and their values depend on that filter.

Copy or rename a name generatorDirect link to Copy or rename a name generator

To copy a generator, select Copy Object next to it in Processing > Name Generation. NIM creates a copy with a numbered suffix, such as _01.

To rename one, select Rename Object, enter the new name, and press Enter to confirm.

Conversion referenceDirect link to Conversion reference

Conversions transform one method part at a time. Apply them in the order needed, then use the Results pane to verify real source values.

Common patterns include lowercasing a username, removing diacritical marks for a target that does not accept them, and limiting a value to a target field's maximum length. The tables below list the available conversion types; the target system's rules determine which ones you need.

Add text and spacingDirect link to Add text and spacing

ConversionArgumentsResult
Add at beginTextAdds text to the beginning.
Add at begin if not emptyTextAdds text only when the part has a value.
Add at endTextAdds text to the end.
Add at end if emptyTextAdds text only when the part is empty.
Add at end if not emptyTextAdds text only when the part has a value.
Add at end if not foundText; search textAdds text only when the search text is absent.
Add blank at begin/end—Adds one space at the beginning or end.
Add blank at begin/end if not empty—Adds one space only when the part has a value.
Add char until length reachedText; minimum lengthRepeats text at the end until the part reaches the length.
Conversion: start with text / end with textTextAdds text at the beginning or end.
Insert after every characterTextInserts text after each character.

Change casing and charactersDirect link to Change casing and characters

ConversionArgumentsResult
Case conversion: convert to lower case / upper case—Changes the entire part's case.
Case conversion: convert first/last N chars to lower caseCharacter countChanges only the selected leading or trailing characters.
Case conversion: convert first/last N chars to upper caseCharacter countChanges only the selected leading or trailing characters.
Case conversion: 1st upper, other unchanged—Uppercases the first character only.
Case conversion: 1st upper, other characters lower case—Formats the part as title case.
Conversion remove diacritical marks—Replaces accented characters, such as é with e.
Conversion: reverse all characters—Reverses the character order.
Replace argument1 by argument2Find characters; replacementReplaces matching characters, case-insensitively.
Replace substring if ends with substring (case insensitive)Ending text; replacementReplaces an ending, useful for email domains.

Remove and retain textDirect link to Remove and retain text

ConversionArgumentsResult
Delete: all blank characters—Removes all whitespace.
Delete: all non blank characters—Keeps only whitespace.
Delete all matching charactersCharactersRemoves every matching character, case-insensitively.
Delete all but the matching charactersCharactersKeeps only the supplied characters.
Delete all matching UTF-8 charactersComma-separated hex codesRemoves characters with those codes.
Delete all but the matching UTF-8 charactersComma-separated hex codesKeeps only characters with those codes.
Delete first/last N charactersCharacter countRemoves leading or trailing characters.
Delete substringTextRemoves matching text, case-insensitively.
Delete substring (case sensitive)TextRemoves an exact-case matching substring.
Delete leading/trailing blank characters—Trims whitespace from the beginning or end.

Shorten a valueDirect link to Shorten a value

ConversionArgumentsResult
Shorten: use first character—Keeps the first character.
Shorten: use first character of each part—Keeps initials from dash- or space-separated parts.
Shorten: convert to first/last N charactersCharacter countKeeps a specified leading or trailing length.
Shorten: remove after first/last matching characterCharacterKeeps the value through that character.
Shorten: remove before first/last matching characterCharacterKeeps the value from that character onward.
Shorten: remove after matching text (case insensitive/case sensitive)TextKeeps the value through the first matching text.
Shorten: remove before matching text (case insensitive/case sensitive)TextKeeps the value from the first matching text onward.
Shorten: limit total name lengthMaximum lengthTruncates the generated name at the configured total length.
Shorten: limit total name length (remove characters only)Maximum lengthLimits length without truncating numeric values.
tip

For total-length limits, apply the conversion to the last relevant method part and before a part that contains an iteration.