Topic
This article provides a high-level overview of the steps required to set up and use custom fields in NinjaOne.
Environment
NinjaOne Custom Fields
Description
NinjaOne utilizes custom fields throughout the platform to enhance endpoint management and facilitate knowledge sharing. To use custom fields, you must complete the following steps:
- Enable the NinjaOne Documentation application. This allows you to create documentation templates built from your choice of custom fields. To learn more about NinjaOne Documentation, refer to NinjaOne Documentation Tool Configuration.
- Create a custom field. Refer to the following table to determine what kind of custom field you would like to add. For the full configuration guide, refer to NinjaOne Custom Fields: Getting Started with Setup.
| 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 |
- Map the custom field to a device role, end user, or organization.
- Map a custom field to a device role at Administration → Devices → Roles. For a comprehensive set of instructions, refer to Mapping Custom Fields to Device Roles.
- Map a custom field to an end user from Administration → Accounts → End user custom fields. Click Edit custom tabs.
- Map a custom field to an organization or location at Administration → Organizations → Organization custom fields or Location custom fields. Click Edit custom tabs. For a comprehensive set of instructions, refer to NinjaOne Custom Fields: Mapping Custom Fields to the Organization Dashboard.
- Add data to your mapped custom fields. For more information, refer to NinjaOne Custom Fields: View and Modify.
- For custom fields mapped to device roles, navigate to the Device Dashboard and open the Custom tab.
- For custom fields mapped to end users, navigate to the End user Dashboard and select an end user. Open the Custom tab.
- For custom fields mapped to organizations or locations, navigate to the Organization Dashboard and open the Custom tab.
- Use custom fields in a script. For the full configuration guide, refer to Reading from or Writing to Custom Fields in Scripts.
- To create a new custom script that pushes information to custom fields, navigate to Administration → Library → Automation → Add automation → New script.
- Use
Ctrl + Spaceon your keyboard to access all snippets or type "get" or "set" for custom field commands.
Additional Resources
Refer to NinjaOne Custom Fields: Resource Catalog to learn more about using custom fields in NinjaOne.