Dynamic Fields and Custom Fields

Lucidum includes two types of user-defined fields to make repetitive tasks easier and to help organize assets and users:

• Dynamic Fields. You can create a query and save the query as a dynamic field. These new fields are called Dynamic Fields. In the Locate page, the dynamic field will appear under the category Dynamic Fields and can be used in queries. You can manage Dynamic Fields in the Dynamic Field Management page (Settings > Dynamic Field Management).

• Custom Fields. Custom fields are tags that you can create and assign to assets and users to aid management. You can create custom fields in the Custom Field Management page (Settings > Custom Field Management). You can manually assign custom fields to users and assets in the Location Results page. In the Locate page, the custom fields appear under the category Custom Fields and can be used in other queries.

Creating a Dynamic Field

You can create queries and save the queries as user-defined fields. These new Fields are called Dynamic Fields.

If you need to write complex queries, dynamic fields can help save time and reduce errors.

When building queries, you can use the Dynamic Fields as you would use any of the default Fields.

To create a Dynamic Field:

1. Follow the steps to Create a query.

2. In the Locate a Current page, click the Add Dynamic Field icon in the lower right.

   

3. The Add Dynamic Field dialog page appears:

   

4. In the Add Dynamic Field dialog page, enter the following:

   • Field Name. Enter a name for the Dynamic Field. This name will appear in the list of fields when you build a query.

   • Field Type. Select Text or Number. This field determines the Operators and Values Lucidum will associate with the new Field.

   • Query Has Result. If an asset or user meets the requirements of the dynamic field, specify a value to be returned. For example, “Yes” or “1” or “True”.

   • Query has no result. If an asset or user does not meet the requirements of the dynamic field, specify a value to be returned. For example “No” or “0” or “False”.

   • Confirm. Click to save the new Dynamic Field.

5. The new dynamic field appears are a field in the query tool, under the category Dynamic Fields. You can now use the new dynamic field as an additional condition in a query.

   

Using a Dynamic Field in the Locate Page

After you create a dynamic field, you can see the field in the Locate page when creating a query.

To use a dynamic field:

1. Click Locate.

   

2. In the Locate a Current page, click on the Dynamic Fields category.

3. The right pane displays a list of dynamic fields you can use in your query.

Managing Dynamic Fields

In the Dynamic Field Management page (Settings > Dynamic Field Management), you can view, edit, and delete dynamic fields.

To manage dynamic fields:

1. Go to Settings > Dynamic Field Management.

2. The Dynamic Field Management page displays the following about each dynamic field:

   

   • Name. Name of the dynamic field.

   • View query (down-arrow). Displays the filters in the query.

   • Collection. Displays the the type of Lucidum object you can use with the dynamic field. Choices are:

     • Asset. Use with assets.

     • User. Use with users.

     • Asset-IP Mapping. Use with asset/IP pairs.

     • User-IP Mapping. Use with user/IP pairs.

     • Vulnerability. Use with vulnerabilities.

   • Type. Data type for the dynamic field. Choices are

     • Text

     • Number

   • Query. Number of filters in the dynamic field. You can use the down-arrow to view the filters in each dynamic field.

   • Table Rule. Number of options for Query Has Result and Query No Result.

3. To edit a dynamic field, select its Edit Dynamic Field (pencil) icon. In the Edit Dynamic Field modal, you can edit the fields Field Name, Field Type, Query Has Results, and Query Has No Results. You can also edit the filter associated with the dynamic field.

4. To delete a dynamic field, select its Delete Dynamic Field (trash can) icon.

5. To export a dynamic field, select its row and click Export. The dynamic field is saved on your local computer as a JSON file.

6. To import a dynamic field, click Import and navigate to the JSON file you want to import.

Example Dynamic Field

You could define the following security requirements for each user workstation in your organization:

• Managed in Active Directory

• Endpoint protection is installed

• Hard drive is encrypted

1. You could write a query like this:

   

    

2. You could then save the query as a Dynamic Field named “secure_workstation”:

   

    

   • For workstations that meet the custom security requirements, the value of “secure_workstation” field will be “1”.

   • For workstations that do not meet the custom security requirements, the value of “secure_workstation” field will be “0”.

3. The new Dynamic Field appears in Dynamic Field Management page (Settings > Dynamic Field Management).

   

4. The new dynamic field appears in the query tool, under the category Dynamic Fields. You can now use the new dynamic field as an additional condition in a query.

5. To use the new dynamic field in a query, click Locate.

   

