This article covers the features that are unique to the File Importer. For features common to all importers, please see this article.

TABLE OF CONTENTS

• Introduction
• Key Features of the File Importer
• Example Use Case: Importing Employee Records from a CSV or Excel File
  • Scenario
  • Step-by-Step Walkthrough
    • 1. Prepare the Excel File
    • 2. Accessing the File Importer
    • 3. Configuring the Import
    • 4. Run or Schedule the Import
• Further Support

Introduction

In today’s data driven world, information often needs to be moved between systems, formats or platforms. Whether it’s uploading CSV into excel, or syncing data into Managementstudio, this task is usually handled by a file importer. File importers are essential for enabling interoperability between systems, reducing manual data entry and speeding up data processing. 

Key Features of the File Importer

• Pre-Process Data Script: Run a script before reading the import file. This is useful for preparing or placing files in the correct location.

• Post-Processor Script: Execute scripts after import to finalise or transform data
  
• File/Folder/URL Input: Specify the source of your data. The location must be accessible from the ManagementStudio server.
• Field Mapping: Align imported data fields with ManagementStudio’s internal schema to ensure accuracy.
• Find/Replace Functions: Clean or adjust data during import..
• Scheduling: Automate imports by setting specific times for the File Importer to run.

Example Use Case: Importing Employee Records from a CSV or Excel File

Scenario

Imagine your HR department maintains employee records in an excel file exported from a payroll system. You want these records imported into ManagementStudio so they can be linked to project assignments or migration tasks.

Step-by-Step Walkthrough

1. Prepare the Excel File

• Ensure the file contains consistent headers (e.g,Employee ID, Department, Email etc).
• Save the file in a location accessible to the ManagementStudio server (e.g., a shared folder).
• Ensure the target fields in Managementstudio have been created to hold the imported data.
• Test with a small sample file first.

2. Accessing the File Importer

• Go to Administration->Extensions->Connectors (1)
• Click on Add New Connector (2) and select File Importer from the list

• Add a Name and click OK
• You'll see options for input source, field mappings and scripts

3. Configuring the Import

• Under Import #1 select the ManagementStudio module (1) you want to create or update.
• Ensure Create New Module Items and Update Existing Module Items are ticked.
• Enter the Pre-processing/Post-processing ScriptId (2) if required (optional).
• Choose the input source, by specifying the file, folder or URL (3) depending on where the data is stored. Example: E:\Uploads\WorkDayData1.xlsx
• Specify the excel worksheet names (4).
• Set the Adv. Options toggle switch to Show.

• Under Field Mapping link the Excel fields with ManagementStudio's fields (1).
  
  • Src Field column is the header text in Excel.
  • MS Field column is the target in ManagementStudio.
  • Paths can be used for Custom Fields. E.g. UMCT1\Work Day Info\Department
  • For more information on field mapping, please refer to this article.
• The imported data can be post-processed before being handed over to ManagementStudio for import. The Find/Replace (2) table allows you to perform some light data cleaning. Please refer to this article for more information.

• The Test Retrieval button (3) allows you to run the data retrieval portion of the connector and preview the results. This does not import the data.
• The Test Import button (4) allows you to run the data retrieval and import portion of the connector in preview mode. This does not import the data.
• Click Save Changes located at the top.

4. Run or Schedule the Import

• Click File Import (1) for immediate execution of the import.
• Verify that employees now appear with the information from the excel file within the User migrations module.
• Set a Schedule (2) for recurring imports (e.g., daily 8PM). Please refer to this article for more information on creating a recurring Schedule.

Further Support

If you require further support, please visit ManagementStudio's Service Desk to search the knowledge base or create a new support ticket.