Skip to main content

Project Maps

Digital Experience Composition (DXC) Catalyst Customers Only

This feature is currently only available through our Digital Experience Composition (DXC) Catalyst Customer Success program. If you're interested in joining this program, please reach out to your Uniform contact or email us at customer-success@uniform.dev.

Keep an eye on our social media and What's New page to be the first to know when this feature is generally available.

To better support composable architectures that include large-scale web properties or experiences with hierarchical content, Uniform includes project map management in Canvas.

Add a project map

  1. In Uniform, navigate to Canvas > Project Map.

  2. Enter the following values:

    FieldValue
    NameA descriptive name for the project map.
    Base URL (optional)Base URL is used to create urls for the pages in Project Map so they can be previewed. This value can also be used for generating a sitemap.xml file.
  3. Click Create Project Map.

  4. The project map is displayed.

Add nodes to a project map

  1. In Uniform, navigate to Canvas > Project Map.

  2. Hover your mouse either above or below an existing node.

  3. Depending on whether you are adding a new child or a new sibling node, you must click either Add new child or Add here.

  4. Enter the following values:

    FieldValue
    Node type
    • Composition means the node represents a composition. You'll be able to create a new composition right here or select an existing one.
    • Placeholder means you do not yet have any composition for your node yet and you are only setting up a project structure, or that you are creating a parent node that does not have any content and plays role of structural parent in your tree (e.g. if you have product page urls like these /products/t-shirt and /products/jeans, but you don't have an actual /products page. However, you need a /products parent node to exist to have a valid site tree).
    CompositionThis field only applies when the "Node type" is set to "Composition".
    NameHuman-friendly name for your node. If in the "Node type" settings you specified that a new composition should be created, this value is used as the name of the new composition.
    Path segmentPre-populated from the name field but can be any slug-like string.
  5. How you save the node depends on the "Node type" you specified. Click one of the following options:

    • Save & open Canvas - Create a node and composition and redirect to newly created composition page to start creating content there.
    • Save & add another - Create a node but keep the "Add node" drawer opened to create a next sibling right away.
    • Save & close - Create a node but keep the "Add node" drawer opened to create a next sibling right away.

Delete a project map

  1. In Uniform, navigate to Settings > Canvas Settings.
  2. Scroll to the section Add Project Map.
  3. Click the ... button and click Delete.
  4. Click OK to delete the project map.

Edit a project map

  1. In Uniform, navigate to Settings > Canvas Settings.
  2. Scroll to the section Add Project Map.
  3. Click the name of the project map.
  4. Edit the fields you want to change.
  5. Click Save Project Map.

Get project map ID

The project map ID is used when fetching data using the Uniform API.

tip

For more information on interacting with project maps programmatically, see the development guide.

  1. In Uniform, navigate to Settings > Canvas Settings.
  2. Scroll to the section Add Project Map.
  3. The ID for each project map is displayed.