File Import Field Mapping

In the Search text box, you can enter the search criteria, and when you type, the field names listed will shorten depending on the search criteria.

Fields

The Fields section contains field names that can be assigned as columns. After determining the format of the data and, in the case of a delimited file, specifying a separator and delimiter, you can assign the fields to the appropriate columns by dragging and dropping them or clicking the Add as Column button.

Note: If you have not entered the data for the required fields (Data Source; Network Path; Source File) on the Configuration tab before accessing the Field Mapping tab you will not see the Fields (field list) and the records. Instead, you will get the following message:

“You need to enter <list of missing fields> in the Configuration tab before the source file and mapping can be displayed”

Note: In the field list, it will list everything that was not filled out. The required fields are: Data Source, Network Path, and Source File.

On the left hand side of the screen are all of the fields that can be imported into the directory. To indicate which field name is matched to which field in the file, you can click and drag the field name to the correct column.

Delimited import file: when the file is delimited you can either drag fields over the columns or use the “Add as Column” button.

Fixed Length import file: If you choose the fixed length file you can drag the fields over the sample and then adjust the length of the column header to the correct size for the field. You can also use the “Add as Column” button.

Unless the option, Import People without objects is chosen (set in Configuration section), each record must have at least one of the following defined:

Next to some fields is a text box that allows a constant to be entered. This provides the following functionality (relates to both the Fields and Columns sections):

Multiple Fields

This multiple fields option will enable you to split one field into multiple fields. Also this field can be used on multiple columns.

When you add Multiple Fields as a column to the list in the Field Mapping tab, and click on the blue properties circle for that field, the following dialog box will be displayed:

Regex

Regular Expression Regex Overview

When importing records into your directory import database, you may need to separate one column into multiple fields. For example, you might have one long string of text (field) that contains a division name, department, cost center etc all combined into one. You may want to then extract certain segments of data and identify them as individual fields from that one large data field string. The process of splitting text into multiple fields is known as "parsing" and can be derived by creating a pattern known as "Regex" to extract the information.

A regular expression (Regex for short) is a specific pattern that provides concise and flexible means to "match" (specify and recognize) strings of text, such as particular characters, words, or patterns of characters.

A Regex pattern "engine" has the ability of processing or parsing of data from larger strings of data, or to extract multiple attributes (groups) out of a single field.

Full regular expressions are composed of the following types of characters:

Metacharacters

Metacharacters are special characters that have a unique meaning and are not used as literals in the search expression. These include the following:

Character	Description
\d	Backslash and d: Match any digit in the range 0 - 9
.	Period or dot: match any character
(...)	Opening and closing parenthesis: mapping (extraction of data) of a long string of text or expression into groups or a pattern, for the purpose of splitting one data field into multiple fields.
^	Caret: marks the start of the line or string of text being checked, e.g. "^data" matches a line with "data" at the beginning of the text.
$	Dollar sign: marks the end of the line of text or string being checked.
*	Asterisk: matches 0 or more of previous expression.
?	Question mark: 0 or 1 of previous expression; also forces minimal matching when an expression might match several strings within a search string.

Literal characters

These are normal text characters: for example, letters a through z.

Directory Import Regex Queries

The information described above in conjunction with the following examples will help you to generate a Regex pattern in the directory import, field mapping sections for the purpose of extracting multiple attributes (groups) out of a single field, (applicable to all three import types: LDAP, text and Cisco).

Example 1

LDAP:

When you add "Multiple Fields" as a column to the list in the Field Mapping tab, and click on the properties circle, the following dialog box will be displayed:

Note: In the configuration tab there is a "Construct LDAP Query/LDAP Worksheet" section which contains the following data example for the "LDAP Records":

The distinguished name contains department, cost center, and division names:
CN=Brad Smith, OU=Accounts Payable, OU=Accounting, OU=Finance, DC=net, DC=ads, DC=state
CN=Cindy Clay, OU=Inside Sales, OU=Sales, OU=Sales & Marketing, DC=net, DC=ads, DC=state
CN=Sam Mayfield, OU=Software Engineering, OU=Engineering, OU=Development, DC=net, DC=ads, DC=state

In the Pattern query box you need to enter the regex pattern that will be used to split the field into multiple fields. For this example the pattern would be:

^CN=.*,OU=(.*?), OU=(.*?), OU=(.*?), DC=

Note: Using the regex pattern definitions described above, the pattern can be explained as follows:

1. - ^CN means the string need to start with CN and you don’t want anything until you come to the first OU.
  - The first group to be extracted are all of the characters and numbers between OU= and the comma.
  - The next group to be extracted are of the characters and numbers between the next OU= and the comma.
  - The final group to be extracted are of the characters and numbers between the next OU= and the comma.
  - Nothing after the first DC= is to be extracted.

