# Add the Marketplace app to Contentstack
> The Uniform app in the Contentstack Marketplace enables content managers to use Uniform capabilities within the Contentstack user interface.
Source: https://docs.uniform.app/docs/integrations/content/contentstack/uniform-in-contentstack
The [Uniform app](https://www.contentstack.com/marketplace/uniform/)
in the Contentstack Marketplace enables content managers to use
Uniform capabilities within the Contentstack user interface.
- **Classification** - Assign enrichment tags to Contentstack entries.
These tags describe data you want to track on the visitor who views
the entry. For example, you might want to track that a visitor is
interested in making a purchase when the visitor views a specific
entry.
- **Personalization** - Associate personalization conditions with
Contentstack entries. For example, you might have a hero entry
that should only be shown to visitors coming from a specific
geographic region.
- **A/B testing** - Specify content entries that make up an A/B test.
For example, you might want to try a variety of different hero
components on your home page in order to determine which one
is most effective.
## Add Uniform to your stack
This section guides you through the process of adding the
Uniform app from the Contentstack Marketplace.
You must have access to a Uniform team with the ability to create new projects. If you are an active customer or a partner, please get in touch with your Uniform team administrator colleague and ask for an invite.
If you are not sure or your company does not have a Uniform team, you can request a sandbox [here](https://uniform.dev/try?utm_source=docs).
> **Before you start:**
>
> You must have the following available to complete this setup:
>
> - Contentstack account with administrator access.
### Create Uniform API key
A Uniform API key is needed in order for the Marketplace app to
read various settings involved with configuring personalization.
You need an API key with the following permissions:
```
Uniform Context > Read Drafts
Uniform Context > Manifest > Read
```
> **Tip:**
>
> For details on how to create an API key, see the instructions on [how to create a Uniform API key](https://docs.uniform.app/docs/guides/apis).
### Add Marketplace app
The Uniform app in the Contentstack Marketplace adds a number
of custom field types that allow content authors to configure
personalization during the content authoring process. You must
add this app to your stack.
1. In Contentstack, navigate to the Marketplace.
2. In the **Apps** section, find the Uniform app and click **Install App**.
3. Select your stack, accept the terms of service and click **Install**.
4. In the app configuration screen, scroll down to the section **Now let's connect this app...**.
5. Paste your Quick Connect API key in the field.
> **Note:**
>
> This is the value you copied when you created the API key in Uniform.
6. Click **Connect**.
> **Note:**
>
> If the Quick Connect API key you entered is valid, you will see
> a message indicating the Marketplace app was able to connect to
> your Uniform project.
7. Now that you have Uniform app added to your stack, some new
custom field types are available to add to your content models.
## Enrichment tagging
Enrichment tags can be assigned to Contentstack entries. When
your front-end application has classification activated, Uniform
uses these tags to classify the visitor when the entry is viewed.
> **Before you start:**
>
> You should have at least one [enrichment](https://docs.uniform.app/docs/guides/classification/enrichments)
> defined in your Uniform project. You can enable enrichment tagging
> without having any enrichments defined, but you won't be able to
> complete all the steps in this section without them.
### Enable enrichment tagging
You must specify which content types you want content authors
to be able to assign enrichment tags to.
1. In Contentstack, open your stack.
2. Open your content type.
3. Add a new field using the **Custom** type.
4. Enter the following values:
| Property | Value |
| --- | --- |
| Display Name | `Enrichments` |
| Unique ID | `enrichments` |
| Select Extension/App | **Uniform Context - Enrichment Tags** |
5. Save your changes.
### Assign enrichment tags
A content author must assign enrichment tags to content entries.
1. In Contentstack, open your stack.
2. Navigate to an entry based on one of the content types you enabled enrichment tagging on.
3. Scroll down to the field **Enrichments**.
4. Click **here**.
5. Select the tag you want to assign.
> **Note:**
>
> The value for _Strength_ indicates how much the visitor score
> increases when the content entry is viewed. The visitor score
> can act as the basis for [personalization criteria](#personalization-criteria).
6. Click **Add**.
> **Tip:**
>
> At this point there are several things you can do:
>
> - Change the strength value using the input field.
> - Add more enrichment tags by clicking **Add More**.
> - Publish your changes in Contentstack.
> - Manage enrichments in Uniform by clicking **Manage Enrichments**.
## Personalization criteria
Personalization criteria can be assigned to Contentstack entries.
This criteria describes the conditions when the Contentstack entry
is appropriate to use. When your front-end application has
classification and personalization activated, Uniform can show
and hide content based on the criteria you configure.
### Enable personalization criteria
You must specify which content types you want content authors
to be able to assign personalization criteria to.
1. In Contentstack, open your stack.
2. Open your content type.
3. Add a new field using the **Custom** type.
4. Enter the following values:
| Property | Value |
| --- | --- |
| Display Name | `Personalization Criteria` |
| Unique ID | `personalization_criteria` |
| Select Extension/App | **Uniform Context - Personalization Criteria** |
5. Save your changes.
### Assign personalization criteria
A content author must assign personalization criteria to content entries.
1. In Contentstack, open your stack.
2. Navigate to an entry based on one of the content types you enabled personalization criteria on.
3. Scroll down to the field **Personalization Criteria**.
4. Click **Add Criteria**.
5. Configure the criteria you want to assign.
> **Tip:**
>
> At this point there are several things you can do:
>
> - Change the criteria.
> - Add more criteria by clicking **Add Criteria**.
> - Publish your changes in Contentstack.
## Personalization lists
Personalization lists allow you to create lists of content
entries where the personalization criteria assigned to the
entries is used to determine which entries to display to a
visitor.
### Define a personalization list
A personalization list is a reference field that a content
author can assign the content entries that represent the
personalized content.
1. In Contentstack, open your stack.
2. Navigate to a content type into which a content author would want to add personalization.
> **Note:**
>
> For example, if you have a content type that represents
> a page, you might want to add a personalized hero to the
> page. In this case, you would use the page content type.
>
> Alternatively, you might want to create a new content type,
> like one that represents the personalized hero.
3. Add a new field using the **Reference** type.
4. Enter the following values:
| Property | Value |
| --- | --- |
| Display Name | `Personalized List` |
| Unique ID | `personalized_list` |
| Referenced Content Type | Select the content types that have the personalization criteria field defined on them. |
5. Click the **Advanced** tab.
6. Select the option **Multiple**.
7. Save your changes.
### Configure a personalization list
The following steps describe how to configure a personalized list.
1. Create a new content entry using the personalized list.
2. In the field **Personalized List**, add content entries.
> **Note:**
>
> You should select content entries with [personalization criteria](#personalization-criteria) configured.
## A/B testing lists
### Define an A/B testing list
An A/B testing list is a reference field that a content
author can assign the content entries that represent the
test variations.
1. In Contentstack, open your stack.
2. Navigate to a content type into which a content author would want to test.
> **Note:**
>
> For example, if you have a content type that represents
> a page, you might want to add a test to determine which
> version of a hero works best. In this case, you would
> use the page content type.
>
> Alternatively, you might want to create a new content type,
> like one that represents a hero that can be tested.
3. Add a new field using the **Custom** type.
4. Enter the following values:
| Property | Value |
| --- | --- |
| Display Name | `A/B Test` |
| Unique ID | `a_b_test` |
| Select Extension/App | **Uniform Context - A/B Test** |
5. Add a new field using the **Reference** type.
6. Enter the following values:
| Property | Value |
| --- | --- |
| Display Name | `A/B Test Variations` |
| Unique ID | `a_b_test_variations` |
| Referenced Content Type | Select the content types that have the personalization criteria field defined on them. |
7. Click the **Advanced** tab.
8. Select the option **Multiple**.
9. Save your changes.
### Configure an A/B testing list
The following steps describe how to configure an A/B testing list.
1. Create a new content entry using the A/B testing list.
2. In the field **A/B Test**, select the test.
3. In the field **A/B Test Variations**, add content entries.
## Update front-end application
Now that you have the ability to assign classification,
personlization, and testing to content, next you must
update your front-end application to activate these
capabilities.
### Add environment variables
Your front-end application must read the various classification and testing settings that are configured in your Uniform project. The Uniform manifest file makes this information available to your front-end application.
| Uniform value | Environment variable |
| --- | --- |
| API Key | `UNIFORM_API_KEY` |
| Project ID | `UNIFORM_PROJECT_ID` |
> **Note:**
>
> The front-end application will use these environment
> variables to read the classification and testing
> settings from your Uniform project.
### Add Context to app
**Next.js (app router)**
1. Add the following npm packages to your front-end application:
`npm`
```shell
npm i @uniformdev/canvas-next-rsc
```
2. Add the following file to the root of your front-end application:
`uniform.server.config.js`
```js
/** @type {import('@uniformdev/canvas-next-rsc/config').UniformServerConfig} */
module.exports = {
defaultConsent: true,
};
```
3. Add the following to your `layout.js` or `layout.tsx` file:
```jsx
import { Inter } from "next/font/google";
import "./globals.css";
import { UniformContext } from "@uniformdev/canvas-next-rsc";
const inter = Inter({ subsets: ["latin"] });
export const metadata = {
title: "Create Next App",
description: "Generated by create next app",
};
export default function RootLayout({ children }) {
return (
{children}
);
}
```
> **Note:**
>
> It is important that the `UniformContext` component be
> an ancestor of any component that will use any Uniform
> functionality.
**Next.js (page router)**
1. Add the following npm packages to your front-end application:
`npm`
```shell
npm i -D @uniformdev/cli
npm i @uniformdev/context @uniformdev/context-react cookie
```
2. Add the following to the `scripts` section in your `package.json` file:
```json
"download:manifest": "uniform context manifest download --output ./contextManifest.json",
```
> **Note:**
>
> This script downloads the latest published manifest from the
> Uniform project identified by the environment variables you
> added earlier. Most customers will run this script when the
> front-end application starts or is built.
3. Run the following command:
`npm`
```shell
npm run download:manifest
```
> **Note:**
>
> A file `contextManifest.json` will be created. This file
> contains the details of the classification and test settings
> you configured in your Uniform project.
4. Add the following to your `.gitignore` file:
```
# uniform
contextManifest.json
```
> **Note:**
>
> This ensures the manifest file doesn't get added to your source code repository.
5. Add the following to your `_app.js` or `_app.tsx` file:
```jsx
import "@/styles/globals.css";
import {
Context,
enableContextDevTools,
} from "@uniformdev/context";
import manifest from "../contextManifest.json";
import { UniformContext } from "@uniformdev/context-react";
const context = new Context({
manifest,
defaultConsent: true,
plugins: [
enableContextDevTools(),
]
});
export default function App({ Component, pageProps }) {
return (
);
}
```
### Activate tracking
> **About this example:**
>
> In order to make these instructions easier to follow, an example
> is used. Imagine you have a content type **City** that you have
> configured to allow content authors to assign Uniform enrichments
> to. A component named **CityDetails** is used in your front-end
> application to display the content from the content type **City**.
>
> This content type will have a field `enrichments` that
> contains a JSON object that describes any enrichments that were
> assigned to the content entry. This object must be passed to the
> component responsible for tracking.
**Next.js (app router)**
**Next.js (page router)**
1. Open the component **CityDetail**:
```jsx
export const CityDetail = (props) => {
const { title, description } = props;
return (
)
}
```
> **Note:**
>
> This is the component before any tracking support is added.
2. Replace the code with the following:
```jsx
import { Track } from '@uniformdev/context-react';
export const CityDetail = (props) => {
const { title, description, enrichments } = props;
return (
)
}
```
### Activate personalization
> **About this example:**
>
> In order to make these instructions easier to follow, an example
> is used. Imagine you have a content type **Promotion** that stores
> the region, title, and description for a promotion. You want to
> allow content authors to personalize the title and description.
>
> Previously, the content type **Promotion** had separate fields
> for title and description. You followed the [instructions above](#personalization-lists)
> so content authors can associate personalization conditions
> the specific title and description values. Now, the promotion
> is a personalization list. This list has fields for the
> promotion `title` and `region`, along with a reference field
> `personalized_list` that points to content entries based on
> a content type **Promotion Details**.
>
> Each of the **Promotion Details** content entries has its own
> fields `title` and `description`, along with a field
> `personalization_criteria` that defines the
> personalization conditions.
>
> A component named **Promotion** is used in your front-end
> application to display the content from the content type
> **Promotion**.
1. Since references are involved, you must check the logic you
use to retrieve content from Contentstack. In this example,
you must retrieve fields from the referenced personalization
variations. For more information, see the [Contentstack documentation](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/javascript-browser/reference).
> **Note:**
>
> The shape of the data retrieved from Contentstack looks like
> the following when the correct link level is specified:
>
> ```js
> {
> title: "Summer Promotion",
> region: "NA",
> personalized_list: [
> {
> title: "Super Summer Savings",
> description: "Savings all summer long!",
> personalization_criteria: {
> name: {
> crit: [
> { l: "1_2", op: "+" }
> ]
> },
> }
> },
> {
> title: "Amazing Summer Promotion",
> description: "Get your summer started right!",
> personalization_criteria: {
> name: {
> crit: [
> { l: "1_1", op: "+" }
> ]
> }
> }
> },
> ]
> }
> }
> ```
**Next.js (app router)**
**Next.js (page router)**
1. Open the component **Promotion**:
```jsx
export const Promotion = (props) => {
const { title, description } = props;
return (
)
}
```
> **Note:**
>
> This is the component before any personalization support is added.
2. Replace the code with the following:
```jsx
import { useEffect, useState } from "react";
import { Personalize } from "@uniformdev/context-react";
/**
* The shape of the personalization instructions
* must be changed slightly in order to be fully
* compatible with the Personalize component.
*/
function reshapePersonalizationList(list) {
const reshaped = list.map((fields) => {
const { uid, personalization_criteria } = fields;
const variation = {...fields};
variation.id = uid;
variation.pz = personalization_criteria.name;
delete variation.personalization_criteria;
return variation;
});
return reshaped;
}
/**
* Represents the promotion fields that
* can be personalized.
*/
export const PromotionDetails = (props) => {
const { title, description } = props;
return (
);
}
/**
* Represents the entire promotion, including
* the fields that are and are not personalized.
*/
export const Promotion = (props) => {
const { title, personalized_list } = props;
const [variations, setVariations] = useState([]);
useEffect(() => {
const reshaped = reshapePersonalizationList(personalized_list);
setVariations(reshaped);
}, []);
return (
)
}
```
### Activate testing
> **About this example:**
>
> In order to make these instructions easier to follow, an example
> is used. Imagine you have a content type **Press Release** that
> stores the headline, image, date, and body for a press release.
> You want to allow content authors to test different combinations
> of headline and image.
>
> Previously, the content type **Press Release** had specific fields
> for headline and image. You followed the [instructions above](#a-b-testing-lists)
> so content authors can define the variations they want to test. Now,
> the press release is an A/B testing list. This list has fields for
> the press release `date` and `body`, along with a reference field
> `a_b_test_variations` that points to content entries based on a
> content type **Press Release Variation**.
>
> Each of the **Press Release Variation** content entries has its own
> fields `title` and `image`.
>
> A component named **PressRelease** is used in your front-end
> application to display the content from the content type
> **Press Release**.
1. Since references are involved, you must check the logic you
use to retrieve content from Contentstack. In this example,
you must retrieve fields from the referenced personalization
variations. For more information, see the [Contentstack documentation](https://www.contentstack.com/docs/developers/sdks/content-delivery-sdk/javascript-browser/reference).
> **Note:**
>
> The shape of the data retrieved from Contentstack looks like
> the following when the correct link level is specified:
>
> ```js
> {
> title: "New Product Announcement",
> a_b_test: {
> id: "winter-product-accountment",
> name: "Winter Product Announcement"
> },
> a_b_test_variations: [
> {
> title: "Super Exciting News!",
> image: {}
> },
> {
> title: "More News!",
> image: {}
> }
> ],
> date: "2024-10-10T00:00-08:00",
> body: "There is a lot of excitement around..."
> }
> ```
**Next.js (app router)**
**Next.js (page router)**
1. Open the component **PressRelease**:
```jsx
export const PressRelease = (props) => {
const { title, image, body, date } = props;
return (
{title}
{date}
{body}
)
}
```
> **Note:**
>
> This is the component before any A/B testing support is added.
2. Replace the code with the following:
```jsx
import { useEffect, useState } from "react";
import { Test } from "@uniformdev/context-react";
/**
* Set the entry id as the variation id for the test.
* understand how each variation affects visitor activity.
*/
function reshapeAbTestList(list) {
const reshaped = list.map((entry) => {
const { uid } = entry;
const variation = { ...entry };
variation.id = uid;
return variation;
});
return reshaped;
}
/**
* Represents the press release fields that
* make up the test.
*/
export const PressReleaseVariation = (props) => {
const { title, image } = props;
return (
{title}
);
};
/**
* Represents the entire press release, including
* the fields that are and are not tested.
*/
export const PressRelease = (props) => {
const { date, body, a_b_test, a_b_test_variations } = props;
const testId = a_b_test?.id ?? "unknown-test";
const [variations, setVariations] = useState([]);
useEffect(() => {
const reshaped = reshapeAbTestList(a_b_test_variations)
setVariations(reshaped);
}, []);
return (
);
};
```