Version:
Cohesiondx.com

    Package export and import

    You can export DX8 configuration in full or in part as a package that can be imported into a different website. This provides a way for you to share styles, components, templates and other DX8 configuration with other websites. This capability is provided by the DX8 sync module. 

    DX8 sync works out all dependencies that a DX8 configuration entity has on other DX8 configuration entities. For example, if you export a DX8 component, it will work out what colors, font stacks, styles and other DX8 configuration it relies on and include this within the package.

    You can only export from one website to another if the receiving website is on the same version of DX8 if the version is prior to 5.4.0. From version 5.4.0 you and import/export from an earlier version (starting from 5.4.0) into a later version. You cannot import DX8 configuration from a newer version into an older version.

    Install DX8 sync

    To enable the export and import of DX8 configuration, first install the DX8 sync module.

    Creating a sync package

    Creating a sync package allows you to select specific DX8 entities to include, which can then be exported as a yaml file.

    To create a sync package: 

    1. Navigation to DX8 > Sync packages > Manage packages > Add package
    2. Enter a name for your Sync package in the Title field
    3. Enter an optional description in the Description field
    4. Select the entity types to be excluded from the package, leave unchecked to allow all entity types
      Click Set excluded entity types to set entities to exclude

       
    5. Select the DX8 configuration you want to include within the package
    6. Click the Build package button
    7. Once the dependencies have been calculated, the Package contents accordion will be populated with the entities to be included in the package, this includes any dependencies. Dependencies can be uncheck to not be included in the package 
    8. Click the Save package button.

    Exporting a Sync package

    To export a sync package:

    1. Navigation to DX8 > Sync > Packages
    2. Click the Export package as file button next to the package you want to export, this will download the selected package as a .yml file.

    Export a single DX8 entity

    To export a single DX8 entity:

    1. Navigate to the DX8 entities list builder page
      For example DX8 > Components > Components
    2. Find the Entity you want to export
    3. Click the operations dropdown
    4. Click Export package to file

    Exporting full DX8 configuration

    To export full DX8 configuration:

    1. Navigation to DX8 > Sync > Packages
    2. Click the Full export settings tab
    3. Select ENTITY TYPE at the top to select all entity types
    4. Click Save configuration
    5. Click the Export full package tab
    6. Click Download file button. 

    Importing a Sync package 

    To import a sync package:

    1. Navigation to DX8 > Sync > Import
    2. Choose your package file
    3. Click the Import button
    4. Once the import process has completed you will see a report of what the import has done.

    This process will import the package into your website.

    If the receiving website already includes any of the same DX8 configuration you will be asked if you want to Overwrite or Keep existing configuration. It only provides this choice when there is a difference in the configuration. 

    Locking DX8 entities

    You can lock DX8 entities, this will stop the entity from being overridden when importing the same entity if changes are detected. 

    This example will show locking of a component. The below process is the same for other DX8 entities.

    1. Navigate to a DX8 > Components > Components 
    2. Find the Component you want to lock
    3. Click the operations dropdown
    4. Click lock entity

    Find out about using DX8 sync for your website deployment.

    Cohesion DX8 Help center

    Launch our Help center to raise a support ticket or search our knowledge base of common questions and answers.

    DX8 knowledge base icon

    Knowledge base

    Get instant answers to common questions. Available online 24/7.

    Find answers

    Raise a ticket icon

    Raise a support ticket

    Log in to the Help center to raise an issue. Available Monday - Friday, 09:00 - 17:00 GMT.

    Raise ticket