Creating a score

Contents

Creating a score

Overview

Scores are described in the form of XML files. Currently, there is no graphical tool integrated into the product to create new scores. Instead, use your favorite text editor or specialized XML editor to define a new score and import it into the solution.

Contact Nexthink Customer Success Services to help you build your own scores or fine-tune the available scores to suit your needs. Check the library for the latest published packs that include scores.

Score definitions

A score definition holds the detailed description of either one composite score or one leaf score in a single XML file. Note however that a composite score usually comprises several subscores. Therefore, in practice, XML files that hold the definition of a composite score contain in fact the definition of all the subscores on which the main composite score depends.

Procedure

To write a new score or update an existing score:

  1. Open the Nexthink Scores Creator tool from your web browser:
    • If you want to write a new score, click the button Start a new score at the top of the window.
    • If you want to modify an existing score, click the button Load score... and choose the XML file to upload.
  2. Optional: Click Settings to configure the Web API settings of a reachable Engine.
    1. Engine IP: Type in the address of the engine.
    2. Port: Type in the port number of the Web API in the Engine.
    3. Version: Select the product version to generate a compatible score definition.
    The Engine settings let you test the scope and NXQL queries used in your scores thanks to the buttons:
    • PREVIEW SCOPE
    • PREVIEW QUERY.
  3. Fill in the forms for the main score and the subscores.
  4. Click Save score... to save your score as an XML file.
    • If any error is detected in your score, a warning message shows up before saving the file.


Alternatively, if you are fluent in XML or want to make a quick local change to one of your scores from your computer:

  1. Open your favorite text editor or specialized XML editor.
  2. Write the definition of the score in an XML file, according to the XML schema of scores.
  3. Save the XML file.

Once you have the XML file with the contents of your score:

  1. Open the Finder as a user with the right to edit scores (the profile of the user must allow system configuration).
  2. Select the Scores section on the left-hand side panel of the main window.
  3. Right-click the header of the Scores section or the empty area below it.
  4. Select Import > Scores from file... from the menu.
  5. In the dialog, choose the XML file that holds the definition of your score.
  6. Click Open to import the score.

Limit on the number of scores

There are two limiting factors that put a constraint in the maximum number of scores that can be defined:

  • Storage: 150 scores in total (either composite or leaf scores, including subscores in the count).
  • Computation power: 50 leaf scores of the Computation input type. Be careful if you use complex NXQL queries with except, union, or intersect in leaf scores, since they might sensibly increase the computation power needed.

If you need to go over these limits, contact Nexthink Customer Success Services for an evaluation of your setup and a configuration customization.

The operations described in this article should only be performed by a Nexthink Engineer or a Nexthink Certified Partner.

If you need help or assistance, please contact your Nexthink Certified Partner.