Scenario Object Reference #

This Scenario object is the response object to a simulation request.

  {
    "Id":"do.vj5rf3xjrgsvhzzuqejwa",
    "StatusNbr": 1,
    "StatusDescription": "Ok",
    "JobStates": [],
    "Progress": null,
    "ResourcesForecast": [],
    "NoSolutionGraphs": [],
    "Errors": [],
    "Settings": {},
  }

Attributes #

Id - string #

Uniquely identifies a scenario. #

StatusNbr - integer #

Status number of current job state. #

StatusDescription - string #

Status description of current job state. #

JobStates - array of objects #

Identifies job states of a create scenario request. A request is managed as an on-demand job. An error-free request proceeds through Job States 1 - 7. Any Job State above 7 indicates a state in which a job cannot complete and a scenario cannot be generated. When a request is reporting the simulator is running (Job State 6), the Progress object provides progress information. #

Progress - object #

Description of progress and transactional statistics of a running simulation. Available when Job State is 5 or 6. #

Results - array of objects #

Object that contains a preferred result with respect to the type of simulation selected. The object is a collection of key performance metrics and time-series forecasts for each pool resource. #

NoSolutionGraphs - array of objects #

A list of graph object for which a solution was not found. A graph with no solution may arise when the model includes a Constraints object. #

Errors - array of objects #

List of scenario error descriptions. #

Settings - object #

Object that contains user provided values received from the PoolResourceModel Settings object. Zypr adds several date properties to this object and returns the Scenario Settings object. #

JobStates #

This JobStates object reports the various states a request steps through to generate a scenario.

  {
    "StatusTimestamp" : "08/22/2022 22:28:43",
    "StatusNbr" : 3,
    "Message" : ""
  }

Attributes #

StatusTimestamp - DateTime in UTC #

Indicates when the state was posted. #

StatusNbr - integer #

The status number that corresponds to a job state. #

Message - string #

Describes the job state that corresponds to the status number. #

Progress #

This Progress object reports the current progress of a running scenario.

  {
    "Started": true,
    "Completed": false,
    "PercentComplete": 42,
    "TransactionCount": 12847,
    "SequenceCount": 832 
  }

Attributes #

Started - boolean #

Indicates the simulator has a valid input model to work with and construction of a scenario has commenced. #

Completed - boolean #

The simulator has completed and generated a scenario or encountered an error. #

PercentComplete - integer #

An estimate of progress to generate a scenario. #

TransactionCount - integer #

An estimate of feasible server add/remove transactions. #

TransactionCount - integer #

An estimate of feasible sequences of transactions corresponding to time-series duration as indicated by SolutionTargetTime property in the SimulationRules object. #

Resources Forecast #

This ResourcesForecast object reports the results of the scenario. Definitions of each object can be found in Resources Forecast object reference.

  {
    "FinancialKpi": {},
    "FinancialSummary": {},
    "ServerKPI": {},
    "Server Summary": {},
    "Server Transactions": {}, 
    "Software KPI": {},
    "Software Summary": {},
    "Software Transactions": {},
    "Facility KPI": {},
    "Facility Summary": {},
    "Facility Transactions": {} 
  }

No Solution Graphs #

This NoSolutionGraphs object may list of one or more graphs that failed because a solution could not be found for that graph. If the Constraints object is used to constrain the feasible solution space, it is likely the object has a value that is too restrictive.

  {
    "FailedGraphNbr": 9,
    "EdgeNbr" : 0,
    "NodeY" : 0,
    "NodeX" : 0,
    "Message:" "Your constraint is too restrictive.
                No graph solution compliant with constraint."
    "AtRelativeTargetTime": 0.0,
    "AtAbsoluteTargetTime": 0.0,
    "LowestConstraintMetricVarianceRate": 0.0,
    "StackTrace": null,
    "NonCompliantSequences": null
  }

Attributes #

FailedGraphNbr - integer #

The graph number the simulation engine attempted to build, but failed. #

EdgeNbr - integer #

Edge number of graph. #

NodeY - integer #

Node Y dimension of edge number. #

NodeX - integer #

Node X dimension of edge number. #

Message - string #

Description of failure. #

AtRelativeTargetTime - numeric #

Time (yrs) of failure relative to the edge number. #

AtAbsoluteTargetTime - numeric #

Time (yrs) of failure in absolute time. #

LowestConstraintMetricVarianceRate - numeric #

Variance from the target constraint. #

Errors #

This Error object identifies and describes one or more errors.

  {
    "Type": "Model input error",
    "Message": "Processor Set Size must be positive at JE 2",
  }

Attributes #

Type - string #

Error type. #

Message - string #

Detailed description of error. #

Settings #

This Scenario Settings object is includes properties received from the PoolResourcesModel Settings object, plus Zypr generated date properties used to generated all time-series results.

  {
    "ScenarioName": "My Scenario Name",
    "DataValidationCascadeMode": "Stop",
    "ModelEffectiveDate": "1/7/2022",
    "ModelStartDate": "1/7/2022",
    "ScenarioCreatedDate": "3/1/2022",
    "CultureInfoISOCode": "EN",
    "EmailResults": true,
    "Pool": {
      "Id": "ATL1_42_PROD",
      "Name": "Name of service pool",
      "Description": "A long description of pool"
    },
  }

Attributes (added by Zypr) #

ModelStartDate - date #

Starting date of time-series forecast contained in Results object. If a valid ModelEffectiveDate was received from the PoolResourcesModel Settings object, then the ModelStartDate property is set to this date. If a valid ModelEffectiveDate was not received, then the ModelStartDate property is set to the ScenarioCreateDate property. #

ScenarioCreateDate - date #

Timestamp when scenario was created and executed. #