# Checklists management

Checklists let you visualize fields, such as device properties, custom fields and the output of remote actions within [Device View](/platform/user-guide/device-view.md) and [Amplify](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/configure-amplify.md).

Checklist visualization provides quick insights into critical parameters for analyzing issues related to the health and performance of a device.

## Granting permissions for checklists <a href="#checklistsmanagement-requiredpermissionsforchecklistspermissions" id="checklistsmanagement-requiredpermissionsforchecklistspermissions"></a>

Select **Administration >** [Roles](https://docs.nexthink.com/platform/user-guide/administration/account-management/roles) in the main menu to configure the role permission settings required by checklists.

Select the following permissions under the **Diagnostics** drop-down:

* **View all checklists** allows specific user roles to see all the checklists available in [Device View](/platform/user-guide/device-view.md) and [Amplify](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/configure-amplify.md).
  * Even if users do not have the **View all checklists** permission, they can still see specific checklists associated with their role.
  * Select **Specific checklists added to this role** to granularly manage or revoke permissions for specific custom checklists.
* **Manage all checklist** allows specific user roles to create, edit, delete and share all checklists.

If [associated actions](#adding-property-details-and-associated-actions), such as workflows, are available in the checklist, users only see the actions they have permission to execute manually.

Refer to the [Checklists](/platform/user-guide/device-view/checklists.md) documentation to learn how to run associated actions from checklists in Device View.

{% hint style="info" %}
Nexthink displays [rating indicators](/platform/user-guide/administration/content-management/ratings-management.md) only for checklist properties where a rating has been configured.
{% endhint %}

## Types of Checklists <a href="#checklistsmanagement-accessingthechecklists" id="checklistsmanagement-accessingthechecklists"></a>

From the **Administration > Checklists** page, Nexthink lists all available checklists. View the checklist **Origin**:

* Checklists **Installed from library:** a set of preconfigured checklists that you can manually install from Nexthink Library.
* Checklists **Copied from library:** checklists that you can copy from the Nexthink Library module. Modify the copied checklists to fit your needs.
  * Refer to the [Nexthink Library](https://docs.nexthink.com/platform/user-guide/nexthink-library) documentation for more information.
* **Custom** checklists: [checklists created](#checklistsmanagement-creatingchecklists) from scratch that are specific to your organization, user roles and relevant to target devices.

{% hint style="info" %}
Jump to the [Managing checklists](#checklistsmanagement-managingchecklists) section to **Edit**, **Edit tags**, **Share**, **Export,** or **Delete** existing checklists.
{% endhint %}

<figure><img src="/files/LHwZ7La9gFHT7Nl9AsjH" alt="Accessing checklists in the Nexthink web interface"><figcaption></figcaption></figure>

## **Creating checklists** <a href="#checklistsmanagement-creatingchecklists" id="checklistsmanagement-creatingchecklists"></a>

{% hint style="info" %}
Your user role must have [proper permissions](#checklistsmanagement-requiredpermissionsforchecklistspermissions) to create checklists.
{% endhint %}

To create checklists, from the **Administration > Checklists** page:

1. Click on the **New checklist** button in the top-right corner of the Checklist configuration page.
2. Fill out the fields on the Checklist configuration page:
   * You may select a specific OS by using the **Platform selection** drop-down to limit the visibility of checklists depending on the OS of the investigated device.
   * Enter a **Name** and **Description**.

Additionally, you can [import a JSON file](#checklistsmanagement-importingchecklists) to create a **Custom** checklist.

<figure><img src="/files/86NSWjQuY9M1ScdstSCt" alt="Checklist OS Platform Selection Dropdown" width="760"><figcaption></figcaption></figure>

### **Adding properties to a checklist**

To add properties to a checklist, from the Checklist configuration page:

1. **Add properties** by selecting the fields to add to the checklist.
2. Filter the **checklist properties** using the drop-down menu, or enter a specific property name into the search box.
3. Click **Done** to add the selected properties to the checklist.

Once you've added the properties, you can:

* Click and drag the property item to custom sort the properties in the checklist.
* Click the cancel icon, to remove the property from the checklist.

{% hint style="info" %}
Add up to 35 properties per checklist, including a maximum of 20 **Custom field** properties defined by **Computed** [custom fields](/platform/user-guide/administration/content-management/custom-fields-management.md).

Refer to the [Nexthink Infinity thresholds and limits overview](https://edocs.nexthink.com/nexthink-infinity/infinity-specifications/nexthink-infinity-default-thresholds-overview) documentation for more information.
{% endhint %}

<figure><img src="/files/JghDxcD7Nx9Zboofv6vu" alt="Properties popup in Checklist Edit page." width="760"><figcaption></figcaption></figure>

#### Formatting data for checklist properties added from custom fields

Adding checklist properties from [custom fields](/platform/user-guide/administration/content-management/custom-fields-management.md) defined by an NQL query that contains the `as()` function—for example `poor_quality_ratio.as( format = percent )` —allows the system to display checklist property values with units in the following data formats:

* `percent`
* `currency`
* `energy`
* `bitrate`
* `weight`

{% hint style="info" %}
Refer to the [NQL as()](https://docs.nexthink.com/platform/user-guide/nexthink-query-language-nql/nql-functions/nql-as) documentation to learn how to format data in NQL queries.
{% endhint %}

### **Grouping checklist properties**

To group property items in a checklist, from the Checklist configuration page:

1. Click the **Add group** button, and enter the name of the group.
2. Click **Add properties** under group.

After adding a group, you can:

* Click the up or down arrows next to the group name to reorder the groups.
* Delete a group and remove all associated properties of the group from the checklist.

<figure><img src="/files/rrwVM1RHofl8zXnknTBO" alt="Property groups for Checklists." width="760"><figcaption></figcaption></figure>

### **Adding property details and associated actions**

After [adding properties](#adding-properties) to a checklist, add the following property details:

1. Click over a property item to reveal the **Associated actions**, **Display name** and **Documentation** fields in the right-side panel.
2. Use the **Associated actions** field to indicate which [remote actions ](/platform/user-guide/remote-actions.md)or [workflows](/platform/user-guide/workflows.md) users can see in the checklist.
3. Add a custom **Display name** to show:
   * An understandable name of the property in [Amplify](/platform/configuring_nexthink/bringing-data-into-your-nexthink-instance/deploying-nexthink-in-non-vdi-environment/configure-amplify.md) and [Device View](/platform/user-guide/device-view.md) for all users.
   * A readable name of the property in Amplify and Device View that better fits the UI.
4. In the **Documentation** field, add custom text and links for the property:
   * The documentation can contain up to 1000 characters, including special characters and formatting characters.
   * To format the text, use the following syntax:
     * To highlight the content in bold, prefix the text with # followed by a space.
     * To add bullets, prefix the text with - followed by a space.
     * To add a hyperlink, add round brackets to the text that should be visible to the reader and add square brackets to the link: `(reference-text)[reference-link]`. Prefix all links with `http://` or `https://`.
5. **Save** the associated actions, display name and documentation for the properties.

<figure><img src="/files/5u7Lqul18YZbMO3tltR2" alt="ChecklistsManagement-1707387970.png" width="760"><figcaption></figcaption></figure>

Relevant considerations when adding property details:

* The **Documentation** field is compatible with markdown. You can use an external markdown editor to copy and paste the markdown-formatted content into the documentation section. The Nexthink web interface displays the supported, formatted content within the checklist container.
* Property details are checklist-specific—you can save different associated actions, the display name and documentation of the same property on a different checklist.
* If you delete a particular custom field or remote action that functions as a checklist property, the associated action, display name and documentation are automatically deleted.
* If you delete a checklist that contains properties with associated actions, display name and documentation, these property details are also deleted.

## Managing checklists <a href="#checklistsmanagement-managingchecklists" id="checklistsmanagement-managingchecklists"></a>

To manage checklists, from the **Administration > Checklists** page:

1. Hover over a checklist to reveal the action menu on the right side of the list.
2. You can **Edit**, **Manage tags**, **Share**, **Export,** or **Delete**.

<figure><img src="/files/ZqUEfs7kD1WuKV7cao9Y" alt="Managing checklists"><figcaption></figcaption></figure>

### Tagging checklists <a href="#checklistsmanagement-taggingchecklists" id="checklistsmanagement-taggingchecklists"></a>

Adding tags helps users filter and suggest checklists based on specific requirements.

Open the **Tags** right-side panel to:

* Search for a specific tag at the top of the panel.
* Select one or more tags to filter the checklists table.

To add one or more tags to checklists, from the **Administration > Checklists** page:

1. Hover over a checklist to display the action menu and choose **Manage tags**.
2. From the **Manage tags** pop-up you can:
   * Type in a new tag or choose an existing one to add it to the checklist.
   * Open the action menu of a specific tag item to **Delete tag** or change the tag color.
     * Deleting a tag only removes it from the checklist it is associated with.
3. Alternatively, select multiple checklists to **Manage tags** in bulks.

<figure><img src="/files/JHK7I8s2quwnHKp67e3V" alt="Managing tags in bulks."><figcaption></figcaption></figure>

### Sharing checklist permissions <a href="#checklistsmanagement-sharingchecklistpermissions" id="checklistsmanagement-sharingchecklistpermissions"></a>

To share checklist permissions, from the **Administration > Checklists** page:

1. Select **Share** from the action menu of the checklist.
2. Add the profile you wish to share the checklist with.
3. Select **View checklist** from the **Select permissions** drop-down menu.
4. Click **Grant permissions** to grant the selected profile permissions for the checklist.

<figure><img src="/files/3CZPC65qfS16XRictBHx" alt="Share checklist"><figcaption></figcaption></figure>

In the Share dashboard modal, find a list of profiles that the dashboard is shared with. To remove permissions for a specific profile:

* Hover over the permissions column of a profile to reveal the action menu.
* Click **Remove all permissions**.

### Exporting checklists <a href="#checklistsmanagement-exportingchecklists" id="checklistsmanagement-exportingchecklists"></a>

Export any checklist to a JSON file. Use exported checklists to [import](#checklistsmanagement-importingchecklists) them into another Nexthink instance.

To export checklists, from the **Administration > Checklists** page:

1. Select **Export** from the action menu of the checklist.
2. Find the JSON file in the downloads folder of your browser.

### Importing checklists <a href="#checklistsmanagement-importingchecklists" id="checklistsmanagement-importingchecklists"></a>

To import checklists—in JSON—from your local device:

1. Click the **Import** button in the top-right corner of the **Administration > Checklists** page.
2. **Choose** or **drag** multiple JSON files from your hard drive to import them into the system.

The imported checklist appears on the Checklists administration page.

{% hint style="info" %}
When importing checklists from another Nexthink instance, first import the associated actions, custom fields and ratings to ensure correct property matching.
{% endhint %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.nexthink.com/platform/user-guide/administration/content-management/checklists-management.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.