Start Optimizer SOAP API
- Matthew Wren
The sp:OptimizerStartRequest API method can be used to start an Optimizer process.
Description
Allows an Optimizer to be started from outside ServiceOptimizer. The in-tray auto allocation operation will be run before and after the Optimizer if configured to do so. The post-Optimizer de-allocation operation is not configurable and so will always be run immediately after the Optimizer. The requested Optimizer won’t be started if it’s on hold.
The sp:OptimizerStartRequest API method will actually set the requested Optimizer to enter the waiting state so that the maximum number of concurrently running Optimizers per FRU can be controlled (by fru_max_optimizers_concurrent). The call then returns immediately, i.e. it doesn’t block waiting for the Optimizer to start or finish.
Definition
The definition of this API is:
Web Service | Type | Description | Req? | Val? | ||
|
|
|
|
| ||
|
|
|
|
|
| |
|
|
| Although this optional parameter has been defined in the API WSDL, only the value |
|
| |
|
|
| The FRU for which the Optimizer should be run |
|
| |
|
|
| 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. |
|
| |
|
|
| 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. |
|
| |
|
|
| N/A and must be set to 0, but is included as a place holder for future enhancements. |
|
| |
|
|
|
|
|
| |
|
|
|
|
| ||
Return Structure
The API returns the standard return structure.
Return Codes
In addition to the Standard Return Codes, the possible Return Codes from this API are: