Snapshot export

Context export

In Hyperon studio there is functionality that allows users to export current context definition and configuration into a compact zip file for specified profiles.

Context file system structure

‍Directory structure

The context file is located in the profile structure under the directory named after the profile code. Profile file system structure description can be found here: in the Profile File system section.

The structure used in EXPORT DEF functionality in Hyperon Studio to generate context.def file and context definition file for snapshot is the same. An example is shown below:

def /context                                 @desc Element główny kontekstu
  discount discount                              @desc [Wskazanie] Zniżka
  @transient username string                     @desc imię użytkownika
  @transient user_surname string                 @desc nazwisko użytkownika
 
def discount table SP_DISCOUNT               @desc Zniżka
  code string column code                        @desc Kod
  factor number                                  @desc Współczynnik zniżki (np. dla zniżek procentowych - % zniżki)
  value number                                   @desc Kwota zniżki (w walucie)

‍

Exporting Context in Hyperon Studio

Context cannot be exported without the Profile step (because context.def is located in the profile step file system structure). To export context in Hyperon Studio, go to Tools → Snapshot Export, check Context checkbox (Profile step will be checked automatically), choose profiles from which context should be exported and click Export button. A popup window will appear. When the export is finished and no errors occurred, click Download button to download snapshot in the zip file. If any error during export happens, an error message will be shown and Download button will be unavailable to click.

‍

Exporting Context via REST

Endpoint path, method, response statuses are available here.

‍

To export Context via REST, the section below must be present in a REST request

{
   "profiles":["PROFILE_1"],   // which profiles should be used for export. If not present, user's currently selected profile is chosen 
   "profile": true              // "PROFILE_1" definition will be exported with context, regions/versions and harmonogram 
}