Decision Optimization run parameters

Run parameters

Last updated: Nov 28, 2024

To control the run, you can specify Decision Optimization run parameters in your request as named value pairs.

For example:

"solve_parameters" : {
     "oaas.logAttachmentName":"log.txt",
     "oaas.logTailEnabled":"true"
}

You can use this code to collect the engine log tail during the solve and the whole engine log as output at the end of the solve.

You can use these parameters in your request.

Name	Type	Description
`oaas.timeLimit`	Number	You can use this parameter to set a time limit in milliseconds.
`oaas.resultsFormat`	Enum `JSON` `CSV` `XML` `TEXT` `XLSX`	Specifies the format for returned results. The default formats are as follows: CPLEX - `.xml` CPO - `.json` OPL - `.csv` DOcplex - `.json` Other formats might or might not be supported depending on the application type.
`oaas.oplRunConfig`	String	Specifies the name of the OPL run configuration to be executed.
`oaas.docplex.python`	`3.11 and 3.10 (deprecated)`	You can use this parameter to set the Python version for the run in your deployed model. If not specified, 3.11 is used by default.
`oaas.logTailEnabled`	Boolean	Use this parameter to include the log tail in the solve status.
`oaas.logAttachmentName`	String	If defined, engine logs are defined as a job output attachment.
`oaas.engineLogLevel`	Enum `OFF` `SEVERE` `WARNING` `INFO` `CONFIG` `FINE` `FINER` `FINEST`	You can use this parameter to define the level of detail that is provided by the engine log. The default value is `INFO`.
`oaas.logLimit`	Number	Maximum log-size limit in number of characters.
`oaas.dumpZipName`	Can be viewed as Boolean (see Description)	If defined, a job memory dump (inputs and outputs) `.zip` file is provided with this name as a job output attachment. The name can contain a placeholder `${oaas_job_id}`. If defined with no value, the attachment name `dump_${oaas_job_id}.zip` is used. If not defined, by default, no job memory dump `.zip` file is attached.
`oaas.dumpZipRules`	String	If defined, a `.zip` file is generated according to specific job rules (RFC 1960-based Filter). It must be used in conjunction with the `{@link DUMP_ZIP_NAME}` parameter. Filters can be defined on the duration and the following `{@link com.ibm.optim.executionservice.model.solve.SolveState}` properties: `duration` `solveState.executionStatus` `solveState.interruptionStatus` `solveState.solveStatus` `solveState.failureInfo.type` Example: `(duration>=1000) or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION))) or (\|(solveState.interruptionStatus=OUT_OF_MEMORY) (solveState.failureInfo.type=INFRASTRUCTURE))` (duration>=1000) or (&(duration<1000)(!(solveState.solveStatus=OPTIMAL_SOLUTION))) or (\|(solveState.interruptionStatus=OUT_OF_MEMORY) (solveState.failureInfo.type=INFRASTRUCTURE))
`oaas.outputUploadPeriod`	Number	Intermediate output in minutes. This parameter can be used to set up intermediate output publication (if any).
`oaas.outputUploadFiles`	String (RegExp)	RegExp filter for files to be included in the output upload. If nothing is defined, all outputs are added. Example: `job_${oaas_job_id}_log_${oaas_update_time}.txt`

Engine parameters that control the Decision Optimization solve can be configured in the Build model view. For more information, see Configuring engine settings in the Build model view.