Working with Custom Data

Custom fields allow you to add extra data to an asset. There are two types of custom fields:

• Common Fields - Also known as Axonius Fields, these are fields from the adapter. The field type and available values are determined by the selected field.
• Specific Fields - Also known as Custom Fields, these are tailormade fields that you create. When a specific field is added to an asset, it is added only to the selected assets.

Custom fields appear in the list of fields in the Query Wizard and in the Custom Data tab under Adapter Connections on the Asset Profile page. Custom fields can also be displayed in an asset table and edited inline.

Adding a Custom Field to Assets

You can add a single custom field to one or more selected assets at the same time.

To add a custom field to assets

1. On the relevant Assets page, select one or more assets.
2. From the Actions menu, select Add Custom Field. The Add Custom Fields dialog opens.

3. Optionally, from the Field dropdown, filter the list of fields.

4. From the Field dropdown, select an existing field. The Field Type and Value Type are preset (determined by the field itself).
   You can also define new custom fields. See Creating New Custom Fields.

5. In the text field to the right, type or select a value for the field. The value must match the Field Type and Value Type.
   

   • For Single Value fields, type a value.
   • For Single Select fields, you can select a predefined value.
   • For Multiple Values fields, you can add a list of values with the values separated by pressing Enter, a comma or semicolon.

6. Click Apply. The custom field is added to the selected assets. The custom field can be selected as a column in the asset table. For each asset, the value of the field is displayed.

Filtering the List of Fields

You can filter the list of fields so that the Fields dropdown displays only Custom fields, only Axonius fields, or all fields.

To filter the list of fields

1. Click the Field dropdown, and then click the Filter icon.

2. From the Filter by menu that opens, select Custom Fields, Axonius Fields, or All Fields (the default). The Field dropdown now lists fields of the chosen Custom Field type.

Creating New Custom Fields

You can create as many custom fields as you need of types Single Value or Multiple Values. These fields can be used just like any other system or adapter field.

To add a new custom field to the system

1. On the relevant Assets page, select one or more assets.

2. From the Actions menu, select Add Custom Field. The Add Custom Fields dialog opens (see screen in step 2 of Adding Custom Fields to Assets above).

3. Start typing a field name in the Field box. It is recommended to include in a custom field name characters A-Z and 0-9 only.
   If a field of that name already exists, it is displayed. Continue to type the full name of the new field and at the bottom of the Field list, click + New Field Name.

   

4. In Field Type, select one of the following:

   • Single Value - To create a single-value field.
   • Multiple Values - To create a list field.

5. In the Value Type list, select one of the available types:

   • When Field Type is Single Value, the following Value Types are available:
     • String
     • Date - See Adding a Custom Date Field.
     • Float
     • Integer
     • Boolean
   • When Field Type is Multiple Values, the following Value Types are available:
     • String
     • Date - See Adding a Custom Date Field.
     • Float
     • Integer

6. FIll in a value or values in the text box:

   • When the Field Type is Single Value, type a single value in the empty text box. The value is determined by the Value Type.
   • When the Field Type is Multiple Values, in the Add text box, type the list of field values. Press Enter, comma, or semicolon to add another value. You can click the x of a value to remove it, or click a value to edit it.

Custom fields are marked with a user icon in the list of fields.

7. Click Apply to add the new field to the selected assets.

8. If you have Admin permissions, you can manage all custom fields in the system. Click Manage Custom Fields. You will be taken to the Managing Custom Fields page.

Adding a Custom Date Field

You can add one or more dates in a custom field. This is useful for instance, to identify the first time an asset was noncompliant. You can add a single or multiple date field.

To add a single date or a list of dates

1. On the relevant Assets page, select one or more assets.

2. From the Actions menu, select Add Custom Field. The Add Custom Fields dialog opens (see screen in step 2 of Adding Custom Fields to Assets above).

3. Start typing in the Field box. If a field of that name already exists it is displayed. Continue to type the full name of the new field and at the bottom of the Field list, click + New Field Name.

4. In Field Type, select one of the following:

   • Single Value - To add a single date.
   • Multiple Values - To add a list of dates.

5. Select Date as the Value Type.

6. In the rightmost text box, add a date or dates:

   • For a Single Value date field: Click Select Date.
     

   • For a Multiple Values date field: Click Add Date.
     

7. In the Date Picker that opens, select a date. By default, the current date is selected. You can select a date in the past, present, or future.

