Import and export applications

This topic explains how to export applications from a source server and import them to a target server.

The export and import options are useful if you have multiple Deployment Automation servers, such as test and production servers. You can create and validate applications on the test server, then export them, and later import them to the production server.

Export applications

When you export an application, the system creates a JSON file that contains the application's properties, processes, and components with their associated properties and processes.

For information about JSON, see http://www.json.org/.

To export an application:

  1. Navigate to Management > Applications.
  2. In the list of applications, click the Export icon next to an application.

You can open the file in a text editor or save it. The saved JSON file has the same name as the selected application, for example, helloWorld_app.json.

Back to top

Import applications

When importing an application, you can create a new application or upgrade an existing one. Components associated with the application are also imported, including component properties and processes, if they are available to the importing server.

Note: If the Import Versions Automatically option was selected for the imported components, Deployment Automation will automatically import component versions as long as the artifacts are accessible to the importing server.

To import an application:

  1. Navigate to Management > Applications.

  2. Click Import. The Import Application dialog box opens.

  3. (Optional) To upgrade an existing application, select Override Application.

    If the application's name in the JSON file (not the name of the file itself) matches an existing application, Deployment Automation updates the application's parameters with new values and adds new items, such as processes, environments, and components. If the name is not found, the command has no effect.

    Note: The application's name is the first parameter in the JSON file, for example:

    "name": "helloWorld_app"

  4. From the Component Upgrade Type list, select how you want to import the components. For these options, the components must be on the importing server.

    The following table describes available options.

    Option Description
    Use existing component Select this option to use the same components used by the imported application. The new application will contain references to the imported application's components. This option is especially useful if you are importing a lot of applications.

    If you are upgrading, the application uses only the imported components.
    Create new component Select this option to create new components based on those used by the imported application.

    If you are upgrading, the application uses only the newly created components.
    Fail if component exists Select this option to create a fresh installation. If you are creating an application, it will create both a new application and component unless the component already exists, in which case the application is not imported.

    If you are upgrading, the upgrade will fail if any imported components already exist on the importing server.
    Fail if component does not exist Select this option to ensure a component is on the importing server. If you are creating an application, it will create both a new application and component unless the component does not exist, in which case the application is not imported.
    Upgrade if exists Select this option to upgrade existing components. It creates an application and upgrades existing components with data from the imported application.

    If you are upgrading and existing components match imported ones (all must match), the components will be upgraded. If none of the imported components match existing ones, the imported components are used.
  5. From the Process Plugins Import Type list, select how you want to import plugin steps in processes.

    The following table describes available options.

    Option Description
    Import processes as is Select this option to import processes without changes.

    If a process uses a plugin that is not available on the target sever, the import fails.
    Upgrade processes to latest plugins

    Leave this option selected to upgrade all imported plugin steps to a later plugin version available on the target server.

    You don't need to have current plugin versions if more recent versions are available on the target server.

    This is the default option.

    Ignore missing plugins Select this option to import processes even if they use plugins that are missing from the target server.
  6. Click Choose File and select the JSON file containing the application.
  7. Click Import.

Back to top

See also: