Schema Fragments

The shared library of schema fragments enables users to create, maintain, and reuse standardized schema fragments across child organizations, projects, and journeys within Xponent. By templatizing these schema elements, owners can significantly reduce the effort required to set up new projects, ensuring faster implementation, higher consistency, and greater accuracy across CSG and CX ecosystem integrations.

Without shared fragments, initiating a new journey involves manual schema creation. This is inefficient and error-prone, especially when working with standardized APIs that don’t often change. The shared library addresses this by centralizing reusable components so that configurers can plug and play with confidence, knowing the structure adheres to best practices.

To access the shared schema fragments:

1. Navigate to the Library module through your parent organization context.

2. Select the Fragments tab.

3. On the left-hand side, you’ll see a list of existing schema fragments, if any have already been created for your organization.

4. If the list is long, you can scroll or use the search bar to quickly find a specific fragment by search feature.

If you’re accessing this from a newly created organization, the fragment list may be empty until schema fragments are added.

 The ability to create schema fragments is limited to internal CSG staff. To request the creation of a new reusable schema fragment, please reach out to your Xponent Support.

Each schema fragment includes version details, status (Draft, Published, or Archived).

• Draft: Shown with red text and labeled as Draft. These are editable and not yet available for use in graphs.

• Published: Indicated by an eye icon. These are finalized, read-only versions that can be used in graphs.

• Archived: Marked with an eye icon crossed out (strikethrough), indicating that the previously published schema has been archived. Archived fragments are hidden and can not be used to replace the existing graph configurations.

  

New Schema Fragments

The process of creating a schema fragment involves two main steps: drafting the fragment and then publishing the schema definition.

Create Draft Fragment

For creating the draft first, click Create Fragment and fill in the required details:

• Parent: Select a parent category that represents a product line or logical group. If the appropriate parent is not listed, you can create a new one.

• Fragment Name: Enter a unique name for the fragment. You can create multiple fragments under the same parent.

• Description: Provide a meaningful description to explain the purpose. For Example - Ascendon Order Schema

• Version: Use semantic versioning that aligns with the version of the internal or external data model. For Example - 1.0.0, 1.0

Click Create Draft. The new fragment will appear under the selected parent with a Draft status. Draft fragments are visible only internally and can be access while importing or replacing the fragment through graph.

Access and Permissions ⚠️

• Only users with the Owner role in the parent organization can access, create and modify fragments.

• All users can import and replace the published fragments in to the schema.

• Draft fragments can be deleted only by the owner who created them.

Publish Schema

Before a draft fragment can be published, you need to define its schema structure:

1. In the draft fragment list, click on the pencil icon to open and edit the fragment. The schema editor will now be enabled for editing.
   

2. Inside the schema section:

   1. Select the schema and click on the + icon to manually add child fields one by one or

   2. Click on the {JSON} icon to paste the entire schema using JSON format.

3. While the fragment is in draft, you can freely edit or delete any fields as needed. Once your schema definition is complete, click Publish Schema to finalize the fragment. Your fragment is now published and ready to be imported into the graphs schema.

Creating a New Version of an Existing Schema Fragment

To modify an existing schema fragment, you must create a new version of it. This ensures that the original published version remains unchanged and continues to function wherever it is already in use. You can copy the existing schema and make the necessary modifications.

To create the next version of a schema fragment:

1. Click on the ➕ (plus) icon in front of the fragment name, for which you want to modify the schema:

2. Select the same Parent and Fragment Name from the dropdown list.

3. Enter the next version number. For Example: 2.0, 1.1.0, or 1.0.1, based on your internal versioning standards.

4. Click Create Draft. This action creates a draft of a new version that is pre-filled with the schema structure from the selected published version.

5. After the draft is created, make the required schema changes.

6. Once your edits are complete, click Publish Schema. The new version becomes available in the Library and can be used to replace the schema fragment inside any graph schema.

Schema fragments cannot be modified once published. To make any changes, you must:

1. Create a new version.

2. Edit it in draft mode.

3. Publish it when everything is ready.

 If you do not need to make any changes to the schema content but still want to create a new fragment, you can directly create and publish the schema.