Versions Compared

Key

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

Configuration Export is the way that applications and miscellaneous configuration components are exported from PhixFlow. You may want to export your configuration for a number of reasons - e.g. to back up an application, or set of configuration components, you are working on; or so that you can import it somewhere else.The Export Pane can be opened from the Overview

You can export an application, packages or selected items from PhixFlow. This is useful when you want to:

  • to take a back up of an application or a set of items on which you are working
  • It's a good idea to do this regualrly, as PhixFlow has no undo.
  • to import an application or package to another instance of PhixFlow.
    For example, it is common to have a development instance in which you create applications. When the application is ready, you then export it and import it into a production instance to make it available to application users.

To open the Export Configuration window, click the 

Insert excerpt
_administration
_administration
nopaneltrue
 icon, which in in the bottom top right of the PhixFlow window. The Configuration Export pane header bar.

The Export Configuration window contains the list of objects that are to be exported. The export pane can also be used to copy a set of configuration components.


Items to Export

Select items: 

Full Configuration: PhixFlow automatically selects all items ready for export.

Drag model elements (streams, collectors etc) from other panels into this pane, items from the repository into the window then click either the Export or Copy button.

You can also drag in actions that do not have a parent stream. These appear in the repository → Actions branch.

The data is exported as a zip file, which is temporarily saved in the download area. You should download the file as soon as it is available, as your administrator may have set an expiry time. 

On the Export Pane you may optionally _ there is no longer a copy option

When you add an application to the export, PhixFlow asks if you want to also add packages that the application uses. We recommend you always include packages when you plan to import to another instance, as the import process reports errors if an item refers to something that isn't present in the new instance.


Optionally enter a name and description for the file. The description will appear in

  • the download area
  • the header.xml file in the configuration export zip file
  • log file messages generated by the export process and when the file is imported.


Click Export

The data is exported as a zip file, which is temporarily saved in the download area. You should download the file as soon as it is available, as your administrator may have set an expiry time. 


Excerpt

Passwords

Passwords Saved in PhixFlow

Exported files do not include any passwords from the PhixFlow system, such as passwords for:

  • user accounts
  • accessing external data, for example via HTTP or FTP collectors.
Note

If you are planning to import an exported configuration to another PhixFlow instance, you may need to update the passwords in that instance.

Providing a Password to Encrypt the Exported File

By default, when you download an exported file, it is encrypted. You must provide a password that you can then use when you import the file into another instance. 

...


Copying Items

In addition to being able to export items ready for import to another instance, you can also copy items into the same instance using the copy option.

In PhixFlow, items are often associated with other items. For example a stream is run by an analysis task or a style is used by a layout component. When making a copy, PhixFlow does not update associated items. The following table provides some examples:


Item copiedAssociated itemsWhat happens to associated items
StreamA is copied to streamB.An analysis task runs streamA.The analysis task is not changed and only runs streamA.
Shared-style1 is copied to shared-style2.There are 10 layout components that use shared-style1.

Shared-style2 has no components.

The 10 layout components that use shared-style1 are not changed.


...