Model settings

model_settings.json describes a model’s runtime capabilities, lookup configuration and defaults. It is supplied by the model and validated by ods_tools against model_settings_schema.json. Nested objects (e.g. model_settings, lookup_settings) are expanded into their own subsections below.

Field	Type	Required	Constraints	Description
version	string		minimum 3	The schema version for model settings validation (optional)
name	string		min length 1	Name of the model associated with this settings file (optional)
description	string		min length 1	Short Description of the catastrophe model (optional)
model_supplier_id	string		min length 1	The supplier ID for the model. (optional)
model_name_id	string		min length 1	The model ID for the model. (optional)
model_version_id	string		min length 1	The version ID for the model. (optional)
model_run_mode	enum[string]		one of: "V1", "V2"	OasisPlatform execution mode for running an analysis, V1 = ‘Single server execution’ (worker versions 1.x.x or 2.3.x) , V2 = ‘Distributed execution’ scale an analysis across multiple nodes (Only workers 2.3.x and above)
model_configurable	boolean			Marks this model as a ‘complex model’ with configuration options at the input file generation stage. (optional)
model_default_samples	integer		minimum 0	The default number of samples generated per event. (optional)
model_settings	object	Yes		Runtime settings available to a model
lookup_settings	object	Yes		Model lookup section
correlation_settings	array[object]			Legacy Correlation Settings. Now moved to model_settings
data_settings	object			Additional data options for a model
computation_settings	object			List of parameters that will be passed as arguments to the MDK, options are dependent on the package version. To see these look at releases 2.4.0 and up (https://github.com/OasisLMF/OasisLMF/releases)

model_settings

Runtime settings available to a model

Field	Type	Required	Constraints	Description
event_set	object			The ‘id’ field from options is used as a file suffix’ events_<id>.bin
event_occurrence_id	object			The ‘id’ from options is used as a file suffix’ occurrence_<id>.bin
footprint_set	object			The ‘id’ field from options is used as a file suffix, e.g. footprint_<id>.bin, footprint_<id>.idx.z, footprint_<id>.parquet
vulnerability_set	object			The ‘id’ field from options is used as a file suffix, e.g. vulnerability_<id>.bin, vulnerability_<id>.csv, vulnerability_<id>.parquet
pla_loss_factors_set	object			The ‘id’ field from options is used as a file suffix, e.g. lossfactors_<id>.bin, lossfactors_<id>.csv, lossfactors_<id>.parquet
valid_output_perspectives	array[string]		each item one of: "gul", "il", "ri", "rl"	If set, the model only supports the given output perspectives. This can be overridden per event set using the ‘valid_perspectives’ field. ‘gul’: ground up losses, ‘il’: insured losses, ‘ri’: reinsurance net losses, ‘rl’: reinsurance losses at all inuring priorities.
valid_output_metrics	array[string]		each item one of: "aal", "aalcalcmeanonly", "elt", "plt", "lec", "aep", "oep", "summarycalc", "full_uncertainty_aep", "full_uncertainty_oep", "sample_mean_aep", "sample_mean_oep", "wheatsheaf_aep", "wheatsheaf_mean_aep", "wheatsheaf_mean_oep", "wheatsheaf_oep", "elt_sample", "elt_quantile", "elt_moment", "plt_sample", "plt_quantile", "plt_moment", "alt_period", "alt_meanonly", "alct_confidence", "alct_convergence", "ept", "ept_full_uncertainty_aep", "ept_full_uncertainty_oep", "ept_mean_sample_aep", "ept_mean_sample_oep", "ept_per_sample_mean_aep", "ept_per_sample_mean_oep", "psept", "psept_aep", "psept_oep"	If set, the model only supports the given output metrics. This can be overridden per event set using the ‘valid_metrics’ field. Values must match the output options in the summaries section from the analysis_settings.json file. Example: ‘valid_output_metrics’:[‘ptl’,’elt’].
correlation_settings	array[object]			The Correlation Settings.
loss_methodology_notes	object			Fixed methodology facts that explain the model’s correlation settings and how ground-up loss is capped across sub-perils. Part of the Model Certification Programme’s scope metadata.
vulnerability_adjustments	object			Object containing vulnerability adjustments and replacements.
pla	boolean		default false	Legacy - moved to ‘computation_settings’.
do_disaggregation	boolean		default true	Legacy - moved to ‘computation_settings’
coverage_dependency_settings	array[object]			Links a dependent coverage type to a source coverage type at the same location: in gulmc the source coverage’s sampled damage bin indexes the dependent coverage’s damage-bin-authored vulnerability, so the dependent’s damage is conditioned on the source’s. Each dependent coverage type may appear at most once.
summary_report_fields	array[string]			If set, the exposure summary report will include additional breakdowns from the listed fields. Note that the field must exists in the exposure file.
string_parameters	array[object]		unique items	Single string paramters
list_parameters	array[object]		unique items	List of strings parameters
dictionary_parameters	array[object]		unique items	Generic dictionary parameters
boolean_parameters	array[object]		unique items	Boolean parameters
float_parameters	array[object]		unique items	Bounded float paramters
numeric_parameters	array[object]		unique items	unbounded numeric paramters
integer_parameters	array[object]		unique items	Integer paramters
dropdown_parameters	array[object]		unique items	Generic dropdown paramters
multi_parameter_options	array[object]		unique items	Sets of parameters with pre-assigned values
parameter_groups	array[object]		unique items	Parameter Groups

model_settings.event_set

The ‘id’ field from options is used as a file suffix’ events_<id>.bin

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes		UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for event set
options	array[object]	Yes		Array of possible event sets

model_settings.event_set.options

Event sets option

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select an event set
desc	string	Yes	min length 1	UI description for selection
number_of_events	integer		minimum 0	The total number of events in the set. (optional)
valid_occurrence_ids	array[string]		each item min length 1	An optional list of viable occurrence file ids to use with this event set
valid_footprint_ids	array[string]		each item min length 1	An optional list of viable footprint file ids to use with this event set
valid_pla_loss_factors_ids	array[string]		each item min length 1	An optional list of viable PLA lossfactors file ids to use with this event set
valid_vulnerability_ids	array[string]		each item min length 1	An optional list of viable vulnerability file ids to use with this event set
valid_perspectives	array[string]		each item one of: "gul", "il", "ri", "rl"	If set, this event set only supports the given output perspectives. ‘gul’: ground up losses, ‘il’: insured losses, ‘ri’: reinsurance net losses, ‘rl’: reinsurance losses at all inuring priorities.
valid_metrics	array[string]		each item one of: "aal", "aalcalcmeanonly", "elt", "plt", "lec", "aep", "oep", "summarycalc", "full_uncertainty_aep", "full_uncertainty_oep", "sample_mean_aep", "sample_mean_oep", "wheatsheaf_aep", "wheatsheaf_mean_aep", "wheatsheaf_mean_oep", "wheatsheaf_oep", "elt_sample", "elt_quantile", "elt_moment", "plt_sample", "plt_quantile", "plt_moment", "alt_period", "alt_meanonly", "alct_confidence", "alct_convergence", "ept", "ept_full_uncertainty_aep", "ept_full_uncertainty_oep", "ept_mean_sample_aep", "ept_mean_sample_oep", "ept_per_sample_mean_aep", "ept_per_sample_mean_oep", "psept", "psept_aep", "psept_oep"	If set, this event set only supports the given output metrics, matches the output types set in the summaries section on an analysis_settings.json file. Example: ‘valid_metrics’:[‘ptl’,’elt’] means that only valid summary outputs are ‘eltcalc’ and ‘pltcalc’.
tooltip	string			Long description (optional)

model_settings.event_occurrence_id

The ‘id’ from options is used as a file suffix’ occurrence_<id>.bin

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes		UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for occurrence
options	array[object]	Yes		Array of possible occurrence sets

model_settings.event_occurrence_id.options

Occurrence set options

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select an occurrence set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)
max_periods	integer		minimum 1	Maximum periods for this occurrence set

