Scorecards are one of the types of assets that are available in ProcessMix. A tool designed to calculate a final score based on the input parameters of certain characteristics for further decision-making.
To access them, you need to go to the Explorer panel in the Assets section. It contains a tree of all Assets in the project and existing Scorecards if they already exist.
The Assets tree in the Project Explorer panel may include the following:
Double-clicking on any Scorecard opens a tab with Scorecard builder.
To create a new Scorecard, select the Assets icon on the Project Explorer panel — left end panel. Now create a Scorecard by clicking on the icon on the Explorer panel and selecting New Scorecard.
To create an asset in a folder, you need to select the desired folder and after that click on the icon. In the pop-up window enter the Scorecard name and click the CREATE button.
The Scorecard’s name should be longer than 1 symbol and shorter than 100, it can contain the letters (Latin a-z A-Z), numbers 0-9, $, and an underscore. Beginning from a letter or underscore character. The name of the scorecard must be unique within the level where it is created (folders or tree root).
The scorecard data model is represented by a certain set of parameters, at the level of the scorecard asset itself, parameters are equated to characteristics. To start working with a scorecard, first of all, you need to create the parameters that will be used in the characteristics. Click on the icon in the parameter section.
To set the desired name for the property, click on its default name and enter a new one.
The Property’s name should be longer than 1 symbol and shorter than 255, it can contain letters (Latin a-z A-Z), numbers 0-9, $, and an underscore. Beginning from a letter or underscore character.
It is also necessary to set the correct data type, which will correspond to the values received by this property. To change the data type, click on the String (default type) to the right of the name, then a dropdown menu will open where you can select the required type, and all data types available for use in scorecards are displayed.
After creating a scorecard, the corresponding structure is automatically generated, which can be found in the auto-generated structures in the Structures section of the Explorer panel. The structure is editable.
After changing the composition of the parameters or changing their type, the same changes are applied to the auto-generated structure.
It is possible to change the use of an auto-generated structure in the scorecard to another one in the Structure drop-down list at the top of the Parameters section in the scorecard builder.
After cloning a scorecard, it will refer to the same structure as the main scorecard. You can change the structure used if necessary.
Select a parameter in the Scorecard settings section. By clicking the right mouse button, a context menu opens through which a number of operations are available.
Let’s see what operations are possible:
Let’s now go through the possible scorecard configuration options before moving on to creating the scorecard logic itself.
Multiplier — a multiplier that is applied to the final score of the entire scorecard, it can be negative. The default value is 1. The multiplier can be an integer or a float.
Initial score — this is the initial score to which the scores of triggered feature bins will be added, it can be negative. The default value is 0. The Initial score can be an integer or a float.
Use reason code — the enabled option “Use reason code” allows returning not only the Partial score but also the corresponding reason code and reason message containing the reason for assigning a particular score. When this option is enabled, the Reason Code column is added to the scorecard bins. When activating this setting, you need to select a Dictionary, Reason code type, which contains the necessary data. The default value is false.
Codes count limit (only when Use reason code is active) — The value entered sets the maximum number of reason codes that can be returned. The minimum is 1, the maximum is 100.
Return methods (only when Use reason code is active) — there are two options: Use Ranks, and Compute Distances.
If Calculate distances are active, the following settings are available:
Next steps after all the settings, let’s move on to creating the characteristics themselves and filling in their values.
After creating a scorecard, by default, there is a characteristic that is filled with default values (Data Structure: depends on an assigned parameter, Baseline Score:0, Min:0, Max:0, Description:” “;) and assigned a parameter that was created by the system. When adding new characteristics, if there are parameters not used in the characteristics of the scorecard, then they are assigned automatically. To change the required parameter in the characteristic, click on it and select the one you need.
Assigning a parameter to a characteristic is mandatory.
When assigning a parameter, you can select only those that were not previously used in the characteristics, to select an already used one, you must either delete the characteristic where it is used or reassign another parameter.
In the settings of the characteristics, the following are available for editing: Baseline score and Description. All other values are calculated automatically by the system.
Select a characteristic on the Scorecard. By clicking the right mouse button, a context menu opens through which a number of operations are available.
Let’s see what operations are possible:
To start working with bins, you need to expand the characteristic. With each characteristic, a bin called All Others is created by default. To add a new Bin, simply click the appropriate button next to the Bin.
There cannot be two bins with the same name within the same characteristic.
An All Other bin is automatically created for each characteristic. It is a universal bin that contains characteristic values if they do not correspond to any of the bins created in manual mode. By default, the Partial score of this bin is 0, the Unexpected: checked (true).
A Bin is created with the following parameters:
There cannot be two bins with the same conditions within the same characteristic. If the conditions intersect, then this will also cause an error.
The user can change the order of Bins by dragging them to the right place within the same characteristic.
The Range field consists of two parts: a condition statement and a value. Depending on the data type set for the characteristic, the available condition statements are displayed in the drop-down list. They are used to write rules according to which the characteristic value belongs to a certain bin.
Possible operating conditions depending on data types:
|Integer||=, !=, > , <, <=, >=, <…<, <….<=, <=…<, <=…<=||=|
|Float||=, !=, > , <, <=, >=, <…<, <….<=, <=…<, <=…<=||=|
|Date||=, !=, > , <, <=, >=, <…<, <….<=, <=…<, <=…<=||=|
|String||=, !=, Contains, StartWith, EndWith, Regexp||=|
Select a bin on the Scorecard characteristic. By clicking the right mouse button, a context menu opens through which a number of operations are available.
Let’s see what operations are possible here:
Also you can use ‘null’ as a Range value.
aligned score = adjusted score * m + f,
m — Multiplier,
adjusted score — the total score obtained as a result of summing the scores for each characteristic,
aligned score — final score of the scorecard, adjusted by factor and multiplier,
f – factor = initial score.