How to Export
LiveTiles’ updated Export/Import functionality is a quality of life improvement designed to improve the process of quickly creating multiple pages from custom templates or transferring content between different instances of the application. At this stage of development it is an 'advanced' feature for some of the more technical users of LiveTiles Design.
Exported content is downloaded as a “package,” a bundle of files downloaded as a .tgz file. Old packages which are downloaded in the .JSON format can also be uploaded although they won’t have identifying data. In some cases, where a .zip has been made custom by a user that has the information contained within a .tgz package, it can also be uploaded into the environment.
There are two methods for exporting content from LiveTiles Design:
- Export entire pages as a template, or
- Use the Manage tab to export selected sections of content
Once a method is chosen, the following export screen will be displayed:
Name: The user-defined name for the resulting .tgz file that will download to your local machine. This needs to be an NPM-readable name that follows the following convention:
- The name must be less than or equal to 214 characters.
- The name must not start with a dot or an underscore.
- New packages must not have uppercase letters in the name.
- The name ends up being part of a URL, an argument on the command line, and a folder name. Therefore, the name can’t contain any non-URL-safe characters. (/.<>@ as an example)
Display Name: This is the name that will be shown in the environment when the exported package is imported. This is a mandatory field.
Version: this is the version number. This is in the semVer style which is to help distinguish between version numbers. This is a mandatory field. The versioning format is as follows:
- First Number: This is the major version
- Second Number: This is the minor version
- Third Number: This is the hotfix version
- Fourth Number: An identification number, used for uploading new versions of the same asset
Publisher: The name of the person exporting the package. This auto defaults to the name of your tenant. This is a mandatory field.
Description: A description of the exported package.
Bundle Assets: Toggles whether assets associated with the page are bundled in with the package, including images and other assets. This field is checked by default.
Bundles Sections: Toggles whether sections on the exported page are bundled in with the package. This field is checked by default.
Upon submitting the form, a .tgz package is downloaded onto your computer which you are then able to upload into another environment.
How to Import
To import a package, users will click the import button on the LiveTiles Design homepage. You will then be shown the upload screen. Selecting this will open a file picker allowing the user to select the package to upload. Once a valid package has been uploaded, the user will be presented with a screen informing them of what is being uploaded and if there are any clashes. If they attempt to upload an item with a lesser version or the same version as something already in the environment, a notification will be received.
The exception is uploading a section which is a higher version than one already present in the environment, at which point the user will be given the option to use the existing, create a new one with it's own ID, or overwrite the old section.