_API OptimizerStartRequest Definition

<sp:OptimizerStartRequest>

<StartRequest>

<Version>?</Version>

Although this optional parameter has been defined in the API WSDL, only the value SP_StartOptimizerVersion (the integer value 1) is valid. In practice, this parameter is not required, and should be omitted when calling the API.

<FRU>?</FRU>

The FRU for which the Optimizer should be run

<Date>?</Date>

The date for the Optimizer to run. The actual Optimizer that runs will depend on which Optimizer horizon the supplied Date falls within:

If the supplied Date is inside the TWP, the Optimizer for the TWP will be run (which will include any non-working days).

If the supplied Date is outside the TWP, it will be run for that day and no other, even if it’s a non-working day.

<RunTime>?</RunTime>

The time (in minutes) to allow the Optimizer to run. This isn’t the time for executing the whole OptimizerStartRequest command, which may include running the In-Tray Auto Allocate operation before and afterwards, depending on the settings of the Auto Allocate rules. The maximum time that the Auto Allocation operation is limited by the value of ABS_auto_allocate_timeout. The maximum value of RunTime is set in the database by the mandatory per-FRU parameter opt_api_rt_max (range: 1 … 1440; units: minutes).

When running in single Optimizer mode, the RunTime parameter will be silently ignored.

<Options/>

N/A and must be set to 0, but is included as a place holder for future enhancements.

</StartRequest>

</sp:OptimizerStartRequest>