Exporting and importing Descriptions

A Description can be exported to a ZIP file, called a Description package.

You can import a Description package to create a new Description.

Description packages are generally used to create a CyberApp Description from a Description of a different CyberApp.

Note

To create a new Description based on an existing Description of the same CyberApp, you can simply duplicate the Description.

Description package contents

Packages have a standardized directory structure, containing files which provide declarative definitions of the Description.

They consist of:

• Two Vendor Portal system directories which start with a .

  Warning

  Vendor Portal system directories should not be modified.

• An assets directory.

  This contains binary images, such as company logos, presentation slides, user interface icons, etc., that are used by the entities.

  Note

  During the CyberApp deployment, assets are pushed to Acronis S3 storage and their names will be changed to relevant S3 storage paths.

  All assets are considered public, and no additional access checks are applied to these assets on S3 storage.
• A dictionaries directory.

  This contains files with localized Description content strings.

  For example, a dictionary file might provide the CyberApp’s Catalog card description and Detail page description fields in another language.
• An entities directory.

  This contains declarative definitions of the Description’s entities.

• An index.json file, which provides overall information about which entities, assets, and localization dictionaries are included.

Note

You can download an example package for DemoCyberApp here.

In this section

• Exporting a Description
• Importing a Description package