Skip to main content

Actual or Forecast Documentation

This document provides a detailed overview of actual-forecast in an economic model. The main property (econ function) is actualOrForecast.

Example Response​

    {
        "id": "645536abd8ad9d0021e1cd5c",
        "copiedFrom": null,
        "name": "actual-forecast test",
        "tags": [],
        "unique": false,
        "createdBy": "6283eac6241df8001331f6a3",
        "lastUpdatedBy": "6283eac6241df8001331f6a3",
        "createdAt": "2023-05-05T17:02:35.943Z",
        "updatedAt": "2023-06-27T18:16:56.554Z",
        "actualOrForecast": {
            "ignoreHistoryProd": false,
            "replaceActualWithForecast": {
                "oil": {
                    "never": ""
                },
                "gas": {
                    "asOfDate": ""
                },
                "water": {
                    "date": "2023-05-11"
                }
            }
        }
    }

Econ Functions​

  • actualOrForecast: (required) This object includes the following properties: ignoreHistoryProd, and replaceActualWithForecast.

actualOrForecast​

  • ignoreHistoryProd: (required) A Boolean that determines if you should ignore all historical and future (volumetric) forecasting as if it does not exist.
  • replaceActualWithForecast: (required if ignoreHistoryProd is set to false) object that determines which phases to replace and when to do so.

replaceActualWithForecast​

  • oil: (required) object that defines if and when phase should be affected.
  • gas: (required) object that defines if and when phase should be affected.
  • water: (required) object that defines if and when phase should be affected.

oil, gas, water​

  • asOfDate, never, date: (one required) A string representing the time when phase should be affected.

Example actualOrForecast Request Body​

        "actualOrForecast": {
            "ignoreHistoryProd": false,
            "replaceActualWithForecast": {
                "oil": {
                    "asOfDate": ""
                },
                "gas": {
                    "never": ""
                },
                "water": {
                    "date": "2023-05-23"
                }
            }
        }

Definitions​

afterEconLimit​

A string that indicates whether it's after the economic limit or not. Possible values are "yes" and "no". Typically this is set to "no". When "yes" is submitted, all historical and future (volumetric) forecasting will be ignored as if it does not exist. This can be used for example in the case of intermittently flowed wells that are SI until a future date in order to keep economics from being generated inadvertently. This does not affect the FPD from the Hierarchy section in the dates section

ignoreHistoryProd​

This property is a Boolean. Possible values are true or false. When ignoreHistoryProd is set as true the replaceActualWithForecast cannot be sent in the request.

replaceActualWithForecast​

This property is a object that must contain exactly three properties: oil, gas and water.

oil​

This property is an object that contains data related to the oil phase through three possible properties: asOfDate or date or never

gas​

This property is an object that contains data related to the gas phase through three possible properties: asOfDate or date or never

water​

This property is an object that contains data related to the water phase through three possible properties: asOfDate or date or never

never​

A string property representing that the phase is to "never" be affected. The value must be an empty string "" if this property is sent in a request.

asOfDate​

A string property representing that the change to the phase should to be be applied on the As of Date. The value must be an empty string "" if this property is sent in a request.

date​

A string property representing that the change to the phase should to be be applied on the date given. The format of the date is YYYY-MM-DD, and the date must fall between 1900-01-01 to 2262-04-01.