Before you begin
Plans: Enterprise only
Audience: Administrators
This article provides definitions for the following items in equipment audit trail files:
- The columns included in the files.
- The possible services, which indicate the type of record that's being created, updated, or deleted.
- The possible keys, which indicate the exact field being created, updated, or deleted in the record.
Columns
Equipment audit trail CSV files contain the following columns:
Column | Description |
---|---|
Time (in UTC) |
The date and time that the change occurred (in the UTC timezone). |
Site |
The site that the equipment belongs to, displayed as a combination of the site's code and name. For example, if the site's code was "A1" and its name was "Toronto", it would be displayed as "A1-Toronto". |
Service |
The type of item that's being created, updated, or deleted. For example, if it's a meter reading, this column would display MeterReading. See the Services section of this article for a list of possible services. |
Identifier |
A combination of the equipment's code and name. For example, if an equipment's code is "A33" and its name is "Forklift 1", its identifier would be "A33-Forklift 1". |
Associates Asset Code |
The identifier for the associated equipment record in cases where the service listed is not the equipment itself (e.g. AssetUser or Warranty). |
Parent |
The equipment's parent asset (if applicable). Similar to the Identifier field, the parent asset is displayed using a combination of its code and name. |
Asset Code |
The equipment's code (e.g. "A33"). |
Asset Name |
The equipment's name (e.g. "Forklift 1"). |
Modified By |
The username (or email address) of the user who made the change. |
Action (CRUD) |
The type of action (also called an event) occurring in this row. The possible actions are: CREATE, UPDATE, and DELETE. |
Key |
The key for the affected field. For example, a change to an equipment's location would display "Asset Location id". See the Keys section of this article for a list of all possible keys. |
Value |
The value associated with the change. For example, a warranty's certificate number was updated, this column would display the new certificate number. Note: Values in audit trail are limited to 1000 characters. For example, if an equipment's description exceeds 1000 characters, the file will only include the first 1000. |
Services
The Services column displays the type of record being created, updated, or deleted. The possible services are:
Service | Description |
---|---|
Asset | An equipment record. |
AssetBusiness |
A business (supplier, manufacturer, etc.) associated with an equipment record. Businesses are added to equipment records in the Businesses tab. |
AssetConsumingReference | The parts associated with an equipment record, either individually or via a bill of materials (BOM) group. Parts and BOMs are added to equipment records in the Parts/BOM tab. |
AssetEvent | The events (fire, earthquake, etc.) added to an equipment record, which are recorded in the Metering/Events tab. |
AssetEventType |
The event types that can be assigned to an asset event. Event types can be configured directly in the equipment record (when adding an event in the Metering/Events tab) or in Settings > CMMS Settings > Lookup Tables. |
AssetOfflineTracker | Changes to an equipment's status (i.e. online or offline). |
AssetUser | The users associated with an equipment record. Users are added to equipment records in the Personnel tab. |
File | The files attached to an equipment record. Files are uploaded to equipment records in the Files tab. |
MeterReading | The meter readings recorded in an equipment record. Meter readings are added to equipment records in the Metering/Events tab. |
MeterReadingUnit |
The units that can be associated with meter readings. Meter reading units can be configured directly in the equipment record (when adding a new reading in the Metering/Events tab) or in Settings > CMMS Settings > Lookup Tables. |
MoveAsset |
Location changes made through the "move assets" feature. If your organization doesn't use the move assets feature, changes to an equipment's parent location will be recorded in the Asset service instead. |
ReasonToSetOffline |
The reasons that can be selected when changing an equipment's status to offline. Reasons to set offline can be configured directly in the equipment record (when selecting a reason to set offline) or in Settings > CMMS Settings > Lookup Tables. |
ReasonToSetOnline |
The reasons that can be selected when changing an equipment's status to online. Reasons to set online can be configured directly in the equipment record (when selecting a reason to set online) or in Settings > CMMS Settings > Lookup Tables. |
Warranty | The warranties for an equipment record. Warranties are added to equipment records in the Warranties tab. |
Keys
The Keys column displays the field associated with the change. The possible keys are:
Service | Key | Description |
---|---|---|
Asset | Account id | The account assigned to the equipment (from the Account field in the General tab). |
Aisle | The aisle the equipment is located in (from the Aisle field in the General tab). | |
Asset Location id |
The equipment's parent location (from the This Equipment is located at field in the General tab). This could be a site or facility depending on what level the equipment is at in the asset hierarchy. |
|
Asset Parent id | The equipment's parent asset (from the This Equipment is part of field in the General tab). | |
Barcode | The equipment's barcode value (from the Barcode field in the General tab). | |
Bin Number | The bin the equipment is located in (from the Bin field in the General tab). | |
Category id | The asset category the equipment belongs to (from the Category field). | |
Charge Department id | The charge department assigned to the equipment (from the Charge Department field in the General tab). | |
Code | The equipment's code (from the Code field). | |
Country id | The ISO numeric identifier for the country the equipment is located in. | |
Created | The timestamp (in UTC) from when the equipment record was created. | |
Created From Receipt Line Item id | If an equipment record was created via a receipt, this key displays a unique numeric identifier automatically assigned to the corresponding line item. | |
Description | The equipment's description (from the Description field). | |
Has Address | This key corresponds to a field that is not currently used and can be ignored. | |
Imported Price From V2 | This key corresponds to a field that is not currently used and can be ignored. | |
Is Bill To Facility |
This key does not apply to equipment records and can be ignored. |
|
Is Critical | This key corresponds to a field that is not currently used and can be ignored. | |
Is Online |
A boolean indicating whether the equipment is online. 0 = Offline |
|
Is Pool | This key corresponds to a field that is not currently used and can be ignored. | |
Is Region |
This key does not apply to equipment records and can be ignored. |
|
Is Shipping Or Receiving Facility |
This key does not apply to equipment records and can be ignored. |
|
Is Site |
This key does not apply to equipment records and can be ignored. |
|
Last Meter Reading Unit id | The meter reading unit that was automatically selected in the drop-down list when the new reading was added (i.e. before a unit was selected for the new reading). | |
Last Price Currency id | The currency setting for your CMMS (from the Primary Currency field in Settings > Business). | |
Last Updated | The timestamp (in UTC) from the last time the equipment record was edited. | |
Latitude |
The latitude for the equipment's location (from the Latitude field in the General tab). This field is only displayed if the Use Inherited Location checkbox is cleared. |
|
Longitude |
The longitude for the equipment's location (from the Longitude field in the General tab). This field is only displayed if the Use Inherited Location checkbox is cleared. |
|
Make | The equipment's make (from the Make field in the General tab). | |
Manage Inventory | This key does not apply to equipment records and can be ignored. | |
Model | The equipment's model (from the Model field in the General tab). | |
Name | The equipment's name (from the Name field). | |
Needs Calibration | This key does not apply to equipment records and can be ignored. | |
Notes | The equipment's notes (from the Notes field in the General tab). | |
Row | The row where the equipment is located (from the Row field in the General tab). | |
Serial Number | The equipment's serial number (from the Serial Number field in General tab). | |
Site id | The site where the equipment is located (from the Site field in the General tab). | |
Stock Count | This key does not apply to equipment records and can be ignored. | |
Super Category id |
The top-level asset category assigned to this equipment (which is selected when you first create the asset record). In equipment audit trail files, the value for this key is always "Equipment". |
|
Super Category Sys Code |
The numeric identifier associated with the top-level asset category. In equipment audit trail files, the value for this key is always "2" (the numeric ID for the equipment category). |
|
Sys Custom Column Values | This is how your custom fields are displayed in audit trail. To learn more about setting up custom fields, see Add a custom field to an asset. | |
Unspc Code | The equipment's UNSPC code (from the UNSPC field in the General tab). | |
Users Can Clock In Out | This key corresponds to a field that is not currently used and can be ignored. | |
Uuid | A unique identifier assigned to the equipment automatically. | |
Weighted Price | This key does not apply to equipment records and can be ignored. | |
AssetBusiness | Add Shipment Address To RFQ | This key does not apply to equipment records and can be ignored. |
Asset id | The name of the equipment that the business is being associated with. | |
Business Asset Number | The supplier's part number for the equipment (from the Supplier Part Number field in the Businesses tab). | |
Business Group id | The type of business being associated with the equipment (from the Business Type field in the Businesses tab). | |
Business id | The name of the business being associated with the equipment (from the Business field in the Businesses tab). | |
Catalog | The equipment's catalog number (from the Catalog field in the Businesses tab). | |
Economic Batch Quantity | This key does not apply to equipment records and can be ignored. | |
Enable Business Tracking Sync |
A boolean indicating whether business tracking is enabled (in Settings > CMMS Settings > Business Tracking). 0 = No (business tracking not enabled) |
|
Preferred Vendor |
A boolean indicating whether the This is my preferred vendor checkbox is selected. If this checkbox is selected, this vendor will automatically be selected when you create new RFQs for this equipment. 0 = No (checkbox cleared) |
|
Primary |
A boolean indicating whether the Display as primary business checkbox is selected. This checkbox is only displayed if business tracking is enabled. 0 = No (checkbox cleared) |
|
Send RFQs | This key does not apply to equipment records and can be ignored. | |
Uuid | A unique identifier assigned to the business automatically. | |
AssetConsumingReference | Asset id | The equipment that the part or BOM is being added to. |
BOMControl id | A unique identifier assigned to the BOM automatically. | |
BOMPart Control id | A unique identifier automatically assigned to the part within the BOM. | |
Consumes Asset id | The name of the part being added to the equipment, either on its own or as part of a BOM (from the Part/Supply field in the Parts/BOM tab). | |
Max Consumption | The part quantity being added to the equipment (from the Qty field in the Parts/BOM tab). | |
Uuid | A unique identifier automatically assigned to the association between the part or BOM and the equipment. | |
AssetEvent | Additional Description | The description given when adding the event to the equipment record (from the Additional Description field in the Metering/Events tab). |
Asset Event Type id | The name of the event type being added (from the Asset Event Type field in the Metering/Events tab). | |
Asset id | The equipment the event is being added to. | |
Date Submitted | The timestamp (in UTC) from when the event was added to the equipment record. | |
Submitted By User id | The name of the user who added the event to the equipment record. | |
AssetEventType | Event Code | The code given to the event when it was created (from the Code field). |
Event Description | The description given to the event when it was created (from the Event Description field). | |
Event Name | The name given to the event when it was created (from the Event Name field) | |
AssetOfflineTracker | Asset Event Description | If an asset event was generated when setting this equipment offline, this key displays the description that was provided (in the Event Description field on the Set Offline screen). |
Asset Event Type id | If an asset event was generated when setting this equipment offline, this key displays the event that was selected (in the Event Type field on the Set Offline screen). | |
Asset id | The equipment whose status was changed. | |
Asset Is Located At Asset id | The equipment's location. | |
Off Line To | The timestamp (in UTC) from when the equipment's status was changed back to online. | |
Offline Additional Info | The additional information provided when setting the equipment offline (from the Additional Info field on the Set Offline screen). | |
Offline From | The date selected when setting the equipment offline (from the Offline From field on the Set Offline screen). | |
Online Additional Info | The date selected when setting the equipment back online (from the Online From field on the Set Online screen). | |
Production Hours Affected | The number of production hours affected by the asset being offline (from the Production Hours Affected field on the Set Online screen). | |
Rb Asset Location | This key corresponds to a field that is not currently used and can be ignored. | |
Reason Offline id | The reason the asset was set offline (from the Status field on the Set Offline screen). | |
Reason Online id | The reason the asset was set online (from the Status field on the Set Online screen). | |
Set Offline By User id | The name of the user who set the asset offline. | |
Uuid | A unique identifier assigned to the status change automatically. | |
AssetUser | Asset id | The equipment the user is being added to. |
Asset User Type id | This key corresponds to a field that is not currently used and can be ignored. | |
Can Clock In | This key corresponds to a field that is not currently used and can be ignored. | |
Date Added | The timestamp (in UTC) when the user was added to the equipment record. | |
User id | The name of the user being added to the equipment record (in the Personnel tab). | |
File | Asset id | The equipment the file is being added to. |
File Type |
A numeric identifier for the file type (selected in the File Type drop-down list). 1 = File |
|
Image |
A boolean indicating whether the file is an image. 0 = No (not an image) |
|
Name | The file's name (from the Name field). | |
Uuid | A unique identifier assigned to the file automatically. | |
MeterReading | Asset id | The equipment the reading is being logged for. |
Date Submitted | The timestamp (in UTC) from when the meter reading was added. | |
Meter Reading |
The reading itself (from the Meter Reading field). Note: Each time a new reading is added, there will be 2 records: the first one where it's created, with a 0 reading value, and an update that shows the actual meter reading that was recorded. |
|
Meter Reading Units id | The unit associated with the meter reading (from the Meter Reading Units field). | |
Submitted By User id | The user who logged the meter reading. | |
Uuid | A unique identifier assigned to the reading automatically. | |
MeterReadingUnit | Name | The name given to the unit when it was created (from the Name field). |
Precision | The decimal precision for the unit (from the Precision field). | |
Symbol | The symbol assigned to the unit (from the Symbol field). | |
Uuid | A unique identifier assigned to the unit automatically. | |
MoveAsset | Asset id | The equipment being moved. |
Away |
A boolean indicating whether there's a return date set for the equipment (from the Return Date field on the Move Asset screen). 0 = No (return date not set) |
|
Date Returned | The date the equipment was returned (i.e. checked back in). | |
Exclude | This key corresponds to a field that is not currently used and can be ignored. | |
From Aisle | The aisle the equipment is being moved from (from the Aisle field in the General tab). | |
From Bin | The bin the equipment is being moved from (from the Bin field in the General tab). | |
From Row | The row the equipment is being moved from (from the Row field in the General tab). | |
Move id | A unique identifier assigned to the move automatically. | |
Moved From id | The location the equipment is being moved from. This information is only displayed if the aisle, row, or bin fields are filled out in the equipment record. | |
Pending |
A boolean indicating whether the move is pending (i.e. requires approval). 0 = No (not pending approval) |
|
Reason Online id | The reason selected for putting the equipment online during the move (from the Reason Online field on the Move Asset screen). | |
Reason Offline id | The reason selected for taking the equipment offline during the move (from the Reason Offline field on the Move Asset screen). | |
Return Date | The return date for the move (from the Return Date field on the Move Asset screen). | |
Set Offline |
A boolean indicating whether the Set offline during move checkbox (on the Move Asset screen) is selected. 0 = No (checkbox cleared) |
|
Set Online |
A boolean indicating whether the Set online during move checkbox (on the Move Asset screen) is selected. 0 = No (checkbox cleared) |
|
Site id | The site the equipment is being moved to. | |
ReasonToSetOffline | Description | The description given to the reason to set offline when it was created (from the Description field). |
Name | The name given to the reason to set offline when it was created (from the Name field). | |
ReasonToSetOnline | Description | The description given to the reason to set online when it was created (from the Description field). |
Name | The name given to the reason to set online when it was created (from the Name field). | |
Warranty | Asset id | The equipment the warranty is being added to. |
Certificate Number | The warranty's certificate number (from the Certificate Number field in the Warranties tab). | |
Date Added | The timestamp (in UTC) from when the warranty was added to the equipment. | |
Description | The warranty's description (from the Description field in the Warranties tab). | |
Expiry Date | The warranty's expiry date (from the Expiry Date field in the Warranties tab). | |
Meter Reading Units id | The meter reading units associated with the warranty (from the Meter Reading Units field in the Warranties tab). This field only applies to warranties with the meter reading usage term type. | |
Meter Reading Value Limit | The meter reading units associated with the warranty (from the Meter Reading Value Limit field in the Warranties tab). This field only applies to warranties with the meter reading term type. | |
Provider id | The warranty provider (from the Provider field in the Warranties tab). | |
Uuid | A unique identifier assigned to the warranty automatically. | |
Warranty Type id |
The type of warranty (from the Warranty Type field in the Warranties tab). Possible values are "Basic" and "Extended". |
|
Warranty Usage Term Type id | The warranty's usage term type (from the Warranty Usage Term Type field in the Warranties tab). Possible values are "Date", "Meter Reading", and "Production time". |