Defining Custom Execution Modes

For more information about resource-based capacity scheduling, see Scenario Execution and Job Scheduling.

Limiting the Resources Allocated to a Job

The execresourcegroup annotation specifies an execution resource group, which determines the number of threads and the amount of memory that the model should consume. A job using this execution mode is only scheduled on an execution worker that has the specified resources available; otherwise, the job is queued.

If a thread capacity or memory capacity are configured for the execution worker and the execution service mapping on the ADMIN > Execution Services page, the minimum of both are available to the job being executed. Note that multiple execution services can map to the same worker.

The execution resource group specified by an execution mode specifies default resources (threads and memory) for the execution mode. However, these defaults can be overridden by an administrator. Your model can query the actual resources available at run time; for more information, see Querying Runtime Resources.

If you do not specify an execution resource group for the execution mode, the DEFAULT resource group is used. This resource group specifies 1 thread and no memory limit.

For more information about execution resource groups, see Defining Custom Execution Resource Groups.

Calling a Custom Execution Mode

Custom Execution Load and Run Modes cannot be triggered from the Scenario pill menu; they require an extra button in the Xpress Insight user interface.

Code Snippet

uses "mminsight"

!@insight.manage=input
public declarations
  !@insight.alias Years
  Years: range 
  !@insight.alias Cities
  Cities: set of string  

  !@insight.alias Input array of integer
  InputArrInt: array(Years) of integer 

  !@insight.alias Input array of string
  !@insight.update.afterexecution=true
  ! Updated after model execution
  InputArrStr: array(Years) of string 
end-declarations

!@insight.manage=result
public declarations
  ResultArr: array(Years) of real 
end-declarations

Example Custom Run function

(!@insight.execmodes.CUSTOM_RUN.
  @descr Custom run execution mode.
  @clearinput false
!)
public procedure customrun
  writeln('CUSTOM_RUN mode...')
  ! Populate with Insight scenario data
  insightpopulate

  ! Calculate results
  forall(t in Years) ResultArr(t):=InputArrInt(t)*2.0
  ResultCol(2020):=999999
  StrCol(2018):= 'Updated after CUSTOM_RUN mode'
end-procedure