A Model Class is used to describe how what a Model Object will look like in the UI, which logics it uses, what are their calculations, etc.
Fields
uniqueName* – name Name of the Model Class, used in Model Object to reference the Model Class they instantiate. It can be modified but the references won’t be updated automatically.
label – human Human readable name of the Model Class, displayed to the user, when they select which Model Class they want to use for creating a new Model Object.
definition – JSON definition of how what a Model Object using this Model Class should look like and how it should behave, see below.
Model Class Definition
In a Model Class, the definition field is a JSON document that contain 3 contains three main root elements: calculations, steps and evaluations.
...
A list of calculation as defined by the following fields.
Common Fields
name* – name Name of the calculation, unique in the Model Class.
type* – accepted Accepted values:
formula,sequence.
Formula Calculation Fields
formulaName* – the unique Unique name of an existing Formula of nature
model_calculation, see also Model Logics.
Sequence Calculation Fields
sequence* – a list List of calculation name names defined in this Model Class.
...
A list of steps as defined by the following fields.
Fields
name* – name Name of the step, unique in the Model Class.
label – human Human readable name of the step, shown in the UI, default it defaults to
nameif not specified.calculation – name Name of the calculation associated to this step, optional.
tabs – a list List of tabs as defined below.
...
A list of tabs as defined by the following fields.
Common Fields
name* – name Name of the tab, unique in the step.
label – human Human readable name of the tab, shown in the UI, default it defaults to
nameif not specified.type* – accepted Accepted values:
dashboard,configurator.
Dashboard Tab Fields
formulaName* – the unique Unique name of an existing Formula of nature
model_evaluation, see also Model Logics.
Configurator Tab Fields
formulaName* – the unique Unique name of an existing Formula of nature
model_evaluation, see also Model Logics.
...
A list of evaluations as defined by the following fields.
Fields
name* – name Name of the evaluation, unique in the Model Class.
formulaName* – the unique Unique name of an existing Formula of nature
model_evaluation, see also Model Logics.
...