Bulk import map examples
Mapping your source employee documents to required elements in Employee Document Management is crucial for a successful bulk import.
This topic provides examples on how to map your source employee documents to the required elements in Employee Document Management. The values provided are examples designed to guide you through the import map configuration.
Map fields and values directly from existing file names
Using your existing employee document file names is recommended when your source employee documents reside in a local repository.
For example, an employee document can have all the meta data in the file name Abel_Tuter_tuition.pdf to map to Employee Document Management.
Note: When using regular expressions (RegEx) to define the replacement value, use a regular expression test site to ensure correct parsing.
File name example
The example file name is abel_tuter_tuition.pdf.
To find and extract the file name from the source repository, see this example:
Import Map — File name
The import map is looking for a source element called fileName.
The import map is going to translate this source element to a mapped element called fileName.
The Regex is looking for the format of the file name first\_last\_xxx.pdf.
File name to employee name example
From the file name, the employee name is extracted. Employee name is a requirement for Employee Document Management.
Import Map — Employee Name
The import map is looking for a source element called fileName.
The import map is going to translate this source element to a mapped element called employee.
The Regex is looking for the format of the file name to be first\_last\_tuition.pdf \(\\w+\)\_\(\\w+\)\_\(\\w+\).\(\\w+\).
It replaces the original file name with first.last \($1.$2\)
File name to document type example
From the file name, the document type is extracted. Document type is a requirement for Employee Document Management.
Import Map — docType
The import map is looking for a source element called fileName.
The import map is going to translate this source element to a mapped element called docType.
The Regex is looking for the format of the file name to be first\_last\_tuition.pdf \(\\w+\)\_\(\\w+\)\_\(\\w+\).\(\\w+\).
It creates a docType of tuition \($3\).
**Note:** Having the source employee documents in a central repository, simple directory structure, and consistent file naming convention are highly recommended and reduces errors.
Parse and map fields and values from a JSON output
Using a JSON output is recommended when your source employee documents reside in a third-party, cloud-based repository.
| Field | Description |
|---|---|
| Mapping type | Field |
| Mapped element | itemsLooks for the items mapping element in an array of items in the folder. This mapping is used after Stage — Directory import source. |
| Source element | entriesSource element in the JSON output and represents the items in a folder. For example, Box uses entries as the source element. |
JSON — entries
| Field | Description |
|---|---|
| Mapping type | Field |
| Mapped element | itemLooks for item, an entry in an array of items in the folder. This mapping is used after Stage — Directory import source to run operations against a single item. |
| Source element | idFor each item in the array, find the file ID in the JSON output. |
| Filter regex | fileCombined with the Filter field to exclude subfolders. |
| Filter field | typeFilter output to where the type field is equal to file to exclude subfolders. |
JSON — item
| Field | Description |
|---|---|
| Mapping type | Field |
| Regex | \(\\w+\)\\s\(\\w+\)String translation to convert fname lname to fname.lname. |
| Replace | $1.$2Converts files found in Regex field fname lname to fname.lname. |
| Mapped element | employeeLooks for employee mapping element. Employee is a field in the file item. This mapping is used after Stage — file import source. |
| Source element | owned\_by.nameLooks for name in owned\_by object. Bypass nested objects with a dot notation. |
| Filter regex |
JSON — Owned by and Name
| Field | Description |
|---|---|
| Mapping type | ValueSelecting Value maps the employee element within an array of information from your source document to a specific value in Employee Document Management. |
| Replace | david.looThe value you want to replace the source element with in Employee Document Management. Employee Document Management requires employee names to be formatted fname.lname. |
| Mapped element | employeeLooks for the employee mapping element that is a field in the file item. This mapping is used after Stage — file import source. |
| Source element | davidlLooks for the source value of davidl. |
This example illustrates how to use Value mapping to take an employee name from your source document and map it to the format that Employee Document Management requires.
| Field | Description |
|---|---|
| Mapping type | Field |
| Mapped element | docTypeLooks for the docType mapping element embedded in the description field in the file item. This mapping is used after Stage — file import source. |
| Source element | descriptionLooks for name in description. |
| Filter regex |
JSON — description
| Field | Description |
|---|---|
| Mapping type | ValueUse Value to map a specific value in your third-party, cloud-based repository to a value in Employee Document Management. |
| Replace | employee verificationsReplace verification \(source\) with employee verifications \(Employee Document Management\). |
| Mapped element | docTypeLooks for the docType mapping element embedded in the description field in the file item. This mapping is used after Stage — file import source. |
| Source element | verificationLook for the name value of verification in the JSON. |
| Field | Description |
|---|---|
| Mapping type | ValueUse Value to map a specific value in your third-party, cloud-based repository to a value in Employee Document Management. |
| Replace | transcriptsReplace school \(source\) with transcripts \(Employee Document Management\). |
| Mapped element | docTypeLooks for the docType mapping element embedded in the description field in the file item. This mapping is used after the Stage — file import source. |
| Source element | schoolLooks for the name value school. |
| Field | Description |
|---|---|
| Mapping type | field |
| Mapped element | fileNameLooks for the fileName mapping element embedded in the name field in the file item. This mapping is used after Stage — file import source. |
| Source element | nameLooks for filename in the description in the JSON output. |
| Filter regex |
JSON — Name
| Field | Description |
|---|---|
| Mapping type | field |
| Mapped element | urlLooks for the url mapping element embedded in the id field in the file item. This mapping is used after Stage — file import source. |
| Source element | Looks for id in JSON output. Note: some third-party, cloud-based repositories use the file ID. The capture import source builds a URL from this value. |
JSON — id
Bulk import mapping records
An example of Employee Document Import Map.
Import map
When a connection to your source repository is confirmed and import maps are set up correctly, you can click Start staging job from Related Links.
Parent Topic:Employee document management bulk imports