Calculation Logic

Owned by Dominik Lindenberger
Last updated: Aug 02, 2023 by Alberto Gruarin (Unlicensed)
8 min read

Overview

AMPI offers two main concepts for doing calculations: Scores and Blackboxes. Blackboxes are meant to evaluate one or several part Properties. That means a blackbox looks at the value of one property (can also be several properties if they are correlated) and decides whether that value is rather good (for AM) or rather bad (for AM).
Scores are meant to evaluate one or several Blackboxes, to produce an overall assessment of a part’s characteristics. Through reports and charts, the score results can then be shown to users.

The following example illustrates a typical setup:

Blackboxes and Scores are written in Javascript. For making adjustments to the calculation logic, it is helpful to have some prior exposure to any kind of scriptwriting or programming

Blackboxes

Defining blackboxes

Blackboxes are defined in the admin panel under

Home › B3_Ampi › Blackboxes

When defining blackboxes, the following fields are available.

Name
The name of the blackbox

Description
Additional description for the blackbox. Currently not displayed anywhere.

Script
The core of the blackbox is a script written in Javascript

Slug
Unique identifier of that blackbox. Used to reference this blackbox from a score.

Writing blackbox scripts

A blackbox can be considered a function that returns a value or an object.

Blackboxes can access a part’s property values through the property’s Variable namespace and Variable name:

variables.<Variable namespace>.<Variable name>

Variable namespace and Variable name are configured on the property itself.

By convention, blackboxes used for tech and econ scores have a return value between 0..1 representing a percentage between 0-100%.

Example:

A blackbox assessing the integer property Lead time (days)

// Lead time intervals const intervals = [8, 60] // Reading lead time from the property const leadTime = variables.custom.leadTimeExact if (leadTime === null) return null return mapInterval(leadTime, intervals[0], intervals[1])

 

Example:

A blackbox assessing the boolean property Qualification needed

const propertyValue = variables.custom.qualificationNeeded switch (propertyValue) { case true: return 0.35 case false: return 1.0 default: return null }

 

Scores

Scores can aggregate blackbox results into an overall result

Defining scores

Scores are defined in the admin panel under

Home › B3_Ampi › Scores

When defining scores, the following fields are available.

Name
Assign a meaningful name to the score to recognize it during the whole process of the platform configuration. This field is not displayed in the UI.

Description
Additional description for the score. This field is not displayed in the UI.

Script
The core of the score is a script written in Javascript

Slug
Unique (alphanumeric) identifier of the score. It is used as part of the column name in the CSV export functionality.

Filterable
If selected, this score will be available for filtering on the part list. Should only be enabled for numerical scores. Only scores marked as filterable will be included in the CSV export functionality.

Unit of measurement

Append a unit to the score results. This field is used only for non monetary values (e.g. kg, days, etc.); for monetary values, use the field `Is currency`.

FE Multiplier

Used to multiple the score results to the defined factor and visualize the multiplied value in the UI (e.g. multiply by 100 to transform into % a score that is calculated between 0 and 1). The score results is not multiplied in the database nor in the CSV export functionality.

Decimal places

Choose how many digits will be displayed in the UI after the comma for the score results (valid for scores of `Type` numeric).

Is currency

Select this option for monetary scores. When selected, the results are automatically formatted and displayed in the UI as currency, accordingly to the international rules.

This field overwrites the `Unit of measurement`, `FE Multiplier` and `Decimal places`.

Type

Define how to display in the UI the score results, as a text or a number. When text is selected, `Unit of measurement`, `FE Multiplier`, `Decimal places` and `Is currency` are ignored.

Schema

Specify how to render the score results into a specific type of card (i.e. report chart). Options include a table, a list and KPI card.

For reference: Reports and Charts | Defining Charts

Writing score scripts

A score can be considered a function that returns an object with a result value. The result value can then be displayed in charts.

Example:

A basic calculated score

const calculated_result = 0.3 + 0.5 return { result: calculated_result, }

All blackboxes are calculated before calculating scores. Within scores scripts, blackbox results are accessible through the results variable. Hence scores can access blackbox results through the results variable and the corresponding blackbox slug.

Example:

A score script retrieving the result of the BbEconLeadTimeExact blackbox

Tech and Econ scores

Tech and Econ scores are numerical scores that calculate the technical and economic suitability of a part within a range of [0, 1]. Values towards 0 indicate poor suitability, values towards 1 indicate good suitability for AM.

The general setup of Tech and Econ scores in AMPI is the calculation of the Weighted Average (Wikipedia). In the weighted average score calculation, we calculate the average of the results of individual blackboxes and give a weight according to their importance or impact on the overall score.

The weights of the blackbox can be adjusted to indicate how much impact an individual blackbox should have on the score. By convention, the weights are between 0..1. Values towards 0 indicate low impact, values towards 1 indicate a strong impact on the score result.

For a complete example of an econ score, see the Appendix

Text scores

The result of text scores is a String (text) - as opposed to numerical scores that produce numerical results. They can be used in charts with the type Text.

Text scores need to return an object with two variables

  • result - contains the results string, can be markdown formatted

  • type - variable with the value 'text'

Example:

A simple text score

For a more comprehensive example see the Appendix.

Helper functions

Helper functions are functions that are often used throughout multiple blackboxes or scores. To avoid defining such functions in each blackbox where it is used, they can just be defined once as a helper function. Then all blackboxes and scores can just use them without the need to define them redundantly.

Example helper function

For an example where a helper function is used, see the example blackbox for Lead time (days) above.

Helper functions can be defined in the admin panel under

Home › B3_Ampi › Helper functions

Note

Unlike scores or blackboxes, helper functions need to be defined as functions in the Script block. Helper functions cannot return anything outside of a function block, otherwise, they will fail.

How to debug blackboxes and scores

The results of blackbox and score calculations can be verified in several places in the admin panel

Show parts with errors in the calculation

  1. Go to Parts
    Home › B3_Ampi › Parts

  2. Use the filter option With errors

     

  3. Any part still visible in the list now has an error somewhere in the calculation

  4. Open the part details

  5. Scroll down to the blackbox results

  6. Check the list of blackboxes for those with an error

Overview of all calculation results for one particular part

To see all the score and blackbox results for one particular part, do the following

  1. Go to Parts
    Home › B3_Ampi › Parts

  2. Find the part that you are interested in and open the details

  3. Scroll down past the properties

You’ll reach a table with all score results for this part and a table with all blackbox results just below.

Verifying the calculation results of one score or blackbox for one part

To see detailed results of a score or blackbox including all input variables for one particular part do the following:

  1. Go to Parts
    Home › B3_Ampi › Parts

  2. Find the part that you are interested in and open the details

  3. Open either Blackbox tester or Score tester

  4. From the list, select the score or blackbox you are interested in

Detailed score and blackbox results of the econ score.

Detailed input used in the blackbox and score calculations

Triggering recalculation

For performance reasons and to reduce server load, blackbox and score results are only calculated once and then stored for repeated use. If a blackbox or score script is changed, you need to manually trigger a re-calculation of blackbox and score results. It is sufficient to trigger the recalculation once at the end of your editing actions.

The system triggers re-calculation automatically once a day, so that changes are reflected in scores latest after 24 hours - even if no manual recalculation was triggered.

To trigger a recalculation manually, you can just follow these simple steps:

  1. In any formula perform a zero impact change, e.g.

    1. add a space at the end of a line

    2. add an empty new line

  2. Save your changes

  3. Click Recalculate on the recalculation banner.

Appendix

Example

Full econ score script

 

Example

Text score for complexity