Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With the System Exporter you can export data from your system into a ZIP file, a specific directory, or an MZ Package (MZP) file. The export contains data about your system, its configurations, and run-time information. You can send this export data to another systemanother  Image Added system, where you can use the System Importer to import it and embed its contents locally.

Info
titleExample - How System Exporter can be used

A system A  Image Added system can import a tested and exported ZIP or MZP file of configurations from a test system and use it safely in production.

...

  • Configuration: Workflow configurations, agent profiles, workflow groups, Ultra formats, or alarm detectors.

  • Run-time: Data that is generated by the system during workflow run-time.

  • System: Other customized parts of such of Image Added 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 Workflow Package Tab in the System Exporter.

...

To open the System Exporter, click the Tools button in the upper left part of the Desktop the Image Added Desktop window. Then select System Exporter from the menu.

Use File System Profile option if you want to export a file from and from  Image Added and write to an external file storage system, for example Amazon S3, instead of a local file system. Click Browse Profile to choose a profile and this profile will be responsible for authentication of the external file storage system. And, when you click Export, the exported file is written to the external file system.

...

SettingDescription

Output Target

Click the Browse button to define the path to where the MZP file is saved when clicking Export Package. It is possible to both set an Output Target and select to Commit Package before clicking Export Package. In this case an MZP file is both saved to the output directory and available as a read-only folder in in  Image Added. If no Output Target is selected, the Commit Package check box has to be selected. See Commit Package for more information. When no Output Target is set, the MZP file is removed after it is committed.

The WebDesktop Workflow Package tab has a Download Package check box with the same function as the Browse button and Output Target field.

Available Entries

Contains a tree layout view of the data you can export. Select the relevant check boxes in the Include column. This is where you select which workflows to compile into a Workflow Package.

Export Package

Click this button to export your selections to an MZP file. The Export button will change into Abort, which enables you to cancel the exporting process.

Commit Package

If selected, a purple read-only folder consisting of committed Workflow Packages becomes visible among the Available Entries once Export Package is clicked. Such folders can be saved as Workflow Package MZP files when suitable. See the folder streamid_1 in the example below. 

See Output Target for more information.

Package NameEnter the file name of the file to be exported.
Package VersionUse this field to keep track of the version. Only numbers and dots are allowed in this field. Used for Workflow Packages.

...

OptionDescription
New

Creates a new Unit Test configuration in a new tab. You can only create a configuration of the same kind as the one in the tab you are working in.

OpenOpens a saved configuration that is visible in a new tab. You can only open a configuration of the same kind as the one in the tab you are working in.
Save

Saves the configuration.

After you click Save, a dialog box opens. In the Version Comment text box, you can enter a description of the changes that you have made, then click OK

Save As

Select to save the configuration with a new name. You can only use a-z, A-Z, 0-9, "-" and "_" to name a configuration.

After you click Save As, a dialog box opens. Select in which folder to save the configuration. In the Version Comment text box, you can enter a description of the changes that you have made, then click OK

Collapse All

Select this option to collapse the folders so only the folders are visible.

Expand All

Select this option to expand all folders to display the folders and all the configurations that they contain.

Refresh

Select this option to refresh the System Exporter view.
Properties


Note
titleNote!

The Properties button applies to the Configuration Export tab. That is, these settings are not applicable for Workflow Package Export (MZP file export).

Select the Properties button to set these options:

  • Abort On Error: Select this option to cancel the creation of an export file if an error occurs while in process. By default, an export file is created regardless of errors. If errors occur, the export file can lack components.
  • Select Dependencies: Select this option to enable automatic selection of dependent entries. When you select an entry from the Available Entries table, all dependent entries are automatically selected as well.

    Note
    titleNote!

    When a configuration has a dependency, the checkbox available next to the configuration will be locked and you will not be able to clear the checkbox


  • Encryption: Select this option to make the files included in the export file password encrypted. UDR data such as archived data, will be encrypted as well.
  • Directory Output: Select this option to prevent your selections from being packed into a ZIP file. Your selections, XML files, and their tree view layout that you see in Available Entries will instead be exported to the Target Output that you specify.
  • Exclude Runtime Data: Select this option to exclude runtime data such as Data Veracity or archive data. You would typically want to exclude the runtime data when you export a large amount of data, and you are only interested in the configurations.
  • Export as XML: For export in XML format.

...

  1. In the System Exporter, select options according to your preferences in the Properties dialog.
  2. Select the desired tab, Configuration Export (for a ZIP file or a directory) or Workflow Package Export (for MZP format).

  3. Click the Browse button to select the directory path to where you want to save your selections, in MZP format, ZIP-packed, or not.

    Tip
    titleHint!

    To configure a default directory for when you click the  Browse button, add the Desktop property mz.gui.systemexport.default.dir. The value must be the full path to an existing directory, for example /home/mz.

    The System Exporter remembers the last directory to which an export was made, and will open the file browser in this directory the next time you click the Browse button. This directory is kept in memory until the Desktop is closed.


  4. Expand the folders in Available Entries and select the check boxes in the Include column for the entries you want to export.
  5. Click the Save as... button if you want to save data about your export.

    Note
    titleNote!

    After you have selected the entries that you want to include, you can save your selection before you click Export. This is useful if you export a certain set of selections regularly.

    The saved selection combination is a *.criteria" file that contains data only about your selections. It is not an export ZIP file. The *.criteria" file is stored on your local disk and not in the systemthe Image Added system.


  6. Click on the Export button to start the export process. Either a file will be created in the Output Target directory, or the selected structure will be exported to the specified directory.

    Note
    titleNote!

    In the export material you also find three directories: One that includes the Ultra code that your export involves, one that includes profile-relevant APL code, and another one that contains workflow-related data. Use these files to compare the export material with the data in the system to which you import.


Export File Structure

In Image Added, when you save a profile or a workflow configuration, you create a database entry. When you export tree-structured profiles and workflows, this database entry is included in the exported material as a file.

...