Online Help

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 from audit data, a script, or a manual entry — and surface it in inventory grids, change tracking, and reports.

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, EC2 instance, …). Custom audit fields are scoped per device type.
  • If the field will be populated by a script, you have the script ready. AlloyScan does not validate script correctness on the create form.

Steps

  1. Navigate to Admin Center > Site Settings > Customization > Custom audit fields.
  2. Click + New field.
  3. Fill in the fields:
    • Label — display label that appears in inventory grids, the device form, and reports.
    • Name — internal identifier, used as the column key.
    • Device type — which device class the field applies to.
    • Device subtype — for SNMP devices, optionally narrow to Printer, Switch, or Other. Leave empty to apply to all subtypes of the chosen device type.
    • Field type — Memo (long text), String (short text), Table (tabular data), or Logical (true / false). Additional types may vary by deployment.
    • Script — the audit-time script body.
  4. Click Save.

Verify

The new field appears in the Custom audit fields grid under the corresponding device-type group.

To confirm it populates correctly:

  1. Trigger an ad-hoc audit on a device whose type matches the field's scope (Inventory > Devices > (device) > Audit now).
  2. After the audit completes, open the device record and look for the field on the device form.
  3. The field also becomes available as a filterable column in inventory grids and as a reportable column in custom reports.

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.
Reports Field is exportable as a column in custom reports.

Cloud resources

Custom audit fields are not limited to Windows and SNMP. Cloud-resource audits (AWS, Azure, Google) populate custom fields on the audited cloud objects too, when the field's Device type matches.