Define Custom Attributes in Aternity

A custom attribute is a property of a device, location or user that you define, which Aternity does not normally detect. You can use a custom attribute to easily group together the items which share this property, to monitor their performance.

For example, you can configure Aternity to report if a device has disk encryption, to compare the performance of encrypted versus regular devices.

You can view custom attributes in Aternity's REST APIs or in the Analyze dashboards.

Tip

To customize an attribute, contact Aternity Support Team and provide details of the property you want to collect.

You can configure Aternity with a custom attribute in one of the following ways:

Define a custom attribute in one of four ways
  • Aternity Support Team can create an Aternity monitor which detects whether a Windows feature is enabled (like disk encryption) by querying the Windows WMI, then reporting it to Aternity.

  • Aternity Support Team can create an Aternity monitor which checks the value of a specific key in the Windows Registry of devices, which the Agent for End User Devices picks up and reports to Aternity.

  • You can manually create a mapping file as a plain text CSV file with two columns, where the first column lists the items (either hostnames, locations or usernames) which have this custom attribute, while the second column contains the mapped value of its custom attribute. Then send the mapping file to add it to Aternity.

  • (From Agent 12.0.x) You can create a PowerShell script file which have this custom attribute and its value. Then contact Aternity SaaS Administration and send the file to add it to Aternity. Scripts allow using any custom attribute, not only the predefined attribute names explained below.

Note

Any of the above options is supported for Windows devices. For Mac devices, only a manual mapping using a CSV file is available at this point.

Custom attributes only display in dashboards if you defined them for your enterprise. You can define one of the nine placeholder fields (Custom Attribute 1-9), or use one of the predefined attribute names, like a device's Image Build Number.

Field Description
Custom Attribute 1-9

Custom Attribute 1 through 9 are placeholder custom attributes which you can optionally define.

Only displays if you defined a custom attribute using this predefined name.

The predefined names of custom attributes are:

Attribute Description
Channel

Only displays if you defined a custom attribute using this predefined name.

Use this name for an attribute which differentiates a device, user or location along internal business units or areas of the company like retail outlet or customer service center.

Image Build Number

Only displays if you defined a custom attribute using this predefined name.

Use this name for an attribute which displays the ID of the disk image used when creating this device's initial setup and configuration.

LOB (Line of Business)

Only displays if you defined a custom attribute using this predefined name.

Use this name for an attribute which displays the type of business associated with this device, like life insurance, auto insurance, or finance.

Market

Only displays if you defined a custom attribute using this predefined name.

Use this name for an attribute which displays the target market or business unit of a location, or a user or device in that area of the company.

Store ID

Displays your organization's internal code that identifies each retail store.

Only displays if you defined a custom attribute using this predefined name.

Store Type

Displays the type of store, for example, branch, mall, or superstore.

Only displays if you defined a custom attribute using this predefined name.

User Role

Displays user role descriptions customized by your organization, for example, Floor Sales, or Phone Support.

Only displays if you defined a custom attribute using this predefined name.

Note

Aternity collects user attributes (data associated with a user) and device attributes (data associated with a device). For example, organizational units are typically user related, whereas hardware characteristics are device related. You can define Custom_Attribute_1 - 9 for any attribute, user's or device's. If multiple users are using the same device, Aternity detects that a different user is using the device and all user attributes are being updated for that user as well.

User_Custom_Attribute can define only user related attributes. Currently, you can define User Custom Attribute only by mapping a CSV file for the user name: you can manually create a mapping file as a plain text CSV file with two columns, where the first column lists the usernames which have this user custom attribute, while the second column contains the mapped value of its attribute. Then send the mapping file to add it to Aternity.