logo
logo

Migrate changes between instances

Sitecore Content Hub offers various methods for importing and exporting information between different instances. The methods differ depending on the type of the information to transfer.

Data migration

  • Data export:

    To export entities, Sitecore Content Hub offers 2 possible methods.

    • Using asset download:

      This method is only available for Asset entities. It allows users to export asset entities into a Zip file. This method only exports the physical files and does not export the metadata of the assets.

    • Using Excel export:

      This method is available for all entities. It allows users to export entities into a single Excel file containing the list of entities along with their metadata. This method does not export physical files.

      Note: In order to export assets with their physical files and their metadata, a combination of the two methods is required.

  • Data import:

    To import entities, Sitecore Content Hub offers 2 possible methods.

    • Using asset upload:

      This method is only available for Asset entities. IT allows users to import asset entities from a Zip file. This method only imports the physical files and does not import the metadata of the assets.

    • Using Excel import:

      This method is available for all entities. It allows users to import entities from an Excel file. This method does not import physical files.

      Note: In order to import assets with their physical files and their metadata, a combination of the two methods is required.

Structure migration

  • Import/export package feature:

    Sitecore Content Hub offers an import/export package feature that allows users to migrate their structural changes between instances. The package itself is a Zip file containing a collection of JSON files, structured per category.

    The package includes the following categories of information:

    • Entity definitions
    • Media processing
    • Option lists
    • Policies
    • Portal pages
    • Rendition links
    • Settings
    • Taxonomies

Note: This tool is very useful for working in a multi-sandbox environment.

  • Package export:

    Users can export their structural changes using the import/export package feature. They can limit the files included in the package by selecting the categories they need to export. They can also choose to only export items that were modified after a specific date. The Exclude system owned option allows them to exclude the system-owned items from the package.

  • Package import:

    Users can import their structural changes using the import/export package feature. Upon importing an exported package, the changes take effect immediately and become available for other users. The configuration imported from the package overwrites the existing configuration.

  • Package import/export using the CLI (Command-Line Interface):

    Sitecore Content Hub offers a CLI tool to help users easily transfer packages between instances. This tool is especially useful for automating the package deployments as part of a Continuous Integration pipeline.

Extension migration

  • External page components:

    External page components are included in the import/export package under the Portal pages directory. The external component's configuration, code, HTML template and messages are all included in the JSON file corresponding to the page containing the component.

  • Actions and Triggers:

    For the moment, Sitecore Content Hub does not support the automated import/export of actions and triggers. An alternative method to achieve this is to import/export them as entities using the Excel import/export as described previously.

  • Web SDK clients and REST API clients:

    Since the Web SDK client's code and the REST API client's code are living outside the scope of Sitecore Content Hub, their management (Source control management, Continuous integration, etc.) can be decided by the developers.

    In a multi-sandbox environment, the clients can be rewired towards the correct endpoints by managing the sandboxes' URLs.

Cloud components migration

  • Logic apps and Azure functions:

    Logic apps and Azure functions are Azure cloud services and are therefore managed in the Azure platform.

    For more information about the continuous integration of Azure functions and Logic apps, please refer to this Microsoft documentation.

Can we improve this article ? Provide feedback