Content >

Deployment

Deployment

Menu Menu: Configuration / Import & Export
Feature Feature: Deployment
Editions Editions: Cloud, Corporate, Store

The Deployment Import/Export pages enable Kensium Support to export configuration settings from your POS tenant, and import the settings into other POS tenants.

These pages are intended for Kensium Support staff only. It enables Support to perform ad-hoc configuration fixes, such as importing and exporting of:

  • Settings
  • Content items
  • Dashboards

Do not confuse these pages with the POS Import pages. Use POS Import to import data into POS, as it provides a far better experience to guide and validate the imported data.

a) Deployment Plans

Use the deployment plans page to create ZIP files that contain the configuration data. The general steps to follow are:

  • Create a deployment plan, and give it a name.
  • Open the deployment plan.
  • Select a deployment step and add it to the deployment plan.
    • A deployment step is responsible for exporting a particular set of data.
    • You may need to configure the step to indicate the subset of data you want to export.
  • Add additional deployment steps, if desired.
  • Re-order the deployment steps, if necessary.
  • Execute the deployment plan.
  • Select the output target of the deployment plan.
    • The most common target is to save the deployment plan to a ZIP file.

The resulting ZIP file will contain at least one Recipe.jsonfile. In most cases, this file will contain the data that was exported. Some steps may also create additional files (e.g. images) in the ZIP file.

You can manually open the ZIP file to review the data that has been exported.

b) Package Import

The Package Import page can be used to import a ZIP file created by the deployment plan into another POS tenant. To import configuration data:

  • Select the ZIP file to import.
  • Click Importto perform the import.

The import process will process the ZIP file and return a success message upon completion.

c) JSON Import

The JSON Import page can be used as an alternative to the Package Import, giving you more control over the configuration data that is imported.

The typical process is:

  • Create a ZIP file using a deployment plan.
  • Open the Recipe.jsonfile in the ZIP file. This file will contain the format for what you want to achieve.
  • Manually extract the JSON data that you want to import.
  • Manually edit the JSON as necessary.
  • Copy the JSON into the JSON Import page.
  • Run the import.

The JSON format is beyond the scope of this documentation, but in most cases it can be inferred from the JSON property names that are output by the deployment plan.