model_settings.footprint_set

The ‘id’ field from options is used as a file suffix, e.g. footprint_<id>.bin, footprint_<id>.idx.z, footprint_<id>.parquet

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes		UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for footprint set
options	array[object]	Yes		Array of possible footprint sets

model_settings.footprint_set.options

Footprint set options

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select a footprint set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)

model_settings.vulnerability_set

The ‘id’ field from options is used as a file suffix, e.g. vulnerability_<id>.bin, vulnerability_<id>.csv, vulnerability_<id>.parquet

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes		UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for vulnerability set
options	array[object]	Yes		Array of possible vulnerability sets

model_settings.vulnerability_set.options

Vulnerability set options

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select a vulnerability set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)

model_settings.pla_loss_factors_set

The ‘id’ field from options is used as a file suffix, e.g. lossfactors_<id>.bin, lossfactors_<id>.csv, lossfactors_<id>.parquet

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes		UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for lossfactors set
options	array[object]	Yes		Array of possible lossfactors sets

model_settings.pla_loss_factors_set.options

Lossfactors set options

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select a lossfactors set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)

model_settings.correlation_settings

Field	Type	Required	Constraints	Description
peril_correlation_group	integer		min length 1	The Peril Correlation Group
correlation_value	string			The Legacy Correlation Value, retained for backward compatibility
hazard_correlation_value	string			The Correlation Value for harard sampling
damage_correlation_value	string			The Correlation Value for vulnerability sampling

