Channels - Bloomreach Experience - Headless Digital Experience Platform

Channels

Definition

A channel is a site that can be managed in the Experience manager app by users with the Site Editor role.

Channel is the "root" entity in the site configuration model: all other entities in the model exist as part of a specific channel.

Properties

A channel's configuration includes a content root. Any content paths configured in the entities that are part of that channel are relative to that content root.

Additionally, a channel configuration can include custom parameters that are user-configurable in the Channel properties dialog in the Experience manager.

The example below shows the JSON representation of the default channel in the sample application:

{
    "id": "brxsaas",
    "name": "BrX SaaS",
    "branch": null,
    "branchOf": null,
    "contentRootPath": "/content/documents/brxsaas",
    "locale": null,
    "devices": [],
    "defaultDevice": null,
    "responseHeaders": null,
    "linkurlPrefix": null,
    "cdnHost": null,
    "parameters": {
        "graphql_baseurl": "${public.brx.graphql.baseurl}",
        "smDomainKey": "",
        "smAccountId": "${public.brx.smAccountId}",
        "smEndpoint": "${public.brx.smEndpoint}",
        "spaUrl": "https://brxm-react-spa.herokuapp.com/"
    }
}

For a full overview of properties, see the Channel schema in the Site Management API reference documentation. 

Operations

The Site Management API currently supports update operations on channels, but not create and delete. The creation of new channels is handled inside the brX web interface: a user with the Site Admin role can create new (almost empty) channels in the channel overview of the Experience manager app.

Modification of channel configuration is only allowed in the context of a development project. As such, it is a prerequisite for using the API, that a development project for your channel exists. The Channels tab of the Projects app displays the branch ID, a sequence of 4 random alphanumeric characters prefixed with a 'v' (for example: "vIUy9"), which must be used in combination with the channel ID, separated by a dash (for example: "brxsaas-vIUy9").

The API additionally supports the management of a channelā€™s configuration parameters and their grouping in the Channel properties dialog through field groups.

See Channel Operations in the Site Management API reference documentation for a list of operations.

You can find examples of using the channel endpoints in the Postman collection.

Did you find this page helpful?
How could this documentation serve you better?
On this page
    Did you find this page helpful?
    How could this documentation serve you better?