TABLE OF CONTENTS

• Introduction
• Import Status
• Import #1 #2 #3
  • Field Mapping 
  • Find / Replace
  • Post Processor Script
  • Pre / Post Processor Script
• Further Support

Introduction

A new suite of generic importers was introduced in v15, enabling data imports from various sources such as Excel files, SQL databases, and REST APIs. The common features shared by these importers are outlined below, while functionality specific to individual importers is documented on their respective help pages. 

• REST API
• SQL DBs
• Static Files

Import Status

The table below provides information on the elements within this panel. This panel is common within all the importers.

Import #1 #2 #3

Field Mapping 

The Field Mapping table describes the relationship between the incoming data and ManagementStudio. 

• MCH
  • Stands for Match On
  • When this is ticked, ManagementStudio will try to find an existing item that meets this criteria and update that item
  • Example: AppVendor, AppName, AppVersion or SamAccount, Domain
• Src. Field 
  • The column name from the incoming data 
• MS Field 
  • The field name in ManagementStudio to insert/update the data. 
  • Supports Name, Custom Field Id, Custom FieldPath, Special fields
  • Exmaples
    • AppName, AppVenor, AppVersion etc
    • 12324  (Saves data to Custom Field Id 1234)
    • APPDSC\General\My Text (Saves data to Custom Field Path)
    • BlueprintId / BlueprintPath
    • AppStatus (Accepted, Pending, Rejected, Rationalised)
    • 
      
• Options
  • Additional options that can be used change how data is imported
  • Static
    • The Static option takes the literal value in the Src. Field and updates in the MS Field but does not read this value from the import data. 
    • A typical use case
      • Setting a Process e.g.  Src : '2. Imported' MS: 'Process' Opt: 'Static'
      • Setting a import date e.g  Src : '[Today]' MS: 'CustomDate1' Opt: 'Static'

Find / Replace

The imported data can be post-processed before being handed over to ManagementStudio for import. The Find / Replace table allows you to perform some light data cleaning and supports some built-in functions. 

• Src. Field
  • The column name from the incoming data
• Find
  • The value to find in the data
• Replace
  • The value to replace found matches with
• Func
  • Built-in functions to perform advanced operations on the imported data
  • Regex-FullReplace
    • Look for any occurrence of the Find and replace the whole import value with the Replace
    • e.g. Find 'AMD' replace 'AMD'  :: 'AMD Ryzen 3 7330U' -> 'AMD'
  • Regex-PartialReplace
    • Look for any occurrence of the Find and replace the specific found value with the Replace
    • e.g. Find '7330U ' replace ''  ::  'AMD Ryzen 3 7330U' -> 'AMD Ryzen 3'
  • Convert-BitPackedNumberToVersion
    • Takes a bit-packed number usually found in Parquet files and transforms it into a version 
    • e.g. Convert '6755446685696070' -> 20.3.1.4
  • Convert-Int96DateToDateTime
    • Takes an Int96 formatted Date found in Parquet files and transforms it into a standard date
    • e.g. Convert 'D34A940000001C0E00258CD5' -> 2025-08-07 22:31:11

Post Processor Script

A custom script that can be run on the data retrieved from the File, SQL, or REST API source, but before it is passed through to the importer. 

Pre / Post Processor Script

$ScriptArgs.EventArg1: Name of the import block that called this code. 

e.g. Import1-PreProcess, Import1-PostProcess, Import2-PreProcess, Import2-PostProcess etc

$blockName = $ScriptArgs.EventArg1 

$ScriptArgs.EventArg2: A comma-delimited list of files to process

$files = $ScriptArgs.EventArg2.Split(",",[System.StringSplitOptions]::RemoveEmptyEntries)

Returning an Error will end the current import block, but 

New-MSApiResult -Header "No files found to process" -Status Error

Returning an Exception will end the current import block and end all subsequent import blocks

New-MSApiResult -Header "No files found to process" -Status Exception

Example Script

## Importer Processing Scripts

# EventArg1: Name of the import block that called this code. 
# e.g. Import1-PreProcess
$blockName = $ScriptArgs.EventArg1 

# EventArg2: A comma-delimited list of files  to process
$files = $ScriptArgs.EventArg2.Split(",",[System.StringSplitOptions]::RemoveEmptyEntries)


## Example 1. Exit importer if there are no files to import
if($files.count -eq 0)
{
    New-MSApiResult -Header "No files found to process" -Status Exception
    return
}

## Example 2. Skip import if the number of rows to import < 3
foreach($file in $files)
{
    $lineCount = (Get-Content $file | Measure-Object -Line).Lines
    if($lineCount -lt 3){
        New-MSApiResult -Header "Bad import file, not enough data rows" -Status Error
    }
}

Further Support

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