Checklists

With the help of Checklists, you can plan and estimate the scope of work, as well as to check if you covered all tests to the deadlines. You can use checklists as a database by adding descriptions, files and issues directly to the checklists.

Creating checklists in the Project data

To add new checklist to the project data:

  1. Open your project and add data to it;
  2. Right mouse click on the Object (IP, Hostname, or Port);

  3. In the drop-down menu select the option Add Checklist:

  4. Enter checklist Name and press Enter;

  5. To add child items, right mouse click on the new checklist item and in the drop-down menu select Add item child;
  6. Type item name and press Enter;
  7. Repeat these steps to add several checklist items. New checklist appears next to the object and in the Checklist tab.

In the Project data tab, you can also add ready checklists from the Checklist templates menu:

  • Project checklist - contains checklists that are already linked to other project Objects;

  • Knowledge base - contains a set of checklist templates that are stored in the platform knowledge base.

    Note: to add templates from Checklist templates menu, you should first create them in Checklist and Knowledge base tabs.

To open Checklist templates menu and add ready checklist template:

  1. Right mouse click on the Object (IP, Hostname, or Port);
  2. In the drop-down menu select the option Add Checklist:
  3. In the Checklist templates menu select needed checklist and click on + next to it;

  4. Click Add to checklist:

  5. New checklist appears next to the object and in the Checklist tab.

Click on a new checklist item to add Description, Assigned objects, or Issues.

To edit or delete checklist, right mouse click on the checklist item and in the drop-down menu select needed options.

Use Go to checklist option to view and edit your checklists in the Checklist tab.

Creating checklists in the Checklist tab

  1. Open your project and go to the Checklist tab;
  2. Click Add item;
  3. Enter checklist Name and press Enter;

  4. Right mouse click on new item and in the drop-down menu select Add item (After, Before, Child, or Parent).

    Notes: while creating checklists, use the following hot keys:

    • Enter to add new checklist items (After and Before).
    • Tab or Shift+Tab to add child and parent items.

Additional options:

  • Turn on sync - enable this option and checklists will be synchronized with Apiary. This button is available only if there is a connection between two projects.
  • Mark as inapplicable - enable this option to exclude this checklist from your audits.

Creating checklist templates in the Knowledge base

Checklist templates that are stored in the Knowledge base are available for all Platform projects.

To create a checklist template:

  1. Open your project and go to Checklist > Knowledge base tab;
  2. Enter the checklist Name;
  3. Enter checklist Name and press Enter;

  4. Right mouse click on new item and in the drop-down menu select Add item (After, Before, Child, or Parent).

    Notes: while creating checklists, use the following hot keys:

    • Enter to add new checklist items (After and Before).
    • Tab or Shift+Tab to add child and parent items.

  5. Click Save. New template will be added to the Knowledge Base and will be available for all Platform projects.

Add description, files and issues to the checklists

To add description:

  1. Click on checklist item:

  2. In the checklist menu on the right, click on next to Description:

  3. Add description, pictures and click on to save changes. After saving, an icon appears next to the checklist item;

  4. To add a vulnerability to the checklist, click Linked Issues and select one of the options:
  • Link existing - select issue in the list, and add it to the checklist using checkbox;
  • Create new - register a new vulnerability, and add it to the checklist using checkbox (see section Register issues;
  1. To switch between Description, Objects, Issues, click on the active links under the checklist name
  2. Click History to view the history of changes in the checklist.

Export and import checklist and checklist templates

You can import and export checklists in two formats:

  • in text format .txt;
  • in Markdown .md format.

To export checklist template in project and platform knowledge base:

  1. Go to the tabs Checklist and Knowledge base;
  2. In the Checklist tab click Checklist > Export;
  3. In the Knowledge base tab click Template > Export;
  4. In the Export templates window select one or several checklist templates;
  5. In the Filename field enter name of the file (optional) and select needed format.

Note: if the filename is not indicated, all exported checklists will be entitled as template_export.

To import a checklist into a project or platform knowledge base:

  1. Go to the Checklist or Knowledge base tabs;
  2. To import a checklist from a text file .TXT:
  • In the Checklist tab click Checklist > Import from file;
  • In the Knowledge base tab click Template > Import from file;
  • In the Import template window, click Browse to upload a file or click Import text as file to enter text manually;
  • Click Import.
  1. To import a checklist from Markdown .MD:
  • In the Checklist page, select the menu Checklist > Import from MD;
  • In the Knowledge base page select the menu Template > Import from MD;
  • In the Add MD Checklist window, click Import from file or manually enter the checklist in Markdown;
  • In the Checklist starts with field, specify the characters with which the checklist begins (for example, - [ ]);
  • In the Number of spaces field, specify the number of spaces to preserve the nesting of the imported checklist (child items);
  • Click Save data.
  1. The new template will appear in the project or in the knowledge base, depending on where you imported it.

See also