Skip to content

Json Configurations Table View

TL;DR — Use this generated field table to check property paths, types, required status, defaults, and descriptions.

When to use

Use this page when you need the exact field path or value type for a hook configuration before editing YAML.

YAML configuration

The table below mirrors the schema used by the YAML scaffold page. Nested rows use dotted paths and [] for list items.

Property Path Type Required Default Description
GeneratorConfiguration object or string ✖ Supports generating data from Json data sources. DataSources: Used, should only be a single one and must contain data deserialized into Json (JsonNode). SessionData: Passed to used DataSources.
GeneratorConfiguration.Count integer or string ✔ The Number of generations
GeneratorConfiguration.JsonDataSourceName string ✔ DataSource name that contains json
GeneratorConfiguration.OutputObjectType one of [Json / Binary / ProtobufMessage / Xml] ✖ Output type of generation's Json, parsing the result to a specific type
GeneratorConfiguration.JsonFieldReplacements list or string ✖ Field injections to generation's Json
GeneratorConfiguration.JsonFieldReplacements[] object or string ✖
GeneratorConfiguration.JsonFieldReplacements[].Path string ✔ The path (JSONPath query language Feb 2024, by Stefan Gossner) of the field to inject to
GeneratorConfiguration.JsonFieldReplacements[].ValueType one of [Null / FromDataSource / DateTime / UnixEpochTime / String / Boolean / Integer / Double / ByteArray] ✖ The type of static field injection to use
GeneratorConfiguration.JsonFieldReplacements[].Boolean object or string ✖ The value of the field if the type is 'Boolean'
GeneratorConfiguration.JsonFieldReplacements[].Boolean.Value string or true/false ✖ The literal value to inject when this manual value configuration is selected.
GeneratorConfiguration.JsonFieldReplacements[].ByteArray object or string ✖ The value of the field if the type is 'ByteArray'
GeneratorConfiguration.JsonFieldReplacements[].ByteArray.Value string ✖ The literal value to inject when this manual value configuration is selected.
GeneratorConfiguration.JsonFieldReplacements[].DateTime object or string ✖ The date-time field configuration
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Day integer or string or null ✖ Constant Day of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.DayOffset integer or string ✖ 0 Day offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Format string ✖ o Format of the date time (default ISO 8601 without Tim Zone)
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Hour integer or string or null ✖ Constant Hour of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.HourOffset integer or string ✖ 0 Hour offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Millisecond integer or string or null ✖ Constant Millisecond of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.MillisecondOffset integer or string ✖ 0 Millisecond offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Minute integer or string or null ✖ Constant Minute of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.MinuteOffset integer or string ✖ 0 Minute offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Month integer or string or null ✖ Constant Month of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Second integer or string or null ✖ Constant Second of the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.SecondOffset integer or string ✖ 0 Second offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].DateTime.TimeZone string or null ✖ Timezone of the date time (default UTC)
GeneratorConfiguration.JsonFieldReplacements[].DateTime.Year integer or string or null ✖ Constant Year of the date time
GeneratorConfiguration.JsonFieldReplacements[].Double object or string ✖ The value of the field if the type is 'Double'
GeneratorConfiguration.JsonFieldReplacements[].Double.Value number or string ✖ The literal value to inject when this manual value configuration is selected.
GeneratorConfiguration.JsonFieldReplacements[].FromDataSource object or string ✖ The generation field configuration
GeneratorConfiguration.JsonFieldReplacements[].FromDataSource.Name string ✔ The name of the data source to use for the value of the field
GeneratorConfiguration.JsonFieldReplacements[].FromDataSource.OutOfRangePolicy one of [Null / Loop] ✖ The policy to use if the data source is out of range
GeneratorConfiguration.JsonFieldReplacements[].Integer object or string ✖ The value of the field if the type is 'Integer'
GeneratorConfiguration.JsonFieldReplacements[].Integer.Value integer or string ✖ The literal value to inject when this manual value configuration is selected.
GeneratorConfiguration.JsonFieldReplacements[].String object or string ✖ The value of the field if the type is 'String'
GeneratorConfiguration.JsonFieldReplacements[].String.Value string ✖ The literal value to inject when this manual value configuration is selected.
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime object or string ✖ The unix epoch time field configuration
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Day integer or string or null ✖ Constant Day of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.DayOffset integer or string ✖ 0 Day offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Hour integer or string or null ✖ Constant Hour of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.HourOffset integer or string ✖ 0 Hour offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Millisecond integer or string or null ✖ Constant Millisecond of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.MillisecondOffset integer or string ✖ 0 Millisecond offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Minute integer or string or null ✖ Constant Minute of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.MinuteOffset integer or string ✖ 0 Minute offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Month integer or string or null ✖ Constant Month of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Second integer or string or null ✖ Constant Second of the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.SecondOffset integer or string ✖ 0 Second offset from the date time
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.UnixEpochObjectType one of [Long / String] ✖ Epoch Unix Time Object Representation
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.UnixEpochScaleType one of [Seconds / Milliseconds] ✖ Epoch Unix Time Scale Representation
GeneratorConfiguration.JsonFieldReplacements[].UnixEpochTime.Year integer or string or null ✖ Constant Year of the date time
GeneratorConfiguration.OutputObjectTypeConfiguration object or string ✖ Output type of generation's Json configuration
GeneratorConfiguration.OutputObjectTypeConfiguration.TypeFullName string ✔ The full name (including path) of the type
GeneratorConfiguration.OutputObjectTypeConfiguration.AssemblyName string or null ✖ The name of the assembly the type is located in, If no value is given by default tries to take the entry assembly

Edge cases

  • Empty default cells mean the schema does not define a default value for that field.
  • Required status applies to the immediate parent object shown by the property path.

See also