Skip to main content
More in Learn

Create and Edit Topic Maps

Within the Crystallize App, you can create as many topic maps as required for your Crystallize tenant to provide a rich taxonomy for catalogue items. Each topic map has its own representation of semantic relationships between topics, and topics can be assigned to any product, document, or folder.

Creating a Topic Map

Topics allow you to categorize catalogue items in a hierarchical fashion (ex. materials, country of origin, genres). You can then leverage this multi-dimensional categorization within your frontend(s). For instance, you could allow users to view all your wines from Italy, or all vegetarian recipes. You could separate different types of blog posts for enhanced browsing (article, recipe, release announcement).

A tenant's topic maps can be managed via the PIM API or the Crystallize App. To do so, you'll first need the requisite permissions for Topics (read, create, etc). Refer to our documentation on roles and permissions for more information.

Within the Crystallize App, you can click the Topic Maps button on the left-hand side of the screen. You can also bring up the command palette with CTRL+K or ⌘+K and type “Topics.” From here, you can either click the plus sign button (+) or the + Create topic map button. Type in a name for the topic map, then hit Enter or click Create.

Topic maps main screen

The root node of the topic map has several buttons:

  • Clicking the button at the top of the card collapses and expands the entire topic map.
  • The Developer view button switches to the internal GraphQL explorer, showing you the GraphQL query that can be used to retrieve topics and paths. You can return to the topic map by accessing the View drop-down menu at the top of the screen and choosing Pretty.
  • The Items button tells you what items (products, folders, and documents) in your tenant are using the topic map.
  • The plus sign button (+) creates new topics at the next level down in the map. Once created, you can type in names for these topics. Clicking the plus sign button (+) on lower-level topics provides most of the same options described above, and also allows you to delete the topic.

As the topic map gets bigger, you can click and drag to move it around, or scroll with your mouse to zoom in and out on it. Use the Reset zoom button in the bottom-right corner to recenter the view on the base-level topic.

Changes made to the topic map are automatically saved, but won’t be made publicly available until you click the Publish Changes button at the top of the screen.

If you wish to delete the topic map, click the action button (...) at the top of the screen and choose Delete.

Topic Maps in Multiple Languages

If you’ve defined multiple languages in your tenant, there will be a translation of your topic map for each of these languages. You can switch between different translations using the Language drop-down at the top of the screen. Refer to our Configuring Languages page for more information.

Attaching Topics to Catalogue Items

You can add any number of topics to products, documents, and folders within the catalogue. When editing an item, scroll down to the Topics section, click the plus sign button (+), then start typing the name of the topic you want to assign.The search tool will return all existing topics that match your input. Left-click on the one you want to select, or use the arrow keys to scroll down and press Enter on the desired topic. To remove a topic, click the X on the right-hand side of its corresponding label.

Add topic to item

Topic Map-Related Webhooks

You can (optionally) set up webhooks to subscribe to topic map-related events. In Crystallize, events are fired whenever topic maps are

  • Created
  • Updated
  • Deleted

You can set up a webhook, then come up with your own way of responding to events. For more information, read about defining webhooks here.

Catalogue API Access

Once created, topic maps are accessible via the Catalogue API. Refer to our sample queries for fetching topics and fetching topics by path, available at our example repository. You can also refer to the API docs at for more information.

Check Out Our Topic Map Livestream

People showing thumbs up

Need further assistance?

Ask the Crystallize team or other enthusiasts in our slack community.

Join our slack community