Documentation Index

Fetch the complete documentation index at: https://support.lusid.com/llms.txt

Use this file to discover all available pages before exploring further.

What is a portfolio mapping and how do I create one?

Prev Next

A portfolio mapping is a preselected set of configuration options for a portfolio or portfolio group in the Rebalance dashboard.

You can create a portfolio mapping for a portfolio or portfolio group once and specify:

  • A valuation recipe

  • A rebalance configuration

  • A currency

  • One or more models and/or benchmarks

  • Rebalance bands

The Rebalance dashboard thereafter populates the mapping values automatically when a user selects that particular portfolio or portfolio group.

Note

When you add a mapping to a portfolio group, LUSID treats the group as a single portfolio in the Rebalance dashboard:

  • The Rebalance dashboard displays the portfolio group as a single row in the summary grid.

  • Instead of treating each underlying portfolio individually with its own weights totalling 100%, LUSID aggregates the weights of holdings across all portfolios in the group to total 100%.

  • If a portfolio group contains at least one child portfolio group with a portfolio mapping, LUSID treats all direct child portfolio groups as single portfolios, as above.

Setting up a portfolio mapping

You can set up portfolio mappings using any of the following methods:

  • Rebalance dashboard in the LUSID web app (recommended)

  • Property specified on the portfolio or group (for bulk updates or fringe use cases)

To set up a portfolio mapping:

  1. Sign in to the LUSID web app and navigate to Portfolio Management > Rebalance via the top left menu.

  2. Select Add mapping.

  3. Specify a portfolio mapping Display Name and select the following:

    • An existing recipe; this recipe overrides any existing recipe chosen in the Rebalance dashboard

    • A Rebalance Configuration containing rules for the portfolio or portfolio group; read more

    • The default (display) Currency for the portfolio or portfolio group; note the default currency can differ from the portfolio currency

  4. Optionally, select the corresponding tab to specify any of the following:

  5. Select Save to complete your portfolio mapping.

Note

Currently, only the following mapping areas can be configured via portfolio property:

  • Recipe ID

  • Rebalance configuration ID

  • Report currency

  • Rebalance band ID

  1. Sign in to the LUSID web app and navigate to Data Management > Portfolios or Portfolio Groups via the top left menu. Alternatively, you can configure the property with your preferred method.

  2. Select Edit on the portfolio or group that you want to configure a rebalance mapping for.

  3. Select Add property and select the RebalanceMapping property Code from the default Scope.

  4. Supply the following Value in JSON format:

    • A recipeId containing the scope and code of an existing recipe; this recipe overrides any existing recipe chosen in the Rebalance dashboard

    • A rebalanceConfigurationId containing the scope and code of an existing rebalance configuration defining rules for the portfolio or portfolio group; you can retrieve your available configuration IDs by calling the ListRebalanceConfigurations API

    • The default (display) reportCurrency for the portfolio or portfolio group; note the report currency can differ from the portfolio currency

    • A rebalanceBandSeriesId containing the scope and code of an existing rebalance band set

    For example:

    {
      "recipeId": {
        "scope": "Finbourne-Examples",
        "code": "My-Recipe"
      },
      "rebalanceConfigurationId": {
        "scope": "rebalance",
        "code": "cashbelow3warning"
      },
      "reportCurrency": "GBP",
      "rebalanceBandSeriesId": {
        "scope": "Finbourne-Examples",
        "code": "AssetClass"
      }
    }

  5. Click Save.

Note that when you select a portfolio with a property-defined rebalance mapping in the Rebalance dashboard, the mapping in the property overrides any existing mapping in the dashboard.

Once saved, your Rebalance dashboard populates the relevant columns according to your selections:

Rebalance configuration

The rebalance configuration defines a set of parameters and preferences to apply to your Rebalance dashboard and generated orders. You can create a configuration via the following methods:

General

Equivalent security identifier: Select a property to use as the lowest-level grouping for tradeable rows in the Rebalance dashboard.

For example, if you set the value to Instrument/Finbourne-Examples/AssetClass, the Rebalance dashboard groups instruments (decorated with a value for the property) by asset class:

Note

If a portfolio group contains one or more portfolios with differing rebalance configuration mappings, the Rebalance dashboard disables the Equivalent security identifier grouping.

Tolerance rules

Configure absolute and model-relative tolerance values that trigger an auto-rebalance if exceeded. You can configure the rules to apply to:

  • All holdings in the dashboard

  • Holdings with a particular property

Rounding rules

Choose how LUSID should round your instrument lot sizes; see how to add lot sizes to instruments.

Absolute rules

For each rule, you can specify:

  • An upper or lower limit for the amount in an order (in the portfolio currency)

  • Which instruments to apply the order limit to

LUSID prioritises rules in the order you specify, for example rule 1 takes precedence over rule 4.

Cash rules

You can configure one or more cash rules to have LUSID warn you when you try to create an order that will bring your cash balance to below a certain amount or percentage.

Custom values

Order presets: Pre-populate each order in the order generation form with particular properties and values for the Type and Time in force fields. You can modify these values on-the-fly when necessary.

Rebalancing to your portfolio mapping models

To rebalance based on your portfolio mapping models, select the desired instruments and use the control panel to generate orders as usual. See how to use the Rebalance dashboard control panel.

See a full tutorial on how to add a portfolio mapping and run a cash equitisation rebalance, from start to finish.