Risking Overview
This document provides a detailed overview of risking in an economic model. The main properties (econ functions) include risking and shutIn objects in the given schema.
Example Response
{
"id": "641c51a432567300122c2ab6",
"copiedFrom": null,
"name": "Risking Demo",
"tags": [],
"unique": false,
"createdBy": "6283eac6241df8001331f6a3",
"lastUpdatedBy": "6283eac6241df8001331f6a3",
"createdAt": "2023-03-23T13:18:28.657Z",
"updatedAt": "2023-05-18T00:02:15.494Z",
"risking": {
"riskProd": true,
"riskNglDripCondViaGasRisk": true,
"oil": {
"rows": [
{
"multiplier": 1000000,
"seasonal": "Jan"
},
{
"multiplier": 100,
"seasonal": "Feb"
},
{
"multiplier": 0.000001,
"seasonal": "Mar"
},
{
"multiplier": 100.95,
"seasonal": "Apr"
},
{
"multiplier": 100,
"seasonal": "May"
},
{
"multiplier": 0.25,
"seasonal": "Jun"
},
{
"multiplier": 100,
"seasonal": "Jul"
},
{
"multiplier": 100,
"seasonal": "Aug"
},
{
"multiplier": 100,
"seasonal": "Sep"
},
{
"multiplier": 100,
"seasonal": "Oct"
},
{
"multiplier": 0,
"seasonal": "Nov"
},
{
"multiplier": 100,
"seasonal": "Dec"
}
]
},
"gas": {
"rows": [
{
"multiplier": 25,
"offsetToFpd": 5
},
{
"multiplier": 50,
"offsetToFpd": 3
},
{
"multiplier": 75,
"offsetToFpd": 2
}
]
},
"ngl": {
"rows": [
{
"dates": "2020-03-01",
"multiplier": 100
},
{
"dates": "2021-05-01",
"multiplier": 90
},
{
"dates": "2022-05-01",
"multiplier": 70
},
{
"dates": "2023-05-01",
"multiplier": 25.5
}
]
},
"dripCondensate": {
"rows": [
{
"entireWellLife": "Flat",
"multiplier": 0
}
]
},
"water": {
"rows": [
{
"multiplier": 100,
"offsetToAsOf": 2
}
]
},
"wellStream": {
"rows": [
{
"count": 1,
"offsetToDiscountDate": 36
}
]
}
},
"shutIn": {
"rows": [
{
"capex": true,
"dates": {
"startDate": "2023-03-14",
"endDate": "2023-03-24"
},
"fixedExpense": false,
"multiplier": 0.000001,
"phase": "oil",
"repeatRangeOfDates": "monthly",
"scalePostShutInEnd": " ",
"scalePostShutInEndCriteria": "econ_limit",
"totalOccurrences": 1,
"unit": "day"
},
{
"capex": true,
"dates": {
"startDate": "2023-06-02",
"endDate": "2023-06-22"
},
"fixedExpense": true,
"multiplier": 1,
"phase": "gas",
"repeatRangeOfDates": "yearly",
"scalePostShutInEnd": "2023-06-27T00:00:00.000Z",
"scalePostShutInEndCriteria": "dates",
"totalOccurrences": 25,
"unit": "day"
},
{
"capex": false,
"dates": {
"startDate": "2023-05-07",
"endDate": "2023-06-02"
},
"fixedExpense": false,
"multiplier": 5,
"phase": "water",
"repeatRangeOfDates": "no_repeat",
"scalePostShutInEnd": " ",
"scalePostShutInEndCriteria": "econ_limit",
"totalOccurrences": 1,
"unit": "day"
},
{
"capex": true,
"dates": {
"startDate": "2023-05-29",
"endDate": "2023-06-01"
},
"fixedExpense": false,
"multiplier": 1,
"phase": "all",
"repeatRangeOfDates": "no_repeat",
"scalePostShutInEnd": "2023-06-29T00:00:00.000Z",
"scalePostShutInEndCriteria": "dates",
"totalOccurrences": 1,
"unit": "day"
}
]
}
}
Econ Functions
risking: (required) This object includes the following propertiesriskProd,riskNglDripCondViaGasRisk,oil,gas,ngl,dripCondensate,water, andwellStream.shutIn: (requrired) This object includes the following propertyrows.
Risking
riskProd: (required) BooleanriskNglDripCondViaGasRisk: (required) Booleanoil: (required) objectgas: (required) objectngl: (required) objectdripCondensate: (required) objectwater: (required) objectwellStream: (optional) object
oil, gas, ngl, dripCondensate, and water
An object that contain the rows array representing the rows of either oil, gas, ngl, dripCondensate, or water. Each item in the rows array is an object with one of the following properties from each of the categories:
multiplier: (required) a number representing either the multiplier as a percentage.entireWellLife,offsetToFpd,offsetToAsOf,offsetToFirstSegment,offsetToEndHistory,dates, orseasonal: (one required) Various criteria related to well life and production rates.
wellStream
An object that contain the rows array representing the rows wellStream. Each item in the rows array is an object with one of the following properties from each of the categories:
count, orpercentage: (one required) a number representing either a percentage or count.entireWellLife,offsetToFpd,offsetToAsOf,offsetToDiscountDate,dates: (one required) Various criteria related to well life and production rates.
"risking": {
"riskProd": true,
"riskNglDripCondViaGasRisk": true,
"oil": {
"rows": [
{
"multiplier": 100,
"seasonal": "Jan"
},
{
"multiplier": 100,
"seasonal": "Feb"
},
{
"multiplier": 100,
"seasonal": "Mar"
},
{
"multiplier": 100,
"seasonal": "Apr"
},
{
"multiplier": 100,
"seasonal": "May"
},
{
"multiplier": 100,
"seasonal": "Jun"
},
{
"multiplier": 100,
"seasonal": "Jul"
},
{
"multiplier": 100,
"seasonal": "Aug"
},
{
"multiplier": 100,
"seasonal": "Sep"
},
{
"multiplier": 100,
"seasonal": "Oct"
},
{
"multiplier": 100,
"seasonal": "Nov"
},
{
"multiplier": 100,
"seasonal": "Dec"
}
]
},
"gas": {
"rows": [
{
"entireWellLife": "Flat",
"multiplier": 100
}
]
},
"ngl": {
"rows": [
{
"entireWellLife": "Flat",
"multiplier": 100
}
]
},
"dripCondensate": {
"rows": [
{
"entireWellLife": "Flat",
"multiplier": 100
}
]
},
"water": {
"rows": [
{
"entireWellLife": "Flat",
"multiplier": 100
}
]
},
"wellStream": {
"rows": [
{
"entireWellLife": "Flat",
"percentage": 1
}
]
}
}
shutIn
rows: (required) Boolean
rows
An object that contain the rows array representing the rows of shut in. Each item in the rows array is an object with one of the following properties from each of the categories:
capex: (required) Booleandates: (required) Object (not to be confused withdatesinriskingecon function)fixedExpense: (required) Booleanmultiplier: (required) numberphase: (required) stringrepeatRangeOfDates: (required) stringscalePostShutInEnd: (required) stringscalePostShutInEndCriteria: (required) stringtotalOccurrences: (required) numberunit: (required) string
"shutIn": {
"rows": [
{
"capex": true,
"dates": {
"startDate": "2023-03-14",
"endDate": "2023-03-24"
},
"fixedExpense": false,
"multiplier": 0.000001,
"phase": "oil",
"repeatRangeOfDates": "monthly",
"scalePostShutInEnd": " ",
"scalePostShutInEndCriteria": "econ_limit",
"totalOccurrences": 1,
"unit": "day"
},
{
"capex": true,
"dates": {
"startDate": "2023-06-02",
"endDate": "2023-06-22"
},
"fixedExpense": true,
"multiplier": 1,
"phase": "gas",
"repeatRangeOfDates": "yearly",
"scalePostShutInEnd": "2023-06-27T00:00:00.000Z",
"scalePostShutInEndCriteria": "dates",
"totalOccurrences": 25,
"unit": "day"
},
{
"capex": false,
"dates": {
"startDate": "2023-05-07",
"endDate": "2023-06-02"
},
"fixedExpense": false,
"multiplier": 5,
"phase": "water",
"repeatRangeOfDates": "no_repeat",
"scalePostShutInEnd": " ",
"scalePostShutInEndCriteria": "econ_limit",
"totalOccurrences": 1,
"unit": "day"
},
{
"capex": true,
"dates": {
"startDate": "2023-05-29",
"endDate": "2023-06-01"
},
"fixedExpense": false,
"multiplier": 1,
"phase": "all",
"repeatRangeOfDates": "no_repeat",
"scalePostShutInEnd": "2023-06-29T00:00:00.000Z",
"scalePostShutInEndCriteria": "dates",
"totalOccurrences": 1,
"unit": "day"
}
]
}
Definitions
riskProd
This property is a Boolean that represents a binary flag related to risk production. Possible values are true or false.
riskNglDripCondViaGasRisk
- Type: Boolean
- This property is a Boolean that represents the risk associated with Natural Gas Liquids (NGL) and Drip Condensate via Gas Risk.Possible values are
trueorfalse.
wellStream
- This property is an object that contains data related to the well stream through the
rowsarray.
oil
- This property is an object that contains data related to the oil phase through the
rowsarray.
gas
- This property is an object that contains data related to the gas phase through the
rowsarray.
water
- This property is an object that contains data related to the water phase through the
rowsarray.
dripCondensate
- This property is an object that contains data related to drip condensate through the
rowsarray.
ngl
- This property is an object that contains data related to ngl through the
rowsarray.
All properties are required for the risking object.
multiplier
A number representing the multiplier in percentage. The possible range for this value is from 0 to 1000000 (1,000,000) inclusive. The minimum decimal precision is 0.000001.
entireWellLife
This is a string property that can only have the value "Flat".
offsetToFpd
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToAsOf (risking)
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToAsOf (shutIn)
This property is an object representing a start and end time period. The possible properties of the object are:
start: (required) An integer. The possible range for this value is from1to1200, inclusive.end: (required) An integer. The possible range for this value is from1to1200, inclusive. The value ofendmust be greater than or equal to the value ofstart.
offsetToFirstSegment
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToEndHistory
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
offsetToDiscountDate
This property represents a time period, defined as an integer. The possible range for this value is from 1 to 1200, inclusive.
dates (risking)
This is a string property representing a date. The format of the date is YYYY-MM-DD, and the date must fall between 1900-01-01 to 2262-04-01. For the DD portion of the date, the value must be 01.
dates (shutIn)
This property is an object representing a start and end date. The possible properties of the object are:
startDate: (required) Date string with the format of YYYY-MM-DD. The dates must fall between1900-01-01to2262-04-01.endDate: (required) Date string with the format of YYYY-MM-DD. The dates must fall between1900-01-01to2262-04-01.
seasonal
A three character string that represents a month in a year. Possible values are:
"Jan""Feb""Mar""Apr""May""Jun""Jul""Aug""Sep""Oct""Nov""Dec"
rows
Array of objects (with a maximum of 100 items)
phase
A string representing the phase of the fluid. Possible values are:
- ``"all"`
"oil""gas""water"
repeatRangeOfDates
A string representing the interval of repetition. Possible values are:
"no_repeat""monthly""yearly"
totalOccurrences
A number representing the occurrence count. The possible range for this value is from 1 to 1200 inclusive.
unit
A string representing the unit of time: Possible values are "day" or "month".
scalePostShutInEndCriteria
A string representing the criteria for shut-in end. Possible values are "dates" or "econ_limit".
scalePostShutInEnd
A string representing the value corresponding to the criteria input for shut-in end (scalePostShutInEndCriteria). Possible values are: " " (an empty string with a space if "econ_limit" was selected) or a date time if "dates" was selected ex: "2023-06-20T00:00:00.000Z"
fixedExpense
This property is a Boolean that represents a binary flag related to whether or not it was a fixed expense. Possible values are true or false.
capex
This property is a Boolean that represents a binary flag related to whether or not it is a capital expenditure. Possible values are true or false.