6. In the Locate a Current Asset page, the new dynamic field secure_workstation appears under the Dynamic Fields category.

Creating a Custom Field

Custom fields are tags that you can create and assign to assets and users. Custom fields help you sort and manage assets and users.

Custom fields can be created in the Custom Field Management page (Settings > Custom Field Management), appear as fields in the Locate page, and can be assigned to assets in the Locations Results page.

To create a custom field:

1. Navigate to the Custom Field Management page (Settings > Custom Field Management).

2. Click the Add Custom Field (plus-sign) icon in the upper right.

3. The Create Custom Field modal page appears:

   

4. Enter values in the fields:

   • Field Name. Name of the new custom field.

   • Table Name. Select from Asset or User. This field specifies which type of queries will display the custom field in the list of fields.

   • Field Type. Select from List, Number, String, or Time.

5. Click Confirm.

6. The new Custom Field appears in Custom Field Management page (Settings > Custom Field Management).

7. The new Custom Field appears in the Locate tool, under the category Customer Fields. You can now use the new Custom Field as an additional condition in a query.

Assigning a Custom Field

To assign a custom field to an asset or user:

1. Create a query to find the assets or users you want to tag. For details, follow the steps to Create a query.

2. Click Show Results.

   

3. In the Location Results page, select the assets or users you want to tag with a custom field.

4. Click the Add a Custom Field Value (wrench) icon.

   

5. In the Add Custom Field Value modal page:

   • Custom Field. Select from the list of custom fields.

   • Custom Value. Enter the value for the custom field.

6. Click Confirm.

7. The custom field is now applied to the selected assets or users. You can use the custom field to search for the assets or users in the Locate page.

Using a Custom Field in a Query

After you have assign a custom field to users or assets, you can use that field as a filter when creating queries.

To do this:

1. Click Locate.

   

2. In the Locate a Current page, click on the Customer Fields category.

3. The right pane displays a list of custom fields you can use in your query.

Managing Custom Fields

In the Custom Field Management page (Settings > Custom Field Management), you can view, edit, and delete dynamic fields.

To manage dynamic fields:

1. Go to Settings > Custom Field Management.

2. The Custom Field Management page displays the following about each custom field:

   

   • Field Name. Name of the custom field.

   • Table Name. Displays the the type of Lucidum object you can use with the custom field. Choices are:

     • Asset. Use with assets.

     • User. Use with users.

     • Asset-IP Mapping. Use with asset/IP pairs.

     • User-IP Mapping. Use with user/IP pairs.

     • Vulnerability. Use with vulnerabilities.

   • Type. Data type for the custom field. Choices are List, Number, String, or Time.

3. To edit a custom field, select its Edit Custom Field (pencil) icon. In the Edit Custom Field modal, you can edit the fields Field Name, Table Name, and Field Type

4. To delete a dynamic field, select its Delete Custom Field (trash can) icon.

Example Custom Field

You could define a tag for assets in your organization that include PII, so you can prioritize the security of those assets. You could name the custom field “Has PII”.

To create a custom field:

1. Navigate to the Custom Field Management page (Settings > Custom Field Management).

2. Click the Add Custom Field (plus-sign) icon in the upper right.

3. The Create Custom Field modal page appears:

   

4. Enter values in the fields:

   • Field Name. Name of the new custom field. In our example, this is “Has PII”.

   • Table Name. Select from Asset or User. This field specifies which type of queries will display the custom field in the list of fields. We chose “Asset”.

   • Field Type. Select from List, Number, String, or Time. In our example, we chose “String”

5. Click Confirm.

6. The new Custom Field appears in Custom Field Management page (Settings > Custom Field Management).

   

7. The new Custom Field appears in the Locate tool, under the category Customer Fields. You can now use the new Custom Field as an additional condition in a query.

   

8. To assign a custom field to an asset, create a query to find the assets or users you want to tag. For details, follow the steps to Create a query. In our example, we will tag all assets where Department matches HR.

9. Click Show Results.

   

10. In the Location Results page, select the assets or users you want to tag with a custom field.

11. Click the Add a Custom Field Value (wrench) icon.

    

12. In the Add Custom Field Value modal page:

    • Custom Field. Select from the list of custom fields. We chose “Has PII”

    • Custom Value. Enter the value for the custom field. We assigned the value “Yes”

13. Click Confirm.

14. We can now use the Locate pages to search for this asset by its custom field:

    

15. The query results display the asset that we tagged with the custom field: