Versions Compared

Key

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

...

  • 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.

  • moduleCategoryUN - – Defines which Module Category should display a list of Models which are based on this Model Class.

...

When you need to run recalculation of certain Steps or Calculations of a Model Object regularly, you can configure the a list of available actions which could be scheduled. The end - user can set up the regular a calculation schedule of those actions via UI page on the model object detail page. The scheduling can also be also done via SchedulesContext available via using the method schedulesContext() on the Model Context.

...

Each action has the following fields:

  • name* - Name of the action, unique in the Model Class.

  • label* - Description of the action, visible to the end - user on the model object Schedule page.

  • type* - What type of action is performed. Available options are:

    • steps - this – This action will perform calculations from a range of Steps. It can be performed only if the model is editable (i.e. not submitted/approved).

    • task - this – This action will perform a specified task.

  • fromStep - (Only for the type steps. Optional.) Name of a Step. When specified, the action will process Steps starting with this one. When not specified, the action will process Steps starting from the first one.

  • toStep - (Only for the type steps. Optional.) Name of a Step. When specified, the action will process Steps until, and including, this one. When not specified, the action will process Steps until, and including, the last one.

  • task* - (Only for type task.) Name of the task to be performed. The task must be defined within the same Model Class.

...

When you need to run calculations regularly by using an Action of the type task, the Task must be defined in the Model Class as follow.

...

Each task has the following fields:

  • name* - Name of the task, unique in the Model Class.

  • label* - Description of the task, visible to the end - user on the model object Schedule page.

  • type* - What type of task is performed. Available options are:

    • post-approval-calculation - for – For executing a Calculation after the Model Object has been approved. If the model is not yet approved, the task will be ignored.

  • calculation - (only Only for type post-approval-calculation.) Reference to the name of a Calculation defined in this Model Class.