Recipes: Changing default recipe options

A recipe has many options in different sections that default to sensible values.

Market data options

Option

Default value

Explanation

attemptToInferMissingFx

false

Set to true to infer missing FX rates. For example, if a AUDJPY rate is required for a valuation but cannot be located in the Quote Store, then:

  1. If a JPYAUD rate is located LUSID returns the inverse: 1/JPYAUD.

  2. LUSID triangulates through USD, GBP and EUR base currencies in that order. So for example if USDAUD and USDJPY are located LUSID returns USDJPY/USDAUD.

For more information on FX inference/triangulation and worked examples, see this Jupyter Notebook.

calendarScope

CoppClarkHolidayCalendars

Set to the scope of a different holiday calendar. You can then specify code(s) of this calendar in various places (such as the definitions of instruments with a term structure) to cause LUSID to automatically factor in market holidays when (for example) generating cashflows. 

For more information on these and other market data options, see the API schema reference.

Pricing model options

Option

Default value

Explanation

allowPartiallySuccessfulEvaluation

false

Set to true to allow the valuation process to continue if failures are encountered.

produceSeparateResultForLinearOtcLegs

false

Set to true to value the legs of instruments such as futures, FxForwards and interest rate swaps separately.

For more information on these and other pricing model options, see the API schema reference.

Aggregation options

Aggregation is the process of deciding which of the many metrics LUSID can calculate to include in your valuation report. 

Metrics themselves are not specified in a recipe but rather in a call to the GetValuation API. However, aggregation options are stored in a recipe.

Option

Default value

Explanation

applyIso4217Rounding

false

Set to true to round metrics that report currency values to the ISO 4217 standard number of decimal places.

For more information on this and other aggregation options, see the API schema reference.