Topic
This guide provides instructions for creating and mapping device role, global, and end user custom fields. For instructions on viewing and editing custom fields on the dashboard, refer to Custom Fields: View and Modify.
Environment
- NinjaOne Documentation
- NinjaOne Endpoint Management
Description
Custom fields allow you to publish data about a user, endpoint, organization, or location in NinjaOne. You create the custom fields and then use those fields to populate the Custom tabs on the dashboards. Custom tabs can hold multiple "sub-tabs," and each sub-tab may use different custom fields depending on the type of information you want to share with your users.
For custom field use case examples, refer to Custom Field Use Cases.
There are several different types of custom fields. To learn how to map them to the display location, refer to NinjaOne Custom Fields: Mapping Custom Fields to the Organization Dashboard.
| Type | Setup Location | Display Location |
|---|---|---|
| Device | Administration → Devices → Device Custom Fields | Device dashboard → Custom |
| End user | Administration → Accounts → End User Custom Fields | End user dashboard → End user details → Custom |
| Organization | Administration → Organizations → Organization Custom Fields | Organization dashboard → Custom |
| Location | Administration → Organizations → Location Custom Fields | Organization dashboard → Custom |
Select a category to learn more:
- Configure Permissions for Custom Fields
- Create Custom Fields
- Mapping the Custom Fields
- Additional Resources
Some fields may vary depending on the type of custom field selected. For example, some fields may also include Advanced Settings.
If you are using the custom field with the "custom fields" condition, you must grant the Scripts value at least read-only access. For more information, refer to NinjaOne Policies: Condition Configuration.
Default Value Behavior
When creating custom fields, NinjaOne applies a default value only when a field is empty for a given entity, such as a device, end user, or organization. If you change this default value, it will only update the field for that given entity; you must update each field individually.
For example, if you use a checkbox
Configure Permissions for Custom Fields
System administrators have default access to create and edit custom fields. To grant permissions to a technician, open their account configuration page in NinjaOne (Administration → Accounts → Technicians or Technician Roles) and update the permission for "Device Administration" in the System section.
Create Custom Fields
To create a new custom field, perform the following steps:
- Refer to the table earlier in this article to determine what kind of custom field you would like to add. For this article, we will demonstrate how to add a device custom field. You can also use these instructions for end user, organization, and location custom fields.
- Click Add custom field and select Field.
Figure 1: Add a device custom field in NinjaOne
- In the modal, select the custom field type you will be adding and click Continue. For a list of all custom fields and how you can use them, refer to Custom Fields by Type and Functionality.
- The Label is the name or title of the custom field and will be displayed when viewing the field on the NinjaOne dashboard. The Name is for internal use.
- Select the checkbox labeled Custom field is required to make the custom field mandatory. A mandatory custom field means that if a technician edits the custom fields on the dashboard view, they must ensure this field has data before saving other changes.
- Select the checkbox labeled Add custom field to default tab if you want to automatically include the new custom field in a tab for the respective entity. As explained further in this article, you can create additional tabs through the mapping portion of this process.
- Click through each tab on the left of the configuration modal to set up technicians' permissions, inheritance settings, and more. Refer to the following table as a guide.
- In the Inheritance section, configure the inheritance settings for the Inheritance outcome field. This data will specify the other places where values can be configured for this field, which enables you to use the custom field "globally" if inheritance is enabled for device, end user, location, and organization.
- Open the Permissions section and use the following table to complete the fields.
| Field | Description |
|---|---|
| Automations | Choose from none, read-only, write-only, or read/write. Responsible for defining access to this field through scripts. Scripts cannot update fields whose definition scope is not set to "device." |
| API | Choose from none, read-only, write-only, or read/write. |
| Technician access | Make this field editable (technicians can update or insert data if they have access permitted for Device Administration in their account or role) or read-only. If set to "None," the field will not be visible. |
- Open the Details section and use the following table to complete the fields.
| Field | Description |
|---|---|
| Description | Use to clarify the purpose. Currently, this field is only visible when editing the custom field in Administration. |
| Tooltip Text | Add text to assist those who are updating the custom field on the dashboard. This adds a small (i) icon next to the field name that technicians must move their cursor over to see the text. |
| Footer | Add text to assist those who are using the custom field on the dashboard. This adds small font text under the data field. |
| Advanced Settings | Some custom fields may have an Advanced Settings option. These settings change depending on the device type selected. |
- Click Submit when ready.
Figure 2: Custom field configuration tabs
After clicking Submit, a summary of your custom fields will display in NinjaOne.
The summary provides the field name, label, field type, creation date, and last update date. You can update or delete custom fields; refer to Custom Fields: View and Modify for more information.
Mapping the Custom Fields
After creating a device custom field, you can map it to a specific device role. For instructions, refer to Mapping Custom Fields to Device Roles.
To learn how to map custom fields to the organization dashboard, refer to NinjaOne Custom Fields: Mapping Custom Fields to the Organization Dashboard. These instructions work similarly for end user custom fields.
Additional Resources
Learn more about managing custom fields in our Custom Fields: Resource Catalog article.