Topic
This article describes how to use the Apps & Services tool in NinjaOne's Documentation feature.
Environment
NinjaOne Documentation
Description
Apps & Services lets you manage documents belonging to an organization. Use this tool to create and manage templates under Apps 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
- Add a Document to an Organization Dashboard (List of Pages)
- Add a Document to an Organization Dashboard (Single Page)
- Archived and Incomplete Documentation
- Add a Document to Favorites
- Additional Resources
Create a Document Template
Before you can start adding documents to the Apps & Services page on the organization dashboard, you must create a document template on the NinjaOne Documentation configuration page.
- Go to Administration → Apps → Installed → NinjaOne Documentation. The Documentation tab will be open by default.
- Click Manage Templates.
Figure 1: Documentation configuration app → Manage templates (click to enlarge)
- Select Add Template.
- Use the tabs on the left side of the configuration modal to modify settings. If you need a description of these settings, refer to the table in the Template Configurations section.
- Click Create.
Template Configurations
When creating or reading documents on an organization dashboard, you may notice different document icons or options. This section provides examples of the template configurations.
| Custom Field Option | Description/Example |
|---|---|
| List of pages = yes | You 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 = no | This template accepts only 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). |
| Required | The template shows an icon and a "Required" tag, and the data is mandatory. |
| UI Elements | UI 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:
|
Figure 2: Documentation configuration app → Template actions (click to enlarge)
Add a Document to an Organization Dashboard (List of Pages)
Use the Documentation → Apps & 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 to an organization from the system dashboard; open the Documentation drop-down menu and select Apps & Services.
Figure 3: Access the Apps & Services documentation (click to enlarge)
- Select one of the templates on the left side of the page.
- Click Add document on the right side of the page.
Figure 4: Add new "list of pages" Apps & Services documentation (click to enlarge)
The page updates to display the custom fields configured for that template.
- Fill out the information and then click Create in the top right corner of the page.
Figure 5: 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 ellipsis button to see more actions. With "list of pages" templates, you can click Add document in the top right corner to create multiple documents.
Figure 6: Apps & Services documentation actions (click to enlarge)
Add a Document to an Organization Dashboard (Single Page)
- Select a template that does not have the "list of pages" option and then click the pencil icon in the top right corner to add data.
Figure 7: Add new Apps & Services documentation (click to enlarge)
- Fill out the information and then click Create in the top right corner of the page.
Your data will display on the page. To change the data, click the pencil icon again. You can see additional actions by clicking the ellipsis icon in the top right corner.
Figure 8: Actions for Apps & Services documentation (click to enlarge)
Archived and Incomplete Documentation
On the left side of the page above the document search field, click the funnel icon to show or hide archived and incomplete documentation.
Figure 9: Apps & Services documentation → View archived and incomplete
- Incomplete documentation will show a "0" next to the template name.
- Archived documentation will show a bin icon next to the template name.
Figure 10: archived and incomplete documentation template (click to enlarge)
Add a Document to Favorites
- Navigate to the Organization → Documentation; select a document type and open the document.
- Click the star next to the document title.
The star turns yellow, and the document appears under the Favorites drop-down menu on the left navigation pane.
Figure 11: Save document as a favorite (click to enlarge)
This article can be removed from the favorites section either by deselecting the star in the article, or by clicking on the 'X' in the favorites bar when hovering over the article title.
Additional Resources
Refer to the following resources to learn more about NinjaOne Documentation: