HaloITSM

File Upload

Export installed software across assets from the HaloITSM Configuration Management Database (CMDB) or the Halo API, as a CSV with the columns the SIM template needs.

HaloITSM maintains configuration and software data within its CMDB (Configuration Management Database) and related asset records. Relevant data can be accessed via:

Assets (Configuration Items), Device records including hardware and associated software.
Software Records, Catalog of installed applications, versions, and vendors.
Halo REST API, For automated exports from the CMDB or Software modules.

Prerequisites

For console (UI) method

Administrative access to HaloITSM with permissions to view and export Assets and Software records.
Ensure the CMDB is populated and synchronized with all relevant endpoints.
Access to Reports or Views with export capability (CSV or Excel).

For API method

API access enabled in HaloITSM (under Configuration → Integrations → API).
API Key or Bearer Token with read access to:
- /api/Assets
- /api/Software
Network access to your HaloITSM instance (e.g. https://yourcompany.haloitsm.com/api/).
A PowerShell or curl environment for running API queries.

Recommended Query or Method

Two standard methods are available for data extraction.

Export methods

Option 1: HaloITSM console export (UI)

This method is best for quick, manual exports.

Log in to your HaloITSM portal.
Navigate to Configuration → Assets → Software.
Use filters to include all active devices or relevant software categories.
Click Export → CSV (or Export → Excel, then convert to CSV).
Include the following fields in your export:

Asset Name (device name or hostname)
Software Name
Version
Vendor / Publisher

Save the file as HaloITSM_SIM_Export.csv.

Tip: You can also create a custom View or Report under Reports → New Report to define and reuse this export structure.

Option 2: HaloITSM REST API (recommended for automation)

Use the Halo API for automated or scheduled exports.

Step 1: Generate API key

Go to Configuration → Integrations → API → API Keys.
Create a new key with Read permissions for Assets and Software endpoints.
Note your API Base URL (e.g., https://yourcompany.haloitsm.com/api/).

Step 2: Execute the API query

PowerShell Script

# HaloITSM SIM Template Export Script
# Requires API Key with read access to Assets and Software modules

$BaseUrl = "https://yourcompany.haloitsm.com/api"
$ApiKey  = "YOUR_API_KEY"
$ExportPath = "C:\Exports\HaloITSM_SIM_Export.csv"

$Headers = @{
    "accept"       = "application/json"
    "Authorization" = "Bearer $ApiKey"
}

# Retrieve all assets
$Assets = Invoke-RestMethod -Uri "$BaseUrl/Assets" -Headers $Headers -Method Get

$ExportData = @()

foreach ($Asset in $Assets) {
    # Retrieve software linked to each asset
    $SoftwareList = Invoke-RestMethod -Uri "$BaseUrl/Software?assetId=$($Asset.id)" -Headers $Headers -Method Get
    foreach ($Software in $SoftwareList) {
        $ExportData += [PSCustomObject]@{
            "Device Name"        = $Asset.name
            "Software Name"      = $Software.name
            "Software Version"   = $Software.version
            "Software Publisher" = $Software.vendor
        }
    }
}

# Export to CSV
$ExportData | Export-Csv -Path $ExportPath -NoTypeInformation -Encoding UTF8
Write-Host "Export complete: $ExportPath"

This script queries the HaloITSM API for all devices and their associated installed software, then generates a SIM-ready CSV file.

Preparing for SIM import

The CSV header row must be exactly Device Name,Software Name,Software Version,Software Publisher.

Open the Licenseware SIM Template.
Paste the CSV data into the associated columns.

Remove blank rows and extra columns before saving.

Then upload it on the SIM - Template data source. See SIM template.

Troubleshooting

Issue	Cause	Resolution
Empty software list	Assets not linked to software records	Ensure discovery integrations or imports are configured correctly.
Unauthorized API error	Invalid or expired API key	Generate a new API key and re-run the script.
Missing vendor data	Publisher not defined in Halo	Fill in manually or enrich data after import.
Slow exports	High asset count with pagination	Add pagination (`&pageSize=&pageNumber=`) to the API query loop.
Encoding or format errors	CSV saved in ANSI	Save as UTF-8 before SIM import.

Example output

Device Name,Software Name,Software Version,Software Publisher
LAPTOP-001,Google Chrome,129.0.6668.90,Google LLC
SERVER-02,Microsoft SQL Server 2022,16.0.432,Microsoft Corporation
LAPTOP-004,Slack,4.39.95,Slack Technologies
SERVER-03,Adobe Acrobat DC,24.002.20933,Adobe Inc.