More in Learn

Grid Relation Component

The grid relation component allows you to add one or more grids to specific catalogue items, allowing editorial users to dynamically link grids for associating groups of products and documents organized in a matrix.

Grid Relation Component Usage

Once one or more grid organizers have been created within your tenant, you can use the grid relation component to add those grids to products, documents, and folders.

When adding this component to a shape or piece, you can specify the following:

  • Name (required) - A name for the component.
  • Identifier - String that will be generated based on the component name when shape/piece is created or updated. You’ll use the identifier to reference the component programmatically.
  • Description - An optional description of what the component should contain. This will be visible to anyone who adds content to the component later.
  • Localized Content - If Yes, then you can store different grids for each language set up within your tenant. If No, then the same grid(s) will be shared across all languages.
  • Min/Max - Optionally set minimum and/or maximum limits on the number of grids that may be added to this component.
Grid relation component on shape

When creating or editing content, you can add a grid by typing the grid’s name into the search bar. Once a grid has been added, the action button (…) in the top-right corner of the grid provides the following options: Go to grid (allowing you to edit the grid), and Remove grid. Changes made to grids will automatically carry through to the catalogue items that link to them.

Grids are translatable. If you have multiple languages set up within your tenant, you’ll be able to see each translation by using the Language drop-down menu at the top of the screen to switch between languages.

Grid relation component usage

Catalogue API Access

Once created, grid relation components and their content are accessible via the Catalogue API. Refer to our sample query for retrieving grid relation component content, and to the API docs at https://api.crystallize.com/your-tenant-identifier/catalogue for more information.

People showing thumbs up

Need further help?

Join and ask our
slack community.

Join our slack community