Once the pattern is checked you will get the following drop boxes (dependent on the pattern query):

Note: You then have to make a choice for each group from the drop down menu, e.g. department name, full name, extension (as shown in the following screen). The OK button is not available until all fields have been assigned.

Example 2

Text

The extension and report as extension are in the same field separated by a dash

5053-6307065053
5045-6307065045
5040-6307065040

In the Pattern query box you can enter the regex pattern used to split the field into multiple fields. For this example the pattern would be:

^(\d*?)-(\d*?)$

Note: Using the regex pattern definitions described above, the pattern can be explained as follows:

1. - The first group to be extracted will be all of the digits before the dash.
  - The second group to be extracted will be all of the digits after the dash.

Note: If you require additional assistance regarding regex please contact Support at http://www.isi-info.com/support/support-overview.

Example 3

Using the email address for the email address and import key:

When you want to utilize the same field within a directory import multiple times you can do so by performing the following process:

In the Pattern query box you need to enter the expression ^((.*))$.

Note: Using the regex pattern definitions described above, the pattern can be explained as follows:

Two parenthesis are used and since you told it to use everything, it gives you twice ^((.*))$

Once the pattern is checked you will get the following drop boxes (dependent on the pattern query):

Note: You can then map the same information twice. If you needed to map the same field three times you would just use an extra set of parenthesis, (no quotes around the Regex string).

Note: The Column Number provides a number for the column which contains this specified field.

Fields List

The fields list provides information pertaining to the fields available and their default names.

- The fields are displayed in alphabetical order, with the exception of ‘None’ being the first option.
- If a field has been renamed, it displays its new name, not the default name.

