Snapshot import

Importing in Hyperon Studio

Executing import

To import the Snapshot file in Hyperon Studio, go to Tools → Snapshot import. Choose the snapshot ZIP file in the popup window and click Import.

Import options

In Hyperon Studio version 1.6.41, appeared a possibility to define autocommit:

"Publish session after import" - If this checkbox is checked (by default it is unchecked), then if the import was successful - on errors or warning, the system will publish user's session automatically. 

If publishing was completed with no errors, then import status will be "OK" with no messages. If there was any problem during publishing, then messages with conflated information will appear. Import + publishing was finished with error, but all elements will be imported to the user's sessions and available there.

In Hyperon Studio version 1.6.43, additional setting was added: 

"Consider config.json file during import"

  • if this checkbox is checked (by default it is checked), then first .config file is considered and all settings made in that file are applied during the import
  • if this checkbox is not checked, then import starts without with standard settings. Data from the ZIP file is added to all what is already existing on the environment. All of the elements from the ZIP file are imported and none of the elements on the import environment will be deleted.

If during import config file is considered then (if set) removal of selected elements which are not in snapshot file will be done. RemoveNotInSnapshot flag is available in config file and in the Hyperon Studio while setting the export configuration. There are three kinds of elements that may be deleted during import:

  • parameters (since version 1.6.45)
  • functions (since version 1.6.45)
  • domain elements (since version 1.6.24)

Only elements not used as domain attribute's values, in parameters as value source, in function's body or as a master for existing aliases may be removed from the environment during import. Since version 1.6.48 search through Hyperon configuration may be expanded by a searchWithinParameterMatrix - then while import process every matrix will be checked for cascade call to parameters and functions marked for deletion.

If during export any filters were applied the same filters will be applied during import (available since version 1.6.39). Only elements fitting those filters, but not within the Snapshot file, will be considered for removal.

Import results

After executing the import, a window with the import results is displayed.

Since Hyperon Studio version 1.6.41 the result for every step of the import is visible, and additional information is available if any complication occurred during import.

This screenshot is from import, that was successful, but there were some problems during session publishing for parameters.

Description of columns:

Status - icon depicting the overall status of the import:

  •  OK - successful import, no warnings, (ex. for Domain, Profiles and Tags step of the import, Import results popup above)
  •  WARNING - all functions were imported, but there were some warnings, (ex. /@params/@global/demo/motor/discount visible on the Parameters detail information popup below)
  •  ERROR - some functions were not imported because of an error or due to other reasons.(ex. Parameters step of the import, Import results popup above)

Imported files - number of processed elements

Errors - number of elements not imported due to various reason (e.g. import error)

Skipped - number of skipped elements (e.g. imported parameter has no changes to currently available on Hyperon)

Unpublished - number of unpublished elements, if the auto-commit checkbox was checked. 

  • 0 - means no problems during the publishing
  • > 0 - there were some problems during publishing, in "Messages" section all information should be there
  • "-" - either auto-commit was not chosen or element shouldn't have problems with publication

Message - clickable button showing the list of import messages (the eye icon visible on the right side of the Import results popup). For a successful imports there are no messages.

Individual import messages

Example: list of import messages

Each line contains a message for one import operation:

Status column displays an icon depicting the result of import:

  • WARNING- the element was imported, but there were some warnings,
  • ERROR- the element was not imported because of an error or due to other reasons,
  • SKIP - element on the environment was exactly the same as the one saved in the ZIP file

Path contains a path within the ZIP file to the file containing a definition of the imported element. 

If there were multiple files corresponding to the same version of the function with identical code, a wildcard is used instead of file extension (.*)

Message - import message, a warning or an indication of the source of error.