On This Page:

Related Pages:

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:

Click here to expand...

Web Service			Type	Description	Req?	Val?
`<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>`

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:

Click here to expand...

SP_OK (0)
SP_DATE_INVALID (14)
SP_UNIT_INVALID (28)
SP_OUTSIDE_HORIZON (53)
SP_OPTIONS_INVALID (80)
SP_UNIT_NOT_SUPPLIED (261)
SP_OPT_RUN_TIME_INVALID (292)
SP_OPT_ALREADY_RUNNING (293)
SP_OPT_ON_HOLD (294)
SP_DATE_IN_PAST (296)

Browser not supported