Field Name	Format (max char.)	Rules/Comment	Constant Allowed
None		Can be used for multiple columns
Alternate	Text (50)	Can be renamed in Configure Directory.	X
Authorization Code	Text (20)
Billing Class	Numeric		X
Billing Rate per Hour	Numeric	This field is available only when the optional Profession Services Package (PSP) has been purchased and Enhanced PSP is activated.	X
Company Code	Text (20)	Can be renamed in system setup	X
Company Name	"Combo" box. Click for more information. The "combo" box consists of the following list options: If the list contains 25 items or less, you can choose a constant from a drop down box. If there are more than 25 organizations in a level, you will get a pop-up box, , with a search option for you to choose a single value. You can also type in a value that is not in the directory. This will create a new organization where ever that constant is used. Note: The default option is set to unassigned.	Can be renamed in system setup	X
Cost Center Code	Text (20)	Can be renamed in system setup	X
Cost Center Name	"Combo" box. Click for more information. The "combo" box consists of the following list options: If the list contains 25 items or less, you can choose a constant from a drop down box. If there are more than 25 organizations in a level, you will get a pop-up box, , with a search option for you to choose a single value. You can also type in a value that is not in the directory. This will create a new organization where ever that constant is used. Note: The default option is set to unassigned.	Can be renamed in system setup	X
Data Number	Text (26)	Can be renamed in Configure Directory.	X
Department Code	Text (20)	Can be renamed in system setup	X
Department Name	"Combo" box. Click for more information. The "combo" box consists of the following list options: If the list contains 25 items or less, you can choose a constant from a drop down box. If there are more than 25 organizations in a level, you will get a pop-up box, , with a search option for you to choose a single value. You can also type in a value that is not in the directory. This will create a new organization where ever that constant is used. Note: The default option is set to unassigned.	Can be renamed in system setup	X
Device	Text (100)	This field may be used more than once. That is you can import more than one device for a person. They all must be in the same data source.
DID #	Text (26)	Can be renamed in Configure Directory.	X
Division Code	Text (20)	Can be renamed in system setup	X
Division Name	"Combo" box. Click for more information. The "combo" box consists of the following list options: If the list contains 25 items or less, you can choose a constant from a drop down box. If there are more than 25 organizations in a level, you will get a pop-up box, , with a search option for you to choose a single value. You can also type in a value that is not in the directory. This will create a new organization where ever that constant is used. Note: The default option is set to unassigned.	Can be renamed in system setup	X
E-mail	Text (80)
Extension	Text (512)	This field may be used more than once. That is you can import more than one extension for a person. They all must be in the same data source.
Extension Location	Text (255)	If the value in the record does not match the name of an extension location for the data source being imported, still import the extension but leave the extension location field blank. Log the error. If there are multiple extensions and Extension Locations entries, they will be paired up as found, i.e. the 1st extension is paired with the first Extension Location found.
Report As Extension	Text (15)	You can use Report as Extension more than once. If there are multiple extensions and Report As Extension entries, they will be paired up as found, i.e. the 1st extension is paired with the first Report as found. For example if there are 3 extensions and 2 Report as Extension columns, the first 2 are paired and the 3rd extension does not have a Report As Extension.
External Code	Text (20)		X
Facility	Text (25)	If the value in the record does not match the name of a facility in the data source being imported, skip importing the facility as an object. If other objects are defined for the person, such as an extension or auth code, import those objects. Log the error.
Fax Number	Text (26)	Can be renamed in Configure Directory.	X
First Name	Text (20)	If Full Name has already been chosen, First Name cannot be chosen.
Full Name	Text (52)	Options for this allows the user to indicate the format of the full name: <firstname> <lastname> or <lastname>, <firstname>. Note: If Last Name and/or First Name has been chosen, this field cannot be used.
Home Number	Text (26)	Can be renamed in Configure Directory.	X
Home Site	Numeric	If the number does not match a data source, import the person but log the fact that the home site could not be imported.	X
Import Key	Text (50)	If an import key matches an existing entry in the directory, the information in the record will update the existing entry instead of creating a new entry. This can update the person’s name as well as all other fields in the person’s entry.
Last Name	Text (25)	NOTE: If Full Name has been chosen, this field cannot be used.
Line Type	Drop down list. Click for more information. When you click on the Line Type drop down menu, you can choose from the values as shown in the following screen:	This will only apply to an extension. You can use Line Type more than once. It will be paired with the extensions as found, e.g. the first line type matches up with the first extension. If Line Type is used more often than Extension, ignore the extras. Default the Line Type to Station. If the line type in the record does not match one in the line type table, use Station instead. Log the error.	X
Location Info	Text (255)		X
Login Domain		Note: A constant is available for this field but it only appears if you choose NT Authentication for the User ID. If the User IDs do not contain the domain name then the domain field is required.	X
Mobile Number	Text (26)	Can be renamed in Configure Directory.	X
Module Access		Only one Module Access per record is allowed. If the Module Access is in a field and the value is not recognized, security information for the person is not imported. Log that the person’s security could not be imported because no valid Module Access was available. If they have other items, such as extensions or devices, import that information. Note: There is a drop list populated by the list of User Types for modules in Administration/Directory. It also includes “All” which gives you access to all of the Summary gates. Note: This field is only available when "Allow access to security info fields" is ON (checked) in Directory Import section of Configure Directory. The field is hidden if the option is unchecked (default) .	X
Organizational Access	Drop down list Click for more information. When you click on the drop down menu, you can choose from the following values . Self – This the default option. Department – This will give you access to the department to which you belong. Cost Center – This will give you access to the cost center to which you belong. Division – This will give you access to the division to which you belong. Company – This will give you access to the company to which you belong. All – This will give you access to the entire organization.	Only one Organizational Access per record is allowed. Note: This field is only available when "Allow access to security info fields" is ON (checked) in Directory Import section of Configure Directory. The field is hidden if the option is unchecked (default) .	X
Pager Number	Text (26)	Can be renamed in Configure Directory.	X
Password	Text (50)	Only one password per record is allowed. It is possible to import a person with a user ID and no password. In this case, log that the user ID was entered into Select but no corresponding SQL user was created. Note: This field is only available when "Allow access to security info fields" is ON (checked) in Directory Import section of Configure Directory. The field is hidden if the option is unchecked (default) .	X
Room #	Text (10)	Only shows if Hospitality is ON.
Summary Gate Access		Only one Summary Gate Access per record is allowed. If a column is being used to assign Summary Gate Access, the user type is not recognized, and no default was set, import the person without Summary Gate Access but log the unrecognized user type. Note: There is a drop list populated by the list of User Types for summary gates in Administration/Directory. It also includes the choice "All Summary gates". Note: This field is only available when "Allow access to security info fields" is ON (checked) in Directory Import section of Configure Directory. The field is hidden if the option is unchecked (default) .	X
Title	Text (26)	Can be renamed in Configure Directory.	X
User Defined 1	Text (26)	Can be renamed in Configure Directory.	X
User Defined 2	Text (26)	Can be renamed in Configure Directory.	X
User ID	Text (128)	Only one User ID per record is allowed. Note: This field is only available when "Allow access to security info fields" is ON (checked) in Directory Import section of Configure Directory. The field is hidden if the option is unchecked (default) .

Field Options

The field options provide various field settings for delimited and fixed length records:

