Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

A Model Class is the central configuration point of the Optimization module. It defines the structure and the look and behavior of Model Objects. The user workflow consist of sequence of Steps. In each Step, the user can run a Calculation and then explore and evaluate the results on multiple Tabs.The Model Class definition is stored in a table with type code MC which has following fields:

Fields

  • uniqueName* – Unique name of the Model Class. It is used in Model Object to reference the Model Class they instantiate. Note that you can modify the uniqueName, but the references will not be updated automatically.

  • label – Human readable name of the Model Class, displayed to the users, when they select which Model Class they want to use for creating a new Model Object.

  • definition – Defines how the Model Class instances will look and behave. It stores definitions of Calculations, Steps and Evaluations in a JSON text format.

  • workflowFormulaName – Name of the workflow logic (with workflowType = “model”) which is responsible for building the approval workflow steps when the user clicks Submit. If not set, then the workflow feature is disabled for those Model Objects.

Definition

Model Class Definition defines how the Model Class instances will look and behave.

In a Model Class, the definition field contains a JSON document that has main root elements: calculations, steps, evaluations, actions, tasks.

...