HCL BigFix
Export installed applications across managed endpoints from the BigFix Web Reports console, the BigFix REST API or the BigFix Inventory database, as a CSV with the fields the SIM template needs.
HCL BigFix collects detailed endpoint data via its client agents and centralized server components. The relevant software inventory information can be retrieved from the following sources:
- BigFix Inventory / Software Inventory Site, Stores detected software names, versions, and vendors.
- BigFix Web Reports, Provides query and export capabilities for inventory data.
- BigFix REST API, Enables direct, scriptable access to device and application data for automated exports.
Prerequisites
Section titled âPrerequisitesâFor console (Web Reports) method
Section titled âFor console (Web Reports) methodâ- Access to the BigFix Web Reports Console with permission to view Computer Properties and Installed Applications.
- Recent inventory scans must be completed and reported by all endpoints.
- Ensure the Software Inventory or BigFix Inventory content site is activated and subscribed.
For REST API method
Section titled âFor REST API methodâ- Access to the BigFix REST API with read permissions.
- API credentials (username and password) with sufficient rights to query computer and software data.
- A working environment with PowerShell, curl, or Postman.
- (Optional) Access to the BigFix Inventory database if direct SQL queries are preferred for bulk extraction.
You can extract software inventory using either of the following approaches:
Export methods
Section titled âExport methodsâOption 1: BigFix Web Reports (UI export)
Section titled âOption 1: BigFix Web Reports (UI export)âThis is the simplest method for administrators who prefer a graphical interface.
- Log in to the BigFix Web Reports Console.
- Go to Reports â Create Report â Retrieved Properties.
- Under Computers, select:
- Computer Name
- Installed Applications, Windows / macOS / Linux
- Application Version
- Application Publisher (if available)
- Click Run Report to generate results.
- Once the report loads, click Export â CSV.
- Save the file as
BigFix_SIM_Export.csv.
Tip: You can also use the prebuilt âSoftware Installationsâ report under BigFix Inventory to generate the same dataset.
Option 2: HCL BigFix REST API (recommended for automation)
Section titled âOption 2: HCL BigFix REST API (recommended for automation)âFor automated or large-scale environments, the BigFix REST API provides a more efficient method.
Step 1: Define and run a relevance query
Section titled âStep 1: Define and run a relevance queryâUse the following Relevance Query to retrieve the required data:
( name of it, (if (operating system of it as lowercase contains "win") then concatenation "; " of values of results from (bes property "Installed Applications - Windows") of it else if (operating system of it as lowercase contains "mac") then concatenation "; " of values of results from (bes property "Installed Application Details - Mac") of it else if (operating system of it as lowercase contains "linux") then concatenation "; " of values of results from (bes property "Installed Applications - Linux") of it else "N/A"), (if (operating system of it as lowercase contains "win") then concatenation "; " of values of results from (bes property "Installed Application Versions - Windows") of it else ""), (if (operating system of it as lowercase contains "win") then concatenation "; " of values of results from (bes property "Installed Application Publishers - Windows") of it else ""))of bes computers whose (exists operating system of it)Step 2: Execute query via PowerShell
Section titled âStep 2: Execute query via PowerShellâ# HCL BigFix SIM Template Export Script# Requires valid REST API credentials
$BigFixServer = "https://your-bigfix-server:52311"$Username = "api_user"$Password = "api_password"$ExportPath = "C:\Exports\HCL_BigFix_SIM_Export.csv"
# Encode credentials$EncodedAuth = [Convert]::ToBase64String([Text.Encoding]::ASCII.GetBytes("$Username`:$Password"))$Headers = @{ "Authorization" = "Basic $EncodedAuth" }
# Build relevance query$Relevance = @"( name of computer of it, name of it, version of it, vendor of it)of applications of (bes computers whose (exists operating system of it))"@
# Submit query request$Body = "<BES><Relevance>$Relevance</Relevance></BES>"$Response = Invoke-RestMethod -Uri "$BigFixServer/api/query" -Method Post -Headers $Headers -Body $Body -ContentType "application/xml"
# Parse results$ExportData = @()foreach ($Result in $Response.Query.Result.Answer) { $Values = $Result -split "," $ExportData += [PSCustomObject]@{ "Device Name" = $Values[0].Trim() "Software Name" = $Values[1].Trim() "Software Version" = $Values[2].Trim() "Software Publisher" = $Values[3].Trim() }}
# Export to CSV$ExportData | Export-Csv -Path $ExportPath -NoTypeInformation -Encoding UTF8Write-Host "Export complete: $ExportPath"This script connects to your BigFix environment, runs the Relevance query, and exports the results to a properly formatted CSV file ready for import.
Option 3: BigFix inventory database query (advanced)
Section titled âOption 3: BigFix inventory database query (advanced)âIf your organization uses BigFix Inventory with a SQL backend, you can query the database directly.
Example SQL query
Section titled âExample SQL queryâ-- HCL BigFix SIM Template Export QuerySELECT c.computer_name AS [Device Name], s.software_name AS [Software Name], s.software_version AS [Software Version], s.software_publisher AS [Software Publisher]FROM software_installations sJOIN computers c ON s.computer_id = c.computer_idORDER BY c.computer_name, s.software_name;- Open SQL Server Management Studio.
- Connect to your BigFix Inventory database.
- Run the above query.
- Save results as CSV via Save Results As â CSV File.
Preparing for SIM import
Section titled â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 or import the exported CSV data.
Remove any blank or extraneous rows before saving.
Then upload it on the SIM - Template data source. See SIM template.
Troubleshooting
Section titled âTroubleshootingâ| Issue | Cause | Resolution |
|---|---|---|
| Empty report or missing data | Endpoints not reporting software inventory | Ensure software scans are enabled and up-to-date. |
| 401 Unauthorized (API) | Invalid or expired credentials | Revalidate credentials in the BigFix Console. |
| Publisher field empty | Vendor data not collected by the client | Modify the relevance query or enrich data manually. |
| Query timeout | Large environments with many endpoints | Use pagination or run the query in batches. |
| Encoding issues | CSV not saved as UTF-8 | Re-save the file with UTF-8 encoding before import. |
Example output
Section titled âExample outputâDevice Name,Software Name,Software Version,Software PublisherDESKTOP-001,Google Chrome,129.0.6668.90,Google LLCLAPTOP-007,Microsoft Teams,1.7.00.12345,Microsoft CorporationSERVER-05,Oracle Java SE Runtime Environment,8.0.411,Oracle CorporationDESKTOP-004,Adobe Acrobat DC,24.002.20933,Adobe Inc.