Client Side Processing key/value pair group | NAGRAVISION Documentation Portal

Overview

A Client Side Processing key/value pair group serves as a marker indicating that the rail requires bespoke processing either in addition to, or instead of, that of a standard rail (see below).

The following fields are all within the extendedAttributes block in the configurationProperties block.

Keys	Type	Values	Description
`type`	static	`clientside`	The `type` field defines the category of KVP group. The clientside type serves as a marker indicating that the rail requires bespoke processing either in addition to, or instead of, that of a standard rail. Depending on the requirements, these special rails: May have content added to them in the normal manner May require the client to build the entire rail structure itself May require additional / different processing of the content and/or the entire rail May require any mix of the above This allows for greater flexibility in content presentation, filtering, and personalisation based on user interactions, preferences, or local device conditions. Unlike static rail types that retrieve and display predefined content, clientside enables real-time modifications without requiring back-end updates. It can be used for features such as dynamically generated recommendations, locally cached content, or interactive filtering within a rail.
`identifier`	string		The `identifier` is a unique string used by the client to determine the specific client-side logic or rendering behavior required. This allows the client to distinguish between different variations of the same `type` and apply the appropriate processing, layout, or interaction patterns.
`client_context`	array (string)		The `client_context` is an optional field that provides additional contextual hints related to the KVP group use case. Each entry in the array represents a specific hint or configuration detail for the client to interpret, and each may affect how the blueprint is rendered or interacted with.

Keys

Type

Values

Description

type

static

clientside

The type field defines the category of KVP group.

The clientside type serves as a marker indicating that the rail requires bespoke processing either in addition to, or instead of, that of a standard rail. Depending on the requirements, these special rails:

May have content added to them in the normal manner
May require the client to build the entire rail structure itself
May require additional / different processing of the content and/or the entire rail
May require any mix of the above

This allows for greater flexibility in content presentation, filtering, and personalisation based on user interactions, preferences, or local device conditions.

Unlike static rail types that retrieve and display predefined content, clientside enables real-time modifications without requiring back-end updates. It can be used for features such as dynamically generated recommendations, locally cached content, or interactive filtering within a rail.

identifier

string

The identifier is a unique string used by the client to determine the specific client-side logic or rendering behavior required. This allows the client to distinguish between different variations of the same type and apply the appropriate processing, layout, or interaction patterns.

client_context

array (string)

The client_context is an optional field that provides additional contextual hints related to the KVP group use case. Each entry in the array represents a specific hint or configuration detail for the client to interpret, and each may affect how the blueprint is rendered or interacted with.