Already a NinjaOne customer? Log in to view more guides and the latest updates.

NinjaOne Documentation: Apps & Services

Topic

This article describes how to use the Apps & Services tool in NinjaOne's Documentation feature. 

Environment

NinjaOne Documentation

Description

The Apps & Services tool empowers you to manage documents for each of your organizations. Use this tool to create and manage templates and add or view documents on the organization dashboard. 

Want to learn more about NinjaOne Documentation? Check out our video library.

Select a category to learn more:

Create a Document Template

Before you can start adding documents to the Apps & Services tab on the organization dashboard, you must create a document template on the NinjaOne Documentation configuration page. Templates can contain specific custom fields for technicians to fill out, or can act as a folder for uploading files.

  1. Navigate to AdministrationAppsInstalledNinjaOne Documentation. The Documentation tab will be open by default. 
  2. Click Manage Templates

documentation_manage templates.png
Figure 1: Documentation configuration app → Manage templates (click to enlarge)

  1. Select Add Template
  2. Use the tabs in the configuration dialog to modify settings. If you need a description of these settings, refer to the table in the following section. 
  3. Click Create.

Template Configurations

When creating or reading documents on an organization's dashboard, you may notice different document icons or options. This section provides examples of the template configurations. 

Custom Field OptionDescription or Example
List of pages = yesYou can add multiple documents to this template. Identify these templates in an organization by the icon to the left of the template name (there will be a folder icon instead of a paper icon). If you select this option, a new checkbox appears, allowing you to show the description in the table view. 
List of pages = noThis template acts as a single document. Identify these templates in an organization by the icon to the left of the template name (there will be a paper icon instead of a folder icon).
RequiredThe template shows an icon and a Required tag, and the data is mandatory. 
UI ElementsUI elements add a title, description, or separator (line break) to a document template. You can add as many as you need to customize your template.
Details

When you add a custom field to a template, you can use the Details tab to configure the following: 

  • Tooltip: A tooltip allows you to add a tip or helpful information that the user can see when they move their cursor over the (i) icon.
  • Footer: A footer allows you to add extra information to the bottom of a custom field.
  • Description: Add a summary of how to use the custom field.
After you create a template, click the name to edit it. Move your mouse cursor over the field and click the actions menu to see options for copying, downloading, or archiving the template. 

document template_actions.png
Figure 2: Documentation configuration app → Template actions (click to enlarge)

How to Use the Apps & Services Tab

Use the DocumentationApps & Services tab to manage your document templates. To learn about adding documentation via the WYSIWYG field or uploading files, refer to NinjaOne Documentation: Knowledge Base Feature.

Navigate the Apps & Services Menu

Use the following table with Figure 3 to learn about the icons and menu options in Apps & Services.

NumberPurpose or Definition
1Change the size of the Apps & Services sidebar. Place your cursor over the area, and then click and drag to the left or right.
2View archived or incomplete documentation. Archived documentation will show a bin icon next to the template name.
3Search for a template by name.
4This number indicates how many documents are uploaded to the List of Pages template.
5This icon indicates that the item is required and incomplete.
6These icons identify the template type.
apps and services_navigation 1.png
Figure 3: Navigate the Apps & Services tab (click to enlarge)

Add a Document (List of Pages)

A List of Pages template acts as a folder where technicians can upload multiple documents. To add a document to a List of Pages template, perform the following steps.

  1. Navigate to an organization from the system dashboard; open the Documentation drop-down menu and select Apps & Services.

org dashboard_documentation_apps and services.png

Figure 4: Access the Apps & Services documentation (click to enlarge)

  1. Select one of the templates in the Apps & Services sidebar.
  2. Click Add document.

org dashboard_documentation_apps and services_add.png
Figure 5: Add new list of pages Apps & Services documentation (click to enlarge)

The page updates to display the custom fields configured for that template. 

  1. Fill out the information and then click Create.

org dashboard_documentation_apps and services_create button.png

Figure 6: Add new Apps & Services documentation → Create (click to enlarge)

Your document displays in the template folder. Click the title to edit the fields, or move your cursor over the row and click the actions menu to see more options. With list of pages templates, you can click Add document to create multiple documents. 

list of pages_actions.png
Figure 7: Apps & Services documentation actions (click to enlarge)

Add a Document to an Organization Dashboard (Single Page)

To add a single-page document, perform the following steps.

  1. Select a template that does not have the list of pages option and then click the edit icon. 

not a list of pages_edit.png
Figure 8: Add new Apps & Services documentation (click to enlarge)

  1. Fill out the information and then click Create.

Your data will display on the page. To change the data, click the edit icon again. You can view additional actions by clicking the actions menu.

not a list of pages_actions.png
Figure 9: Actions for Apps & Services documentation (click to enlarge)

Manage List of Pages Documents

After you add a document to a List of Pages template, you can perform several actions, as described in the following table and Figure 10.

NumberPurpose or Description
1Edit the template
2Hide or display archived content.
3Manage the data table. Move your cursor over the icons to view their purpose.
4Edit, export, or archive the document. Move your cursor over the row and click the ellipsis icon to select the applicable option.
apps and services_list of pages navigation.png
Figure 10: Manage your List of Pages documents

Manage Single Page Documents

After you add a document to a List of Pages template, you can perform several actions, as described in the following table and Figure 11.

NumberPurpose or Description
1Save the document to your Favorites list. To remove from your Favorites list, click the icon again.
2Depending on the custom field type, you can click the data to navigate to the applicable device or organization dashboard.
3Add or view related items. For more information, refer to NinjaOne Documentation: Device Notes and Related Items.
4Condense or expand the data that is displayed.
5Edit or add data to the document.
6Export the document, view version history, edit the template, or archive the document.
apps and services_single page navigation.png
Figure 11: Manage your single page documents

Add a Document to Favorites

To save a document, perform the following steps. To learn more about Favorites, refer to NinjaOne Platform: Viewing Recent and Favorited or Saved Content.

  1. Navigate to the OrganizationDocumentation; select a document type and open the document. 
  2. Click the star next to the document title.

The star turns yellow, and the document appears in the Favorites drop-down menu on the sidebar menu.

save as favorite.png
Figure 12: Save document as a favorite (click to enlarge)

You can remove an article from the Favorites section either by deselecting the star in the article or by clicking the X icon when moving your cursor over the article title in the Favorites section.

Additional Resources

Refer to the following resources to learn more about NinjaOne Documentation:

FAQ

Next Steps