With the System Exporter, you can export data from your system into a Configuration Export (ZIP file) or a Workflow Package Export (MZP file).
In Desktop Client, you can also export to a directory.
The export can contain your system's data, configurations, and runtime data. You can send this export data to another system, using the System Importer to import it and embed its contents locally.
Example - How System Exporter can be used
You can import a tested and exported ZIP or MZP file of configurations from a test system and use it safely in production.
In System Exporter you can select data from the following folder types:
Configuration: Workflow configurations, Profiles, Workflow groups, Ultra formats, alarm detectors, etc.
Workflow packages: Workflow Packages are compiled versions of configuration, and are created in the Workflow Package mode in the System Exporter.
Execution Context Deployments: Created ECDs can be selected. See Execution Context Deployments (ECDs) (3.3).
When exporting External References profiles of type Properties Database or Kubernetes Properties the External Reference Values will also be exported. In System Importer it can be selected if they should be imported or not.
When exporting a Workflow Template with Dynamic Workflow Configuration enabled, the Dynamic Workflows will also be exported. You can specify in the System Importer if they should be imported or not. See Workflows(3.3)
Export Types
There are two export types. They result in different behaviors when imported later. Select the one that suits your requirements:
Configuration: The configurations must be compatible with the software packages of the system to which you import the configurations This is normally not a problem as long as you are using the same release. The export will be downloaded a ZIP file.
Workflow Package: Export in Workflow Packages(3.3) format. A Workflow Package is read-only and self-contained, with the same binaries as in the exporting system. A Workflow Package is not affected by, nor will it affect, any existing configurations when imported, since the used binaries are not replaced. When selecting Workflow Package Export Type, you compile a Workflow Package by selecting workflows in the Available Entries table. All dependent configurations will also be selected.
Note!
See File System (3.3) to learn how to configure a File System Profile. Currently, the Git File System Profile is available only in Desktop Online and Amazon S3 is available only in Desktop Client.
Configuration Export Type
You can export a configuration to your local browser or remote with a File System Profile of type Git.
When the Export Type is Configuration you can select data from the following types:
Configuration: Workflow configurations, agent profiles, workflow groups, Ultra formats, or alarm detectors.
Run-time: Some data that is generated by the system during workflow run-time. Clear the Option Exclude Runtime Data checkbox.
System: Other customized parts such as; Data Veracity, Event Category, Folder (structure), Pico Host, Ultra, User, or Workflow Alarm Value.
Workflow packages: Workflow Packages are compiled versions of configuration, and are created in the Export type Workflow Package in the System Exporter.
Execution Context Deployments: Created Execution Context Deployments (ECDs) (3.3) can be selected.
The following options can be found on the toolbar:
Option | Description |
|---|---|
Export | This will export the selected configuration(s). The behaviour is different dependent on your choice of Destination. Described in detail below. |
Refresh | Refreshes the list of shown configurations. |
Options | This will open the Options menu. Each available option can be toggled by the user. See more below. |
Expand all | Expands all folders in the Available entries section. |
Collapse all | Minimizes all folders Available entries section. |
Export Options
Based on the chosen options in the export window, the running System will execute the export operations in a different way.
The following options can be toggled by the users using the Options menu.
Export Option | Description |
|---|---|
Abort on error | Select this option to abort the export process if an error occurs. If an error occurs and you do not select this option, the export will be completed, but the exported data might contain erroneous components. Invalid Ultra and APL definitions are considered erroneous and result in aborting the export. |
Select Dependencies | Select this option to have dependencies follow along with the entries that you actively select. |
Encryption | Activates encryption on the chosen export. |
Exclude Runtime Data | When enabled it excludes locally stored runtime data from the export. The runtime data that can be included is, Aggregation Session Data and Archive data |
Export as XML | Exporting configuration objects with this option enabled will create compressed XML files instead of Json. |
Export to Local Destination
When Export button is clicked the export is started. When it is finished a dialog is shown with information on the exact time of the export and the export is automatically downloaded and saved in your default download location.
Export to Remote Destination
When Export button is clicked a dialog opens and you need to choose a File System Profile. Currently only File System Profiles with Type Git is selectable.
When a profile is selected more fields will appear.
Option | Description |
|---|---|
Commit message | The message that will be visible in Git log. |
Repository/Branch | Read-Only Field, showing the Remote repository name and the branch selected in the profile. |
Select Target Folder | A table showing the folders in current repository , see GIT Support |
New Folder Button | Create a new folder on root level. |
New Folder Icon on each row  | Create a new folder under the selected row |
Workflow Package Export Type
When this type is selected, Workflow Packages(3.3) can be created and exported as a MZP file. A Workflow Package is read-only and self-contained, with the same binaries as in the exporting system. A Workflow Package is not affected by, nor will it affect, any existing configurations when imported, since the used binaries are not replaced. When Export Type is Workflow Package you can select data from the following types:
Configuration: Workflow configurations, agent profiles, workflow groups, Ultra formats, or alarm detectors.
System: Other customized parts such as; Data Veracity, Event Category, Folder (structure), Pico Host, Ultra, User, or Workflow Alarm Value.
When one configuration is selected all dependent configurations will also be selected.
Export Option | Description |
|---|---|
Export | A new dialog box will be open to specify the Package name and Package version. The Output option can also be chosen – the file can either be download to your browser as a MZP file or committed (inserted) to the system.  Workflow package export options Specify the following information in the Workflow package export options:
|
Refresh | Refreshes the list of shown configurations. |
Options | This option is not available in workflow package selection mode. |
Expand all | Expands all folders. |
Collapse all | Collapses all folders. |
How To Perform a Export
Note!
Since no workflow state, i.e File Sequence Number, is included in the exported data and only the initial value is exported, you need to take a note of information such as file sequence numbers in Collector agents.
Select Export Type, Configuration or Workflow Package.
Select Destination, Local or Remote
In the System Exporter, select options according to your preferences in the Options dialog.
Expand the folders in Available Entries and select the check boxes in the Include column for the entries you want to export.
Click on the Export button to start the export process or to fill in information regarding Remote destination or Workflow Package name.
Add Comment