dynamic_shared_extensions - Model files

See Shared extension models for an overview of extension models.

Routes each user to a shared extension model based on the user’s user attributes. Each entry maps user attribute values to extension model names. Use it for per-customer models, localization, or other user-specific customization.

Syntax

Each extension must use either mappings (explicit) or map_pattern (programmatic), but not both.

dynamic_shared_extensions:
  - user_attribute: <user_attribute_reference>
    mappings:
      <extension_model_name>:
        values_for_model: [<user_attribute_value>, ...]

dynamic_shared_extensions:
  - map_pattern: "<template_with_{{omni_attributes.attribute_name}}>"

Properties

object[]

required

A list of dynamic extensions to apply to the model. Each extension must specify either mappings or map_pattern, but not both.

Hide dynamic_shared_extensions properties

string

The reference of the user attribute that determines which extension to apply. Required when using mappings. Optional when using map_pattern — if omitted, attributes referenced in the pattern are used.

object

A map of extension model names to the user attribute values that trigger them. If a user’s user_attribute value is included in a mapping’s values_for_model list, the corresponding extension model (the mapping key) is applied. If no mapping matches, no extension is applied.

Hide mappings properties

object

required

A key whose name matches the name of the extension model to apply.

Hide extension_model_name properties

string[]

required

A list of values for the referenced user_attribute. When the user’s attribute value matches any value in this list, the extension model is applied.

string

A Mustache template string that generates extension model names from user attribute values. Use {{omni_attributes.<attribute_name>}} placeholders to reference user attributes.At query time, the placeholders are substituted with the current user’s attribute values to produce one or more extension model names. If the generated name matches an existing extension model, it’s applied; otherwise it’s silently skipped.Note: User attributes can have multiple values. In this case, Omni will try all values for the attribute. Multiple matches may occur as a result.If the pattern references multiple attributes and the user has multiple values for one or more of them, Omni generates all combinations.

Examples

Explicit customer extensions

In this example, users with a customer_id of blobs_r_us have the blobs_r_us extension model applied; users with mega_blobs have the mega_blobs extension model applied.

Apply per-customer extension models

dynamic_shared_extensions:
  - user_attribute: customer_id
    mappings:
      blobs_r_us:
        values_for_model: [blobs_r_us]
      mega_blobs:
        values_for_model: [mega_blobs]

Localize model by language attribute

In this example, each extension model (model_es, model_fr, model_de) overrides view and field labels with translated values for that language.

Localize the model by language

dynamic_shared_extensions:
  - user_attribute: language
    mappings:
      model_es:
        values_for_model: [es, spanish]
      model_fr:
        values_for_model: [fr, french]
      model_de:
        values_for_model: [de, german]

Users with the language attribute set to es or spanish have the model_es extension applied, and so on. Users whose attribute value doesn’t match any entry in a values_for_model list have no extension applied.

Programmatic extensions by department

In this example, the user’s department attribute value is substituted into the pattern to produce the extension model name.

Programmatically apply per-department extension models

dynamic_shared_extensions:
  - user_attribute: department
    map_pattern: "{{omni_attributes.department}}_extension"

A user with department: marketing has the marketing_extension model applied; a user with department: sales has sales_extension applied. This avoids enumerating each department explicitly, but requires extension model names to follow a set pattern.

Create a pattern with multiple user attributes

In this example, both department and region are combined to generate the extension model name.

Combine multiple attributes in the pattern

dynamic_shared_extensions:
  - map_pattern: "{{omni_attributes.department}}_{{omni_attributes.region}}_model"

A user with department: marketing and region: us has the marketing_us_model extension applied. If a user has multiple values for either attribute, all combinations are generated and any matching extension models are applied.

Getting started

Manage content

Analyze & build

Visualize & present

Deliver content

Model data

Manage integrations

dynamic_shared_extensions - Model files

Syntax

Properties

Examples

Explicit customer extensions

Localize model by language attribute

Programmatic extensions by department

Create a pattern with multiple user attributes

​Syntax

​Properties

​Examples

​Explicit customer extensions

​Localize model by language attribute

​Programmatic extensions by department

​Create a pattern with multiple user attributes

Syntax

Properties

Examples

Explicit customer extensions

Localize model by language attribute

Programmatic extensions by department

Create a pattern with multiple user attributes