All fields have options that can be set by clicking on the blue circle (reference the Field Mapping screen as shown above). A solid orange circle indicates that the default options for a field have been changed.

The following screens represent the various field settings and options available for delimited and fixed length records:

a) Generic Field Options – Delimited

b) Extensions and Reports as Extension Field Options - Delimited

c) Full Name Field Options – Delimited

d) Generic Field Options – Fixed Length

e) Extension Options – Fixed Length

f) Full Name Options – Fixed Length

g) User ID Options – Delimited

h) Login Domain Options – Delimited

Generic Field Options - Delimited

- Column Number: This provides a number for the column that contains a selected field.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Column must be blank: This option is used to filter out any records not required.

Note: Default is unchecked.

Extension and Report As Extension Field Options - Delimited

- Column Number: This is the column number in which the field option appears.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.

Note: Default is unchecked.

- Strip non-numeric values: This option strips everything except numbers from the entry in the field.

Note: Default is unchecked.

- Accept only right most <n> characters. Zero or blank allows all characters – By default this is unchecked. If it is checked a value must be entered. It will allow you to trim a value to the correct number of characters. E.g. 8477065053 could be trimmed to 5053.

Full Name Field Options – Delimited

- Column Number: This is the column number in which the field option appears.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.

Note: Default is unchecked.

- Full Name format is always Last Name, First Name: If this option is not chosen (unchecked) the system will use everything before the first space as the first name and everything after the first space as the last name, e.g. John Doe will interpret John as the first name and Doe as the last name. When the box is checked it will interpret everything before the comma as last name and everything after the comma as first name, e.g. Doe, John will interpret Doe as the last name and John as the first name.

Generic Field Options - Fixed Length

- Start Position: This provides a starting point for the selected field.
- Length: This is for reference only. It is actually controlled by where the next field is positioned.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Column must be blank: This option is used to filter out any records not required.

Note: Default is unchecked.

Extension Options - Fixed Length

- Start Position: This provides a starting point for the selected field
- Length: This is for reference only. It is actually controlled by where the next field is positioned.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.

Note: Default is unchecked.

- Strip non-numeric values: This option strips everything except numbers from the entry in the field.

Note: Default is unchecked.

- Accept only right most <n> characters. Zero or blank allows all characters – By default this is unchecked. If it is checked a value must be entered. It will allow you to trim a value to the correct number of characters. E.g. 8477065053 could be trimmed to 5053.

Full Name Options - Fixed Length

- Start Position: This provides a starting point for the selected field
- Length: This is for reference only. It is actually controlled by where the next field is positioned.
- Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
- Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.

Note: Default is blank.

- Must be Numeric Only: This option is most often used to exclude a header row from being imported.

Note: Default is unchecked.

- Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.

Note: Default is unchecked.

- Full Name format is always Last Name, First Name: If this option is not chosen (unchecked) the system will use everything before the first space as the first name and everything after the first space as the last name, e.g. John Doe will interpret John as the first name and Doe as the last name. When the box is checked it will interpret everything before the comma as last name and everything after the comma as first name, e.g. Doe, John will interpret Doe as the last name and John as the first name.
User ID Options – Delimited
1. - Column Number: This is the column number in which the field option appears.
  - Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
  - Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.
Note: Default is blank.
Note: The Login Domain is a required field when using NT Authentication.

Note: The domain name may be in the field, e.g. domain\login
1. - Must be Numeric Only: This option is most often used to exclude a header row from being imported.
Note: Default is unchecked.
1. - Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.
Note: Default is unchecked.

Login Domain Options – Delimited

Note: The Login Domain field has a constant so that it can be defaulted.
1. - Column Number: This is the column number in which the field option appears.
1. - Min. Data Length: The default value is 0. By entering another value, the content of the field in that record must be at least that long for the record to be imported.
  - Filter Value: The value of the field in that record must match the value entered here for the record to be imported. Wildcards * and ? are supported.
Note: Default is blank.
1. - Must be Numeric Only: This option is most often used to exclude a header row from being imported.
Note: Default is unchecked.
1. - Strip non-Alphanumeric values: This option strips non-numbers and non-letters from the entry in the field.
Note: Default is unchecked.

Define Import File

Search

Fields

Multiple Fields

Regex

Regular Expression Regex Overview

Metacharacters

Literal characters

Directory Import Regex Queries

Example 1

Example 2

Example 3

Fields List

Field Options

Generic Field Options - Delimited

Extension and Report As Extension Field Options - Delimited

Full Name Field Options – Delimited

Generic Field Options - Fixed Length

Extension Options - Fixed Length

Full Name Options - Fixed Length

User ID Options – Delimited

Login Domain Options – Delimited

Columns