8. To add a time with the date, click select time at the bottom of the Date Picker. By default, the current time of 00:00 is selected. From this screen, you can click select date to change the date.

9. Click Ok to set the date and time.

10. For a Multiple Values date field, for each additional date that you want to add to the field, click Add Date and select a date and time (see steps 7 to 9 above).

11. Click Apply to add the new date field to the selected assets.

Editing Existing Single Value or Multiple Values Custom Fields

You can edit the value of an existing custom field of type Single Value or Multiple Values, whether common or specific. You cannot edit its Field Type.

Editing a Custom Field from the Add Custom Field Dialog

To edit a value of an existing custom field from the Add Custom Fields dialog

1. On the relevant Assets page, select one or more assets.

2. From the Actions menu, select Add Custom Field. The Add Custom Fields dialog opens (see screen in step 2 of Adding Custom Fields to Assets above).

3. Optionally, from the Field dropdown, filter the list of fields.

4. From the Field dropdown, select the field that you want to edit.

5. Click the Value field, and type the new value.

6. When you are finished adding or editing custom fields, click Apply.

Editing a Custom Field Inline on the Assets Page

To edit a value of an existing custom field using inline edit

1. On the relevant Assets page, configure the columns to display the custom field you want to edit. See Setting Page Columns Display on how to configure the page columns.
2. Hover over the value of a custom field for the asset you want and click the pencil icon.

3. In the edit dialog, change the value according to the field type and click Save Changes.

Editing Existing Single Select Custom Fields

You can modify, delete, or add values of an existing custom field of type Single Select, whether common or specific, from the Custom Data management table in System Settings.
For a complete explanation, see Managing Custom Fields.

Adding Custom Fields to Query or Filter Results with a Quick Enforcement Action

You can use a quick Enforcement Action to add custom fields to all assets returned by a query.

To add custom fields to assets using a quick Enforcement Action

1. On the relevant Assets page, run a saved query or filter the Assets list.

2. From the EC Actions menu, select Add custom field. The Add Custom Field dialog opens.

3. In the Enforcement Set name field, a default value is provided. You can change this to fit your needs.

4. In Field name, type a name for the custom field (see Field in Creating New Custom Fields). Then, select a Field type and Value type.

5. In the Field value text box, type a value for the field.

6. To have this field removed from assets that do not match the query parameters, select Remove this custom data field from entities not found in the saved query results. A safeguard is displayed. Click Confirm if you want to continue.

7. To run this Enforcement Set on a schedule, toggle on Set scheduling and configure the schedule you want. To learn more about running Enforcement Sets on a schedule, see Scheduling Enforcement Set Runs.

8. Click Save and Run. The custom field is saved and the notification 'Action Created Successfully' is displayed.

Adding Risk Score Custom Field to Devices Using Enforcement Action

You can use the Axonius - Calculate Risk Score Enforcement Action with Weighted Risk Score set to per Device to calculate the risk score of each device that matches the Device query defined for the Enforcement Set, and write the calculated value into the Risk Score: Axonius calculated field per device Custom field. You can see this field and its value in the Asset Profile> Custom Data page of each device.

Learn how to view the Risk Score in the Device Asset Profile Custom Data.

Managing Custom Fields for a Specific Asset

You can view and manage all the custom data fields configured for a specific asset.

To manage an asset's custom fields

1. On the relevant Assets page, click an asset. The Asset Profile page opens for the selected asset.

2. In the left navigation pane, under Adapter Connections, click Custom Data.

3. In the upper-right of the Asset Profile Custom Data, click Manage Custom Fields.

In the Manage Asset Custom Fields dialog, all the custom fields related to this asset are listed.

From this screen, you can do the following:

• Add custom fields - Click + Add Custom Field at the bottom left of the screen (scroll down), and in the field that opens, add an existing Axonius or Custom field to the asset, or create a new Custom field (date or other) to add to the asset.
• Delete existing custom fields - Click the trashcan icon to the right of the field.
• Add values to custom fields - Click inside the Value box of the field and add a value:
  • For a Single Value Boolean field, select True/False. For other Single Value fields, overtype the value with a new value.
  • For a Multiple Values field, for each value that you want to add, click Add and type the new value, or in the case of a Date field, click Add Date, and add a new date.
• Remove values from Multiple Values custom fields - Click the x in the tiles of the values that you want to delete. Make sure that at least one value remains.

2. When you are finished making changes, click Save Changes.