model_settings.loss_methodology_notes

Fixed methodology facts that explain the model’s correlation settings and how ground-up loss is capped across sub-perils. Part of the Model Certification Programme’s scope metadata.

Field	Type	Required	Constraints	Description
ground_up_loss_capping	object			How ground-up loss is capped so a location’s loss cannot exceed its TIV
correlation_methodology	string			Free-text description of the hazard and vulnerability uncertainty correlation methodology behind correlation_settings
secondary_uncertainty	object			Whether the model samples secondary (vulnerability) uncertainty around the mean damage ratio, and how

model_settings.loss_methodology_notes.ground_up_loss_capping

How ground-up loss is capped so a location’s loss cannot exceed its TIV

Field	Type	Required	Constraints	Description
gul_alloc_rule	integer			The Oasis gul-alloc-rule used to cap and allocate ground-up loss
description	string			Free-text description of the capping methodology

model_settings.loss_methodology_notes.secondary_uncertainty

Whether the model samples secondary (vulnerability) uncertainty around the mean damage ratio, and how

Field	Type	Required	Constraints	Description
supported	boolean			Whether the model supports secondary uncertainty at all
enabled_by_default	boolean			Whether secondary uncertainty is sampled by default when the model is run
user_configurable	boolean			Whether a user can enable or disable secondary uncertainty themselves, e.g. via computation_settings
distribution_type	enum[string]		one of: "parametric", "non_parametric"	Whether the sampled distribution is parametric (e.g. Beta, defined by distribution parameters) or non-parametric (e.g. an empirical/discrete damage distribution)
notes	string			Free-text detail, e.g. which distribution family is used and why

model_settings.vulnerability_adjustments

Object containing vulnerability adjustments and replacements.

Field	Type	Required	Constraints	Description
adjustments	object		keys matching ^[0-9]+$; each value number (minimum 0)	Dictionary containing vulnerability adjustments with vulnerability ID as integer keys and adjustment factors as float values.
replace_data	object		keys matching ^[0-9]+$; each value array[array] (each item (min items 3; max items 3; in order: integer, integer, number (minimum 0; maximum 1)))	Detailed vulnerability replacements.
replace_file	string			Path to a CSV file containing vulnerability data to be replaced.

model_settings.coverage_dependency_settings

