Optima Operational Planning: response status

Optima Operational Planning (OOP) API handles the response status for:

Simulation status

The set of the possible statuses of the OOP simulation is listed in the table:

Status Description

PENDING

The request is in the queue, waiting to be run.

DONE_SIMULATION

The simulation has been completed.

RUNNING_SIMULATION

The simulation is currently running.

RUNNING_KPI

​The KPI associated to the simulation is being calculated.

DONE_KPI

The process is completed and the associated KPIs have been correctly computed.

ERROR_KPI

An error came up during the KPI calculation.

FAILED

The request has failed.

Simulations group status

The status of an OOP simulation group is associated to the set of statuses of the simulation engine, as shown in the table:

Simulation Group Status Description

0

PENDING.

All simulations of the group are in the PENDING state.

1

DONE.

All simulations of the group are in the DONE_KPIstate.

2

IN_PROCESS.

At least one simulation is in one of these states:

  • DONE_SIMULATION
  • RUNNING_SIMULATION
  • RUNNING_KPI

3

ERROR.

If we have N simulations, at least one simulation is in (ERROR_KPI OR FAILED), therefore K>0 simulations in ERROR_KPI.

The other N-Ksimulations must be in DONE_KPI.