Enumerations

This article explains how to create and use an enumeration in Prepr. An enumeration is a predefined list of values that can be used in models and components.

Create an enumeration

To create an enumeration, follow these steps:

1. Click the Schema tab to open the Schema Editor.
2. Then, click the + Create enumeration button.
3. Fill in a unique Name value for the enumeration.

4. Add each of the list values and click the Save button. The Display name values are visible to content editors.

Once your enumeration is created, it's ready for you to use in a model or component.

Add the enumeration to a model or component

Go to the model or component where you want to include the enumeration and follow the steps below.

1. Add a List field to the model or component. Check out the model and component docs for more details.
2. From the Select enumeration dropdown, choose your enumeration.

And that's it. You've successfully included your enumeration in a model or component.

Organize enumerations into folders

When you have dozens of enumerations, folders make it easy to find related enumerations. For example, when you have multiple enumerations which are used in the same components.

Click the Add folder link and enter a name for the new folder. Select the enumerations that you want to include in the new folder. Click the Add folder button.

To add or remove enumerations from an existing folder, click the button next to the folder name and select Edit. You can then select or deselect the enumerations that you want to add or remove.

You can also delete the folder by selecting Delete. The folder structure will be removed and the included enumerations will return to the alphabetical list of enumerations.

Export and import an enumeration

Use the export and import if you only need a couple of enumerations copied from one environment to another. For example, export an enumeration from your production environment and import it into your development environment.

To sync a schema with models, components, enumerations and remote sources from another environment then follow the process detailed in the Sync schema doc instead.

To share the same enumerations across multiple environments, for example when an organization has different brands, but needs content in separate environments, you can create a shared schema as detailed in the Shared schemas doc.

To export an enumeration, follow these steps:

1. Click the Schema tab to open the Schema Editor.
2. Click the enumeration that you want to export from the list of enumerations on the left.
3. Click the button at the top of the enumeration.
4. Click the Export enumeration option to download a JSON file of the enumeration.

When the export is successful, you'll find the JSON file in the location you selected.

To import an enumeration, follow these steps:

1. Click the Schema tab to open the Schema Editor.
2. Then, click the + Create enumeration button.
3. Click the Import enumeration link.
4. Choose the JSON file of the enumeration that you want to import.

When the import is successful, you'll see the detailed enumeration in your schema.