Field	Type	Required	Constraints	Description
source_coverage_type	integer	Yes		The coverage type whose damage drives the dependent coverage.
dependent_coverage_type	integer	Yes		The coverage type whose damage is driven by the source coverage.

model_settings.string_parameters

User selected string value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Default ‘string’ for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.list_parameters

User selected list values

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	array[string]	Yes		Default ‘list’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.dictionary_parameters

User selected dictionarys

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	object	Yes		Defaults set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.boolean_parameters

User selected boolean option

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	boolean	Yes		Default ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.float_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	number	Yes		Default ‘value’ set for float variable
max	number	Yes		Maximum Value for float variable
min	number	Yes		Minimum Value for float variable
stepsize	number			The slider widget’s step interval for adjusting the float parameter.
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.numeric_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	number	Yes		Default integer or float ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.integer_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	integer	Yes		Default integer ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.dropdown_parameters

The ‘id’ field is mapped into the analysis settings as ‘paramter_name’: ‘<id-selected>’

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for dropdown option
options	array[object]	Yes		Array of possible event sets
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.dropdown_parameters.options

Dropdown option

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select an event set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)

model_settings.multi_parameter_options

Parameter group option

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
config	object	Yes		JSON object holding <parameter_name>:<value> pairs
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

model_settings.parameter_groups

Defines which parameter are related

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	Reference for the group element
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
priority_id	integer	Yes		Set which parameter groups to display first
presentation_order	array[string]	Yes	each item min items 1	List of parameters reference by their ‘name’ property
collapsible	boolean			Boolean to mark if this parameter group is collapsible
default_collapsed	boolean			Boolean to mark if parameter group starts collapsed

lookup_settings

Model lookup section

Field	Type	Required	Constraints	Description
supported_perils	array[object]		min properties 1	Valid Peril codes for this model

lookup_settings.supported_perils

Selection Item

Field	Type	Required	Constraints	Description
id	string	Yes	min length 3; max length 3	OED three letter peril code
desc	string	Yes	min length 1	Short string describing the peril
peril_correlation_group	integer		min length 1	the peril correlated group ID

correlation_settings

Field	Type	Required	Constraints	Description
peril_correlation_group	integer		min length 1	The Peril Correlation Group
correlation_value	string			The Correlation Value

data_settings

Additional data options for a model

Field	Type	Required	Constraints	Description
supported_oed_versions	array[string]		each item min length 1	A list of OED releases that this model supports.
uses_model_files	boolean			Marks the model as requiring external model data.
model_data_version	string		min length 1	Version ID of the Model data.
keys_data_version	string		min length 0	Version ID of the lookup keys data.
worker_image	string		min length 1	The model worker’s docker image name
worker_version	string		min length 1	The model worker’s version ID
docs_version	string		min length 1	Version ID of the model documents
test_files_version	string		min length 1	Version ID of the test files
countries	array[string]		each item min length 1	A list of country codes that this model covers.
mandatory_fields	array[string]		each item min length 1	List of OED fields that the model requires.
supported_coverages	array[object]			Declares which OED coverage types (OED ‘CoverageValues’ vocabulary) this model generates loss for, spanning both property (building/other/contents/BI) and non-property (e.g. cyber) lines. Part of the Model Certification Programme’s scope metadata (see Section 4/5 of the Model Certification Plan).
geographic_extent_notes	string			Free-text qualification of ‘countries’, e.g. latitude bands or partial-country exclusions.
geographic_exclusions	array[object]			Areas explicitly excluded from model coverage even where the country as a whole is supported, tied back to a country code and (where relevant) the geocoding scheme the exclusion is expressed under, so the exclusion can be processed programmatically rather than only read as free text.
geographic_schemes_supported	array[object]			Declares which OED location fields the model can use to resolve hazard, and any specific geographic scheme codes recognised.
field_behaviour	array[object]			Every OED field the model reads beyond ‘mandatory_fields’, and any field values that change or suppress the result. Directly extends the model certification scope metadata for ‘vulnerability mapping’ and ‘in-model / out-of-model’ fields.
out_of_scope	array[object]			Structured exclusions list, the mirror image of ‘supported_perils’ under lookup_settings.
additional_assets	array[object]			Data assets available to the model
damage_group_fields	array[string]			List of OED fields from location file to form damage group ids
hazard_group_fields	array[string]			List of OED fields from location file to form hazard group ids
datafile_selectors	array[object]			Select file_ids from the API endpoint /v1/data_files/ to connect with an analyses run

