Skip to main content
More in Learn

Define a New Document Shape

Documents are generic pieces of content used to enrich the customer experience. Their structure is defined by a shape, which in turn is built from multiple components and/or pieces grouped together. Examples of the types of documents you might define shapes for include articles, video stories, recipes, and blog posts.

Custom document shape

Just like folders and products, documents can contain and display a wide range of data and content as determined by their shapes. Each document shape is built up from zero or more components and/or pieces. You’ll need to do some content modeling to figure out the ideal structure(s) for your own document shape(s). Once that’s done, actually defining the shape(s) is straightforward.

Document shape example

Defining Your Document Shape

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

Within the Crystallize App, click the Settings button on the left-hand side of the screen, then choose Shapes. Click the Document shape button in the center of the screen, or click the plus sign button (+) at the top of the screen and choose Document. Type a new name for the shape, then hit Enter or click Create. You can also bring up the command palette with CTRL+K or ⌘+K and type “Create Shape,” then select the Document option.

Create document shape

On the right side of the screen is a list of the components and pieces (if any are defined) that you can add to the shape. Either left-click on them or drag and drop them to the center of the screen to add them to your shape definition. Once components and/or pieces have been added, you can click and drag on their left-hand tabs to reorder them, or you can click the action button (...) on the right-hand side to delete them. Use the Expand components toggle at the top right to access the components’ settings. Every component and piece will need to be named and properly configured, which is covered in more detail in the Concepts entry for each component.

Click the Update button at the top of the screen to save changes to the shape.

Editing Document Shapes

You can always make changes to existing document shapes, either by accessing the Shapes screen under Settings or by clicking on the shape name that appears at the top of the screen above the document name whenever you’re creating/editing a document.

Once documents have been created based on a particular shape, the View items button at the top of the shape edit screen will let you see at a glance exactly what documents use the shape. This is important because any changes made to the document shape will affect all of these documents in turn. Proceed carefully with your edits.

Deleting Document Shapes

You can only delete a document shape as long as no documents in your catalogue are using it. To do so, open the shape for editing, then click the action button (…) at the top of the screen and select Delete.

People showing thumbs up

Need further assistance?

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

Join our slack community