How to create a custom audit field
This guide shows you how to define a Custom audit field - a per-Site, per-device-type column that AlloyScan populates during audit - and surface it in inventory grids and change tracking.
Use this when the built-in audit attributes do not capture something specific that your operations need to filter or report on (an asset tag, a department code, a custom registry value, a derived metric).
Prerequisites
- You are signed in as a Site Administrator.
- You know which device type the new field applies to (
Windows computer,SNMP device,AWS EC2 instance,Azure instance, and others). Custom audit fields are scoped per device type. - If the field will be populated by a script, you have the PowerShell script ready. AlloyScan does not validate script correctness on the create form.
Steps
- Navigate to Admin Center > Site Settings > Customization > Custom audit fields.
- Click + New field.
- Fill in the fields:
- Label - display label that appears in inventory grids and the device form.
- Name - internal identifier, used as the column key.
- Device type - which device class the field applies to.
- Device subtype - for SNMP device fields, select
PrinterorSwitch. - Field type - data type for the collected value.
- Script - for Windows computers and AWS or Azure resources, the PowerShell script that collects the value during audit.
- SNMP OID - for SNMP devices, enter the OID directly or turn on Use MIB Browser to select it from a MIB file.
- Click Save.
Verify
The new field appears in the Custom audit fields grid under the corresponding device-type group.
To confirm it populates correctly:
- Trigger an ad-hoc audit on a device whose type matches the field's scope (
Inventory > Devices > (device) > Audit now). - After the audit completes, open the device record and look for the field on the device form.
- The field also becomes available as a filterable column in inventory grids.
Important: Custom audit fields populate on subsequent audits. Existing audit snapshots taken before the field was created do not back-fill. Re-audit the affected devices to populate values across the inventory.
How custom fields surface across the product
| Surface | What you see |
|---|---|
| Device form | Field value as a row, scoped to the device's type. |
| Inventory grid | Optional column you can add via grid customization, with filter support. |
| Change tracking | Field deltas appear under the Custom audit fields category if Change tracking is enabled. |
Cloud resources
Custom audit fields are not limited to Windows and SNMP. AWS and Azure cloud-resource audits populate custom fields on audited cloud objects when the field's Device type matches the cloud resource type.
Related
- Custom Audit Fields Reference - types, surfaces, and constraints.
- PowerShell Examples for Custom Audit Fields - sample scripts for the Script field.
- Change Tracking Reference (admin) -
Custom audit fieldsis one of the seven tracking categories.