data_settings.supported_coverages

Field	Type	Required	Constraints	Description
oed_field	enum[string]	Yes	one of: "1Building", "2Other", "3Contents", "4BI", "5PD", "6All", "NPBI", "CBI", "DIAS", "EXT", "FIN", "INRE", "LIA", "REG", "ENO", "CYB"	An OED ‘CoverageValues’ code, e.g. ‘1Building’/’3Contents’ for property coverages or ‘CYB’/’LIA’ for non-property (cyber) coverages. See the ‘CoverageValues’ vocabulary in the OED spec.
supported	boolean	Yes		Whether the model generates loss for this coverage
notes	string			Free-text qualification, e.g. scaling or annualisation rules

data_settings.geographic_exclusions

Field	Type	Required	Constraints	Description
country	string	Yes	min length 1	The country the exclusion applies within, matching a code from ‘countries’
area	string		min length 1	Name or code of the specific area excluded within the country, e.g. an AreaCode/AreaName or named region
scheme	string		min length 1	The geocoding scheme (matching a ‘scheme’ value in ‘geographic_schemes_supported’) that ‘area’ is expressed under, if applicable
notes	string			Free-text detail on exactly what is excluded and why

data_settings.geographic_schemes_supported

Field	Type	Required	Constraints	Description
scheme	string	Yes	min length 1	The class of geocoding used to resolve hazard, e.g. ‘Coordinate’ (Latitude/Longitude), ‘PostalCode’, ‘AreaCode’, or a custom OED GeogScheme code (OED permits model/vendor-defined GeogScheme values in addition to its own list, so this is intentionally left open rather than a closed enum)
required	boolean			Whether this geocoding scheme is mandatory for the model to resolve hazard, as opposed to one of several alternative routes
oed_fields	array[string]		each item min length 1	OED location fields used by this scheme
scheme_codes	array[string]		each item min length 1	Specific GeogSchemeX (or similar) codes recognised by the model
notes	string			Free-text qualification, e.g. resolution or disaggregation behaviour

data_settings.field_behaviour

Field	Type	Required	Constraints	Description
oed_field	string	Yes	min length 1	The OED field the model reads
role	enum[string]	Yes	one of: "optional", "modifier"	Whether the field is merely consumed when present (‘optional’) or changes model behaviour when present (‘modifier’)
requires_companion_field	string		min length 1	Another OED field required to interpret this field’s value, e.g. a unit field
excluded_values	array[object]			Specific values (or ranges) of this field that suppress, cap or default the result
notes	string			Free-text detail on the field’s role

data_settings.field_behaviour.excluded_values

Field	Type	Required	Constraints	Description
value	string	Yes		The field value, code or range affected
effect	enum[string]	Yes	one of: "no_loss", "capped", "default_applied", "rejected"	What happens to the result when this value is present
notes	string			Free-text detail on the effect

data_settings.out_of_scope

Field	Type	Required	Constraints	Description
item	string	Yes	min length 1	Short name of the excluded item
category	enum[string]		one of: "loss_element", "peril", "coverage", "geography", "other"	The kind of thing being excluded
notes	string			Free-text detail on the exclusion

data_settings.additional_assets

Name, version and location of data

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	Name of the Asset file
version	string		min length 1	Version of Asset
path	string		min length 1	Filesystem path to the asset
deploy	string		min length 1	Target for deploying this additional asset

