DemandFlow Support Centre

SOFTWAREINSTALL: Software Installation

The SOFTWAREINSTALL entity: Software installation instance on a specific asset, linking software catalogue, license, and deployed configuration.

Default definition. This article describes the default SOFTWAREINSTALL definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches SOFTWAREINSTALL.

Entity properties

Property	Value
Entity code	`SOFTWAREINSTALL`
Display name	Software Installation
Plural	Software Installations
Level	310

Use cases

SOFTWAREINSTALL is the junction entity that connects the software catalogue (SOFTWARE), licensing (LICENSE), and physical/virtual infrastructure (COMPINV). Each record represents one installation of one software product on one asset. This three-way relationship is the core of software asset management: it answers 'what software is installed where, and which license covers it?' The General panel links to SOFTWARE (what), COMPINV (where), and LICENSE (entitlement), with installedVersion to track version drift from the catalogue.

Status tracks the installation state (Active/Inactive/Uninstalled/Failed/Pending/Unknown). Installation Information captures when, by whom, how (Manual/Automated/Image/Package Manager/Container/Cloud Service), and where on disk. The Configuration panel adds edition/SKU, language, architecture, installed components, and environment designation (Production/Development/Test/Staging/Training/DR).

Fields

Installation Details

Field	Type	Required	Notes
`name`	text	Yes	Read-only. Auto-generated from asset and software
`software`	reference → `SOFTWARE`	Yes	Software
`asset`	reference → `COMPINV`	Yes	Asset
`license`	reference → `LICENSE`		License used for this installation
`installedVersion`	text		May differ from software catalog version
`status`	enum	Yes	Status Valid ids: `1` (Active), `2` (Inactive), `3` (Uninstalled), `4` (Failed), `5` (Pending), `6` (Unknown).

Installation Information

Field	Type	Required	Notes
`installDate`	date	Yes	Installation Date
`installedBy`	reference → user		Installed By
`installMethod`	enum		Install Method Valid ids: `1` (Manual), `2` (Automated), `3` (Image), `4` (Package Manager), `5` (Container), `6` (Cloud Service).
`installPath`	text		Installation Path
`instanceName`	text		For multi-instance software
`productKey`	text		Product Key Used

Software Configuration

Field	Type	Notes
`edition`	text	Edition/SKU
`language`	reference → `LANGUAGE`	Language
`architecture`	enum	Architecture Valid ids: `1` (x86 (32-bit)), `2` (x64 (64-bit)), `3` (ARM), `4` (ARM64).
`components`	enum	Installed Components Valid ids: `1` (Core), `2` (Client Tools), `3` (Server), `4` (Management Console), `5` (Documentation), `6` (SDK/API).
`configNotes`	text (multi-line)	Configuration Notes

Environment

Field	Type	Notes
`environment`	enum	Environment Valid ids: `1` (Production), `2` (Development), `3` (Test), `4` (Staging), `5` (Training), `6` (Disaster Recovery).
`isVirtualized`	boolean	Virtualized
`isContainerized`	boolean	Containerized
`hostSystem`	reference → `COMPINV`	Physical host if this is a VM/container
`dependencies`	text (multi-line)	Other required software

Usage Tracking

Field	Type	Notes
`lastUsed`	date	Read-only. Last Used
`lastSeen`	date	Read-only. Last inventory scan
`usageFrequency`	enum	Usage Frequency Valid ids: `1` (Daily), `2` (Weekly), `3` (Monthly), `4` (Rarely), `5` (Never).
`primaryUser`	reference → user	Primary User
`userCount`	number	Read-only. Active Users

Performance

Field	Type	Notes
`cpuUsage`	number	Read-only. Average CPU Usage
`memoryUsage`	number	Read-only. Average Memory Usage
`diskSpace`	number	Disk Space (GB)
`performanceNotes`	text (multi-line)	Performance Notes

Updates & Patches

Field	Type	Notes
`lastUpdate`	date	Last Update
`updateMethod`	enum	Update Method Valid ids: `1` (Automatic), `2` (Manual), `3` (Managed), `4` (Disabled).
`patchLevel`	text	Current Patch Level
`updateSchedule`	text	Update Schedule
`maintenanceWindow`	text	Maintenance Window

Lifecycle

Field	Type	Notes
`plannedRetirement`	date	Planned Retirement
`uninstallDate`	date	Uninstall Date
`uninstalledBy`	reference → user	Uninstalled By
`uninstallReason`	text (multi-line)	Uninstall Reason

License Compliance

Field	Type	Notes
`isCompliant`	boolean	Read-only. License Compliant
`complianceNotes`	text (multi-line)	Compliance Notes
`auditDate`	date	Last Audit Date
`auditedBy`	reference → user	Audited By

Relationships

Lookups: software points at a SOFTWARE record; asset points at a COMPINV record; license points at a LICENSE record; installedBy points at a user; language points at a LANGUAGE record; hostSystem points at a COMPINV record; primaryUser points at a user; uninstalledBy points at a user; auditedBy points at a user.

Creating a Software Installation via the API

POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json

{
  "entity":   "SOFTWAREINSTALL",
  "level":    310,
  "comboKey": "SUB:|ENT:",
  "software":    "",
  "asset":    "",
  "status":    1,
  "installDate":    "2026-01-01"
}

Listing Software Installations records

GET /v1/entities/SOFTWAREINSTALL/SUB

DemandFlow Support Centre

SOFTWAREINSTALL: Software Installation

SOFTWAREINSTALL: Software Installation

Entity properties

Use cases

Fields

Relationships

Creating a Software Installation via the API

Listing Software Installations records

See also

Was this article helpful?