Ninja’s Feature Update Saves You Hours of Documentation

by Peter Bretton, VP, Product Strategy
Ninja's Feature Update Saves You Hours of Documentation
Ninja's Feature Update Saves You Hours of Documentation

Try our #1 rated endpoint management platform on G2

NinjaOne dashboard screenshot

Automate the Hardest Parts of IT

Key Points

  • NinjaOne allows scripts that can write organization-level custom fields, increasing the scope of automated IT documentation.
  • Automated documentation can capture license keys, tenant IDs, and application configurations without manual entry.
  • Extracted data can then power scripts, monitoring, and software deployment across the organization.

Since the addition of custom fields to NinjaOne, we’ve had the ability to read from and write to device-level custom fields via scripts and the terminal. Organization-level custom fields (available in NinjaOne Documentation®) have always been readable via scripts, but until now, they have not been writable.

With the NinjaOne 5.3.5 release, we’ve added the ability to write to organization-level custom fields via scripts or the terminal for automatic documentation.

Save yourself hours of manual documentation and automate IT documentation

Frequently, some data would be useful for scripting across all or many endpoints in an organization. This information can be collected and added to NinjaOne manually, but allowing organization-level custom fields to be written via script allows for almost unlimited possibilities for automated documentation.

A few real-world use cases for writing to organization custom fields include:

  • Extracting license keys from existing endpoint setups and documenting those license keys automatically.
  • Extracting and documenting tenant IDs for applications like Azure, Printix, Keeper, and other multi-tenant solutions.
  • Extracting and documenting application, tool, and hardware configurations as an XML, YAML, or JSON blob from the endpoint.

The most critical benefit of this new feature is users’ ability to automate tasks like these and spare their team hours of manual documentation. For more advanced users, these extracted license keys, tenant IDs, and configurations can then be referenced in a script or used with conditions to monitor and alert on changes, deploy software, or automatically join a device to a tenant.

How to write to organization custom fields in NinjaOne

1. Appoint a delegate machine

Writing to organization custom fields requires the use of a delegate. This stops multiple devices from writing to an organization-level field simultaneously, which could cause unintended outcomes. Delegates can be set up in the Organizations tab under Documentation.

 

2. Setup your custom field

You’ll need an organization-level custom field to write to. These fields are set up as forms in the Documentation app. To write to a field via script or terminal, you’ll need to set the scripts field to ‘Write Only’ or ‘Read/Write’.

Setting read status for scripts

 

3. Write your script

This update added three new commands for scripting in NinjaOne:

  • Ninja-Property-Docs-Set DocumentName” $AttributeName
  • Ninja-Property-Docs-Set-Single “templateName” “fieldName” “new value”

To make this more real-world, let’s outline what it may look like to automatically document an Azure tenant ID with NinjaOne.

Let’s assume we’ve assigned our delegate and created the document below.

ad documentation example 1

 

Let’s write our script:

  • The Template ID / Name is “Active Directory”
  • The Document Name is “Tyrell Active Directory”
  • The Attribute Name is azureTenantID

 

$tenantId = (Get-AzureADTenantDetail).objectId

Ninja-Property-Docs-Set ‘Active Directory’ ‘Tyrell Active Directory’ azureTenantID $tenantId

4. Deploy your script

Finally, you need to deploy your script on the appropriate delegate endpoint. Once the script has been run, the script will write to the organization-level custom field and complete with success.

We then run this on our delegate machine to update the template.

ad documentation example 2

Want to see NinjaOne in action?

Manual documentation is one of those workflows that always loses to urgent work, leaving configurations, license keys, and tenant IDs unrecorded until the knowledge walks out the door with whoever holds it. Automated documentation fixes this at the source, capturing data from endpoints as it changes and keeping records current without anyone typing a word.

Watch a short free demo, or try these NinjaOne features out for yourself by signing up for a no-obligation free trial.

Related topics:

FAQs

You can automate IT documentation in NinjaOne by creating scripts that collect information from endpoints and write that data directly to organization-level custom fields. With NinjaOne Documentation®, scripts can automatically document license keys, tenant IDs, application configurations, and other organization-wide information, reducing manual documentation tasks and improving data accuracy.

Common examples include license keys, tenant IDs for multi-tenant apps like Azure or Keeper, and application or hardware configurations exported as XML, YAML, or JSON.

Yes. In addition to scripts, NinjaOne allows users to write directly to organization-level custom fields via the terminal. This gives technicians a quick way to update documentation without creating or deploying a script while maintaining centralized records.

To write to an organization-level custom field, the field must be configured within a documentation form, and the script permission must be set to either “Write Only” or “Read/Write.” Without the appropriate permissions, scripts can read data but cannot update organization-level documentation fields.

In NinjaOne, a device-level custom field stores data unique to an individual endpoint, such as hardware specs or local configurations. Organization-level custom fields store data that applies across an entire organization or client, such as license keys, tenant IDs, or shared application configurations.

You might also like

Ready to simplify the hardest parts of IT?

NinjaOne Terms & Conditions

By clicking the “I Accept” button below, you indicate your acceptance of the following legal terms as well as our Terms of Use:

  • Ownership Rights: NinjaOne owns and will continue to own all right, title, and interest in and to the script (including the copyright). NinjaOne is giving you a limited license to use the script in accordance with these legal terms.
  • Use Limitation: You may only use the script for your legitimate personal or internal business purposes, and you may not share the script with another party.
  • Republication Prohibition: Under no circumstances are you permitted to re-publish the script in any script library belonging to or under the control of any other software provider.
  • Warranty Disclaimer: The script is provided “as is” and “as available”, without warranty of any kind. NinjaOne makes no promise or guarantee that the script will be free from defects or that it will meet your specific needs or expectations.
  • Assumption of Risk: Your use of the script is at your own risk. You acknowledge that there are certain inherent risks in using the script, and you understand and assume each of those risks.
  • Waiver and Release: You will not hold NinjaOne responsible for any adverse or unintended consequences resulting from your use of the script, and you waive any legal or equitable rights or remedies you may have against NinjaOne relating to your use of the script.
  • EULA: If you are a NinjaOne customer, your use of the script is subject to the End User License Agreement applicable to you (EULA).