data_settings.datafile_selectors

File Selection Parameter

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	name used store the selection under
desc	string	Yes		UI description for selection
tooltip	string			Long description (optional)
model_id	integer			call to /v1/models/{id}/data_files/ to filter files by model association
allow_multiple	boolean	Yes		Allow the user to link multiple files to an analyses.
search_filters	array[object]			File options filter

data_settings.datafile_selectors.search_filters

Build a query string from the following fields

Field	Type	Required	Constraints	Description
user	string		min length 1	File was uploaded by ‘user’
filename	string		min length 1	Filename exactly matches ‘value’
filename__contains	string		min length 1	‘value’ is a substring of filename
file_description	string		min length 1	File description matches ‘value’ exactly
file_description__contains	string		min length 1	‘value’ is a substring of a File’s description’
content_type	string		min length 1	file exactly matches a MIME type
content_type__contains	string		min length 1	A files MIME type contains ‘value’

computation_settings

List of parameters that will be passed as arguments to the MDK, options are dependent on the package version. To see these look at releases 2.4.0 and up (https://github.com/OasisLMF/OasisLMF/releases)

Field	Type	Required	Constraints	Description
string_parameters	array[object]		unique items	Single string paramters
list_parameters	array[object]		unique items	List of strings parameters
dictionary_parameters	array[object]		unique items	Generic dictionary parameters
boolean_parameters	array[object]		unique items	Boolean parameters
float_parameters	array[object]		unique items	Bounded float paramters
numeric_parameters	array[object]		unique items	unbounded numeric paramters
integer_parameters	array[object]		unique items	Integer paramters
dropdown_parameters	array[object]		unique items	Generic dropdown paramters
multi_parameter_options	array[object]		unique items	Sets of parameters with pre-assigned values
parameter_groups	array[object]		unique items	Parameter Groups

computation_settings.string_parameters

User selected string value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Default ‘string’ for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.list_parameters

User selected list values

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	array[string]	Yes		Default ‘list’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.dictionary_parameters

User selected dictionarys

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	object	Yes		Defaults set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.boolean_parameters

User selected boolean option

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	boolean	Yes		Default ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.float_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	number	Yes		Default ‘value’ set for float variable
max	number	Yes		Maximum Value for float variable
min	number	Yes		Minimum Value for float variable
stepsize	number			The slider widget’s step interval for adjusting the float parameter.
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.numeric_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	number	Yes		Default integer or float ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.integer_parameters

Select float value

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	integer	Yes		Default integer ‘value’ set for variable
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.dropdown_parameters

The ‘id’ field is mapped into the analysis settings as ‘paramter_name’: ‘<id-selected>’

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
default	string	Yes		Initial setting for dropdown option
options	array[object]	Yes		Array of possible event sets
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.dropdown_parameters.options

Dropdown option

Field	Type	Required	Constraints	Description
id	string	Yes	min length 1	String value used to select an event set
desc	string	Yes	min length 1	UI description for selection
tooltip	string			Long description (optional)

computation_settings.multi_parameter_options

Parameter group option

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	UI name for selection
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
config	object	Yes		JSON object holding <parameter_name>:<value> pairs
visible	boolean			tell if parameter should be visible in UI
editable	boolean			tell if parameter should be editable in UI

computation_settings.parameter_groups

Defines which parameter are related

Field	Type	Required	Constraints	Description
name	string	Yes	min length 1	Reference for the group element
desc	string	Yes	min length 1	UI description for selection
used_for	enum[string]		one of: "all", "generation", "losses"	Set if this parameter is ONLY used at input ‘generation’ or for output ‘losses’
tooltip	string			Long description (optional)
priority_id	integer	Yes		Set which parameter groups to display first
presentation_order	array[string]	Yes	each item min items 1	List of parameters reference by their ‘name’ property
collapsible	boolean			Boolean to mark if this parameter group is collapsible
default_collapsed	boolean			Boolean to mark if